Documentation

RouteAuthor
in package

Table of Contents

infoRoute()  : mixed
infoRouteAdmin()  : mixed

Methods

infoRoute()

public infoRoute(mixed $request, mixed $response, mixed $args) : mixed
Parameters
$request : mixed
$response : mixed
$args : mixed
Tags
OA\Post

( path="/{game_route}/author/info/{author_shortname}", summary="Returns author's data", description="Use the author's shortname to get their authoring information. Only public data is available with this endpoint, see /author/{author_shortname}/admin for the complete data set", operationId="infoRoute", tags={"Authors"}, @OA\Parameter( description="Shortname of an author. List of authors available at /authors", in="path", name="author_shortname", required=true, @OA\Schema(type="string"), @OA\Examples(example="string", value="farottone", summary="Using author's shortname"), ), @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", ref="#/components/schemas/Author" ), @OA\Examples(example="Success", value={ "status": "success", "data": {"member_id": 6448,"name": "Farottone","account": "Unlimited","shortname": "farottone","avatar_path": "profile/photo-6448.jpg","full_stats": 1,"role": "admin","author_class": "C3 Founder","level": 17,"dl_count": 0,"song_count": 0 }}, summary="Author found"), @OA\Examples(example="Error", value={"status": "error", "error": {"message": "Author not found" }}, summary="No author with the shortname provided") ) ), @OA\Response( response=404, description="Missing author shortname" ) ) )

Return values
mixed

infoRouteAdmin()

public infoRouteAdmin(mixed $request, mixed $response, mixed $args) : mixed
Parameters
$request : mixed
$response : mixed
$args : mixed
Tags
OA\Post

( path="/{game_route}/author/info/{author_shortname}/admin", summary="Returns full set of author's data", description="Use the author's shortname to get their authoring information. This is the complete data set for each author, only available to administrators. See /author/{author_shortname} for the public data set", operationId="infoRouteAdmin", tags={"Authors"}, @OA\Parameter( description="Shortname of an author. List of authors available at /authors", in="path", name="author_shortname", required=true, @OA\Schema(type="string"), @OA\Examples(example="string", value="farottone", summary="Using author's shortname") ), @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", ref="#/components/schemas/Author" ), @OA\Examples(example="Success", value={"status": "success","data": {"member_id": 6448,"name": "Farottone","magma_id": 6448,"account": "Unlimited","shortname": "farottone","avatar_path": "profile/photo-6448.jpg","full_stats": 1,"role": "admin","c3xrole": "admin","author_class": "C3 Founder","level": 17,"active": 1,"newsongs_read": "2017-07-06 11:37:17","c3xskills": 5,"c3": 1,"color": "default","c3xmanagedby": null,"c3xagreement": 1,"dl_count": 0,"song_count": 0}}, summary="Author found"), @OA\Examples(example="Error", value={"status": "error", "error": {"message": "Author not found" }}, summary="No author with the shortname provided") ), ), @OA\Response( response=404, description="Missing author shortname" ) ) )

Return values
mixed

Search results