(
path="/{game_route}/artists/list_by_first_letter/{first_letter}",
summary="Returns artist data",
description="A list of artists whose name starts with a provided letter",
operationId="artistsListByFirstLetterRoute",
tags={"Artists"},
@OA\Parameter(
description="First letter of an artist's name",
in="path",
name="first_letter",
required=true,
@OA\Schema(type="string"),
@OA\Examples(example="string", value="q", summary="Using an artist name's first letter"),
),
@OA\Parameter(
ref="#/components/parameters/game_route"
),
@OA\Response(
response=200,
description="OK",
@OA\JsonContent(
type="object",
@OA\Property(
property="status",
ref="#/components/schemas/RGWRequestStatus"
),
@OA\Property(
property="data",
type="object",
@OA\Property(
property="artists",
ref="#/components/schemas/Artist"
),
@OA\Property(
property="pagination",
ref="#/components/schemas/RGWResponsePagination"
),
@OA\Property(
property="records",
ref="#/components/schemas/RGWResponseCount"
)
),
@OA\Examples(example="Success", value={"status": "success","data": {"records": {"total_available": 7538,"total_filtered": 308,"returned": 20},"pagination": {"start": 0,"records": 20,"page": 1},"artists": {{"artist": "R. Kelly","songs": 3,"artist_s": "r-kelly"},{"artist": "Ra","songs": 2,"artist_s": "ra"},{"artist": "Ra Ra Riot","songs": 2,"artist_s": "ra-ra-riot"},"..."}}}, summary="List of artists"),
@OA\Examples(example="Error", value={"status": "error", "error": {"message": "No artist found" }}, summary="No artist with name starting with provided letter")
)
)
)
)