rixty
/
AzuraCast
mirror of https://github.com/AzuraCast/AzuraCast.git
1
1
Fork 0
Code Issues Projects Releases Wiki Activity

Add operation IDs to several other API operations.

This commit is contained in:
Buster Neece 2023-09-18 02:30:59 -05:00
parent 5f9f2f7684
commit aa0ca7f6da
No known key found for this signature in database
26 changed files with 56 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/Controller/Api/IndexController.php
View File

@ -15,6 +15,7 @@ final class IndexController
{
#[OA\Get(
path: '/status',
operationId: 'getStatus',
description: 'Returns an affirmative response if the API is active.',
tags: ['Miscellaneous'],
parameters: [],
@ -35,6 +36,7 @@ final class IndexController
#[OA\Get(
path: '/time',
operationId: 'getTime',
description: "Returns the time (with formatting) in GMT and the user's local time zone, if logged in.",
tags: ['Miscellaneous'],
parameters: [],

2
src/Controller/Api/NowPlayingController.php
View File

@ -16,6 +16,7 @@ use Psr\Http\Message\ResponseInterface;
#[
OA\Get(
path: '/nowplaying',
operationId: 'getAllNowPlaying',
description: "Returns a full summary of all stations' current state.",
tags: ['Now Playing'],
parameters: [],
@ -32,6 +33,7 @@ use Psr\Http\Message\ResponseInterface;
),
OA\Get(
path: '/nowplaying/{station_id}',
operationId: 'getStationNowPlaying',
description: "Returns a full summary of the specified station's current state.",
tags: ['Now Playing'],
parameters: [

6
src/Controller/Api/OpenApiAction.php
View File

@ -30,7 +30,9 @@ final class OpenApiAction implements SingleActionInterface
$yaml = $this->apiDocsCommand->generate(true, $apiBaseUrl)?->toYaml();
$response->getBody()->write($yaml ?? '');
return $response->withHeader('Content-Type', 'text/x-yaml');
return $response->renderStringAsFile(
$yaml ?? '',
'text/x-yaml',
);
}
}

1
src/Controller/Api/Stations/Art/DeleteArtAction.php
View File

@ -15,6 +15,7 @@ use Psr\Http\Message\ResponseInterface;
#[OA\Delete(
path: '/station/{station_id}/art/{media_id}',
operationId: 'deleteMediaArt',
description: 'Removes the album art for a track.',
security: OpenApi::API_KEY_SECURITY,
tags: ['Stations: Media'],

1
src/Controller/Api/Stations/Art/GetArtAction.php
View File

@ -19,6 +19,7 @@ use Psr\Http\Message\ResponseInterface;
#[OA\Get(
path: '/station/{station_id}/art/{media_id}',
operationId: 'getMediaArt',
description: 'Returns the album art for a song, or a generic image.',
tags: ['Stations: Media'],
parameters: [

1
src/Controller/Api/Stations/Art/PostArtAction.php
View File

@ -17,6 +17,7 @@ use Psr\Http\Message\ResponseInterface;
#[OA\Post(
path: '/station/{station_id}/art/{media_id}',
operationId: 'postMediaArt',
description: 'Sets the album art for a track.',
security: OpenApi::API_KEY_SECURITY,
tags: ['Stations: Media'],

1
src/Controller/Api/Stations/Fallback/DeleteFallbackAction.php
View File

@ -15,6 +15,7 @@ use Psr\Http\Message\ResponseInterface;
#[OA\Delete(
path: '/station/{station_id}/fallback',
operationId: 'deleteStationFallback',
description: 'Removes the custom fallback track for a station.',
security: OpenApi::API_KEY_SECURITY,
tags: ['Stations: General'],

1
src/Controller/Api/Stations/Fallback/GetFallbackAction.php
View File

@ -15,6 +15,7 @@ use Psr\Http\Message\ResponseInterface;
#[OA\Get(
path: '/station/{station_id}/fallback',
operationId: 'getStationFallback',
description: 'Get the custom fallback track for a station.',
security: OpenApi::API_KEY_SECURITY,
tags: ['Stations: General'],

1
src/Controller/Api/Stations/Fallback/PostFallbackAction.php
View File

@ -16,6 +16,7 @@ use Psr\Http\Message\ResponseInterface;
#[OA\Post(
path: '/station/{station_id}/fallback',
operationId: 'postStationFallback',
description: 'Update the custom fallback track for the station.',
security: OpenApi::API_KEY_SECURITY,
tags: ['Stations: General'],

1
src/Controller/Api/Stations/Mounts/Intro/DeleteIntroAction.php
View File

@ -15,6 +15,7 @@ use Psr\Http\Message\ResponseInterface;
#[OA\Delete(
path: '/station/{station_id}/mount/{id}/intro',
operationId: 'deleteMountIntro',
description: 'Removes the intro track for a mount point.',
security: OpenApi::API_KEY_SECURITY,
tags: ['Stations: Mount Points'],

1
src/Controller/Api/Stations/Mounts/Intro/GetIntroAction.php
View File

@ -17,6 +17,7 @@ use Psr\Http\Message\ResponseInterface;
#[OA\Get(
path: '/station/{station_id}/mount/{id}/intro',
operationId: 'getMountIntro',
description: 'Get the intro track for a mount point.',
security: OpenApi::API_KEY_SECURITY,
tags: ['Stations: Mount Points'],

1
src/Controller/Api/Stations/Mounts/Intro/PostIntroAction.php
View File

@ -16,6 +16,7 @@ use Psr\Http\Message\ResponseInterface;
#[OA\Post(
path: '/station/{station_id}/mount/{id}/intro',
operationId: 'postMountIntro',
description: 'Update the intro track for a mount point.',
security: OpenApi::API_KEY_SECURITY,
tags: ['Stations: Mount Points'],

1
src/Controller/Api/Stations/Podcasts/Art/DeleteArtAction.php
View File

@ -17,6 +17,7 @@ use Psr\Http\Message\ResponseInterface;
#[OA\Delete(
path: '/station/{station_id}/podcast/{podcast_id}/art',
operationId: 'deletePodcastArt',
description: 'Removes the album art for a podcast.',
security: OpenApi::API_KEY_SECURITY,
tags: ['Stations: Podcasts'],

1
src/Controller/Api/Stations/Podcasts/Art/GetArtAction.php
View File

@ -16,6 +16,7 @@ use Psr\Http\Message\ResponseInterface;
#[OA\Get(
path: '/station/{station_id}/podcast/{podcast_id}/art',
operationId: 'getPodcastArt',
description: 'Gets the album art for a podcast.',
security: OpenApi::API_KEY_SECURITY,
tags: ['Stations: Podcasts'],

1
src/Controller/Api/Stations/Podcasts/Art/PostArtAction.php
View File

@ -18,6 +18,7 @@ use Psr\Http\Message\ResponseInterface;
#[OA\Post(
path: '/station/{station_id}/podcast/{podcast_id}/art',
operationId: 'postPodcastArt',
description: 'Sets the album art for a podcast.',
security: OpenApi::API_KEY_SECURITY,
tags: ['Stations: Podcasts'],

1
src/Controller/Api/Stations/Podcasts/Episodes/Art/DeleteArtAction.php
View File

@ -17,6 +17,7 @@ use Psr\Http\Message\ResponseInterface;
#[OA\Delete(
path: '/station/{station_id}/podcast/{podcast_id}/episode/{episode_id}/art',
operationId: 'deletePodcastEpisodeArt',
description: 'Removes the album art for a podcast episode.',
security: OpenApi::API_KEY_SECURITY,
tags: ['Stations: Podcasts'],

1
src/Controller/Api/Stations/Podcasts/Episodes/Art/GetArtAction.php
View File

@ -17,6 +17,7 @@ use Psr\Http\Message\ResponseInterface;
#[OA\Get(
path: '/station/{station_id}/podcast/{podcast_id}/episode/{episode_id}/art',
operationId: 'getPodcastEpisodeArt',
description: 'Gets the album art for a podcast episode.',
security: OpenApi::API_KEY_SECURITY,
tags: ['Stations: Podcasts'],

1
src/Controller/Api/Stations/Podcasts/Episodes/Art/PostArtAction.php
View File

@ -18,6 +18,7 @@ use Psr\Http\Message\ResponseInterface;
#[OA\Post(
path: '/station/{station_id}/podcast/{podcast_id}/episode/{episode_id}/art',
operationId: 'postPodcastEpisodeArt',
description: 'Sets the album art for a podcast episode.',
security: OpenApi::API_KEY_SECURITY,
tags: ['Stations: Podcasts'],

1
src/Controller/Api/Stations/Podcasts/Episodes/Media/DeleteMediaAction.php
View File

@ -18,6 +18,7 @@ use Psr\Http\Message\ResponseInterface;
#[OA\Delete(
path: '/station/{station_id}/podcast/{podcast_id}/episode/{episode_id}/media',
operationId: 'deletePodcastEpisodeMedia',
description: 'Removes the media for a podcast episode.',
security: OpenApi::API_KEY_SECURITY,
tags: ['Stations: Podcasts'],

1
src/Controller/Api/Stations/Podcasts/Episodes/Media/GetMediaAction.php
View File

@ -18,6 +18,7 @@ use Psr\Http\Message\ResponseInterface;
#[OA\Get(
path: '/station/{station_id}/podcast/{podcast_id}/episode/{episode_id}/media',
operationId: 'getPodcastEpisodeMedia',
description: 'Gets the media for a podcast episode.',
security: OpenApi::API_KEY_SECURITY,
tags: ['Stations: Podcasts'],

1
src/Controller/Api/Stations/Podcasts/Episodes/Media/PostMediaAction.php
View File

@ -18,6 +18,7 @@ use Psr\Http\Message\ResponseInterface;
#[OA\Post(
path: '/station/{station_id}/podcast/{podcast_id}/episode/{episode_id}/media',
operationId: 'postPodcastEpisodeMedia',
description: 'Sets the media for a podcast episode.',
security: OpenApi::API_KEY_SECURITY,
tags: ['Stations: Podcasts'],

1
src/Controller/Api/Stations/StereoTool/DeleteStereoToolConfigurationAction.php
View File

@ -15,6 +15,7 @@ use Psr\Http\Message\ResponseInterface;
#[OA\Delete(
path: '/station/{station_id}/stereo-tool-configuration',
operationId: 'deleteStereoToolConfiguration',
description: 'Removes the Stereo Tool configuration file for a station.',
security: OpenApi::API_KEY_SECURITY,
tags: ['Stations: Broadcasting'],

1
src/Controller/Api/Stations/StereoTool/GetStereoToolConfigurationAction.php
View File

@ -15,6 +15,7 @@ use Psr\Http\Message\ResponseInterface;
#[OA\Get(
path: '/station/{station_id}/stereo-tool-configuration',
operationId: 'getStereoToolConfiguration',
description: 'Get the Stereo Tool configuration file for a station.',
security: OpenApi::API_KEY_SECURITY,
tags: ['Stations: Broadcasting'],

1
src/Controller/Api/Stations/StereoTool/PostStereoToolConfigurationAction.php
View File

@ -16,6 +16,7 @@ use Psr\Http\Message\ResponseInterface;
#[OA\Post(
path: '/station/{station_id}/stereo-tool-configuration',
operationId: 'postStereoToolConfiguration',
description: 'Update the Stereo Tool configuration file for a station.',
security: OpenApi::API_KEY_SECURITY,
tags: ['Stations: Broadcasting'],

2
src/Http/Response.php
View File

@ -100,6 +100,8 @@ final class Response extends SlimResponse
if ($fileName !== null) {
$response = $response->withHeader('Content-Disposition', 'attachment; filename=' . $fileName);
} else {
$response = $response->withHeader('Content-Disposition', 'inline');
}
$response->getBody()->write($fileData);

27
web/static/api/openapi.yml
View File

@ -762,7 +762,7 @@ paths:
tags:
- Miscellaneous
description: 'Returns an affirmative response if the API is active.'
operationId: bc32a129ca3e8ad2060b71bdd90da78d
operationId: getStatus
responses:
'200':
description: Success
@ -775,7 +775,7 @@ paths:
tags:
- Miscellaneous
description: "Returns the time (with formatting) in GMT and the user's local time zone, if logged in."
operationId: 3092a8238a915a0b6b324f2a90942a94
operationId: getTime
responses:
'200':
description: Success
@ -803,6 +803,7 @@ paths:
tags:
- 'Now Playing'
description: "Returns a full summary of all stations' current state."
operationId: getAllNowPlaying
responses:
'200':
description: Success
@ -817,6 +818,7 @@ paths:
tags:
- 'Now Playing'
description: "Returns a full summary of the specified station's current state."
operationId: getStationNowPlaying
parameters:
-
$ref: '#/components/parameters/StationIdRequired'
@ -834,6 +836,7 @@ paths:
tags:
- 'Stations: Media'
description: 'Returns the album art for a song, or a generic image.'
operationId: getMediaArt
parameters:
-
$ref: '#/components/parameters/StationIdRequired'
@ -853,6 +856,7 @@ paths:
tags:
- 'Stations: Media'
description: 'Sets the album art for a track.'
operationId: postMediaArt
parameters:
-
$ref: '#/components/parameters/StationIdRequired'
@ -884,6 +888,7 @@ paths:
tags:
- 'Stations: Media'
description: 'Removes the album art for a track.'
operationId: deleteMediaArt
parameters:
-
$ref: '#/components/parameters/StationIdRequired'
@ -916,6 +921,7 @@ paths:
tags:
- 'Stations: General'
description: 'Get the custom fallback track for a station.'
operationId: getStationFallback
parameters:
-
$ref: '#/components/parameters/StationIdRequired'
@ -935,6 +941,7 @@ paths:
tags:
- 'Stations: General'
description: 'Update the custom fallback track for the station.'
operationId: postStationFallback
parameters:
-
$ref: '#/components/parameters/StationIdRequired'
@ -954,6 +961,7 @@ paths:
tags:
- 'Stations: General'
description: 'Removes the custom fallback track for a station.'
operationId: deleteStationFallback
parameters:
-
$ref: '#/components/parameters/StationIdRequired'
@ -1367,6 +1375,7 @@ paths:
tags:
- 'Stations: Mount Points'
description: 'Get the intro track for a mount point.'
operationId: getMountIntro
parameters:
-
$ref: '#/components/parameters/StationIdRequired'
@ -1394,6 +1403,7 @@ paths:
tags:
- 'Stations: Mount Points'
description: 'Update the intro track for a mount point.'
operationId: postMountIntro
parameters:
-
$ref: '#/components/parameters/StationIdRequired'
@ -1421,6 +1431,7 @@ paths:
tags:
- 'Stations: Mount Points'
description: 'Removes the intro track for a mount point.'
operationId: deleteMountIntro
parameters:
-
$ref: '#/components/parameters/StationIdRequired'
@ -1923,6 +1934,7 @@ paths:
tags:
- 'Stations: Podcasts'
description: 'Gets the album art for a podcast.'
operationId: getPodcastArt
parameters:
-
$ref: '#/components/parameters/StationIdRequired'
@ -1949,6 +1961,7 @@ paths:
tags:
- 'Stations: Podcasts'
description: 'Sets the album art for a podcast.'
operationId: postPodcastArt
parameters:
-
$ref: '#/components/parameters/StationIdRequired'
@ -1975,6 +1988,7 @@ paths:
tags:
- 'Stations: Podcasts'
description: 'Removes the album art for a podcast.'
operationId: deletePodcastArt
parameters:
-
$ref: '#/components/parameters/StationIdRequired'
@ -2002,6 +2016,7 @@ paths:
tags:
- 'Stations: Podcasts'
description: 'Gets the album art for a podcast episode.'
operationId: getPodcastEpisodeArt
parameters:
-
$ref: '#/components/parameters/StationIdRequired'
@ -2035,6 +2050,7 @@ paths:
tags:
- 'Stations: Podcasts'
description: 'Sets the album art for a podcast episode.'
operationId: postPodcastEpisodeArt
parameters:
-
$ref: '#/components/parameters/StationIdRequired'
@ -2068,6 +2084,7 @@ paths:
tags:
- 'Stations: Podcasts'
description: 'Removes the album art for a podcast episode.'
operationId: deletePodcastEpisodeArt
parameters:
-
$ref: '#/components/parameters/StationIdRequired'
@ -2112,6 +2129,7 @@ paths:
tags:
- 'Stations: Podcasts'
description: 'Gets the media for a podcast episode.'
operationId: getPodcastEpisodeMedia
parameters:
-
$ref: '#/components/parameters/StationIdRequired'
@ -2145,6 +2163,7 @@ paths:
tags:
- 'Stations: Podcasts'
description: 'Sets the media for a podcast episode.'
operationId: postPodcastEpisodeMedia
parameters:
-
$ref: '#/components/parameters/StationIdRequired'
@ -2178,6 +2197,7 @@ paths:
tags:
- 'Stations: Podcasts'
description: 'Removes the media for a podcast episode.'
operationId: deletePodcastEpisodeMedia
parameters:
-
$ref: '#/components/parameters/StationIdRequired'
@ -2936,6 +2956,7 @@ paths:
tags:
- 'Stations: Broadcasting'
description: 'Get the Stereo Tool configuration file for a station.'
operationId: getStereoToolConfiguration
parameters:
-
$ref: '#/components/parameters/StationIdRequired'
@ -2955,6 +2976,7 @@ paths:
tags:
- 'Stations: Broadcasting'
description: 'Update the Stereo Tool configuration file for a station.'
operationId: postStereoToolConfiguration
parameters:
-
$ref: '#/components/parameters/StationIdRequired'
@ -2974,6 +2996,7 @@ paths:
tags:
- 'Stations: Broadcasting'
description: 'Removes the Stereo Tool configuration file for a station.'
operationId: deleteStereoToolConfiguration
parameters:
-
$ref: '#/components/parameters/StationIdRequired'