javier
428eedd89d
This PR contains the work done to include the define the information sections of the `OpenAPI` specification document and all the `GET` endpoints of the _Service_ and _Database_ categories.
The following endpoints have been defined in the document, and also tested manually with `Swift`:
* GET `/`
* GET `/artists/{artist_id}`
* GET `/artists/{artist_id}/releases`
* GET `/labels/{label_id}`
* GET `/labels/{label_id}/releases`
* GET `/masters/{master_id}`
* GET `/masters/{master_id}/versions`
* GET `/releases/{release_id}`
* GET `/releases/{release_id}/rating`
* GET `/releases/{release_id}/rating/{username}`
* GET `/releases/{release_id}/stats`
* GET `/database/search`
In addition, a first version of the _Github Pages_ documentation has been generated from the `DocC` documentation catalog, and the generated Swift code from the `openapi.yaml` file.
Reviewed-on: #2
Co-authored-by: Javier Cicchelli <javier@rock-n-code.com>
Co-committed-by: Javier Cicchelli <javier@rock-n-code.com>
1 line
5.3 KiB
JSON
1 line
5.3 KiB
JSON
{"schemaVersion":{"minor":3,"patch":0,"major":0},"sections":[],"abstract":[{"text":"Undocumented response.","type":"text"}],"metadata":{"title":"Operations.getArtistReleases.Output.undocumented(statusCode:_:)","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"undocumented","kind":"identifier"},{"text":"(","kind":"text"},{"text":"statusCode","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Int","preciseIdentifier":"s:Si","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"UndocumentedPayload","preciseIdentifier":"s:14OpenAPIRuntime19UndocumentedPayloadV","kind":"typeIdentifier"},{"text":")","kind":"text"}],"symbolKind":"case","roleHeading":"Case","externalID":"s:14DiscogsService10OperationsO17getArtistReleasesO6OutputO12undocumentedyAGSi_14OpenAPIRuntime19UndocumentedPayloadVtcAGmF","role":"symbol","modules":[{"name":"DiscogsService"}]},"kind":"symbol","identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getArtistReleases\/Output\/undocumented(statusCode:_:)","interfaceLanguage":"swift"},"primaryContentSections":[{"declarations":[{"platforms":["macOS"],"tokens":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"undocumented","kind":"identifier"},{"text":"(","kind":"text"},{"text":"statusCode","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Int","preciseIdentifier":"s:Si","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"UndocumentedPayload","preciseIdentifier":"s:14OpenAPIRuntime19UndocumentedPayloadV","kind":"typeIdentifier"},{"text":")","kind":"text"}],"languages":["swift"]}],"kind":"declarations"},{"kind":"content","content":[{"text":"Discussion","anchor":"discussion","level":2,"type":"heading"},{"inlineContent":[{"text":"A response with a code that is not documented in the OpenAPI document.","type":"text"}],"type":"paragraph"}]}],"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getArtistReleases","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getArtistReleases\/Output"]]},"variants":[{"paths":["\/documentation\/discogsservice\/operations\/getartistreleases\/output\/undocumented(statuscode:_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://DiscogsService/documentation/DiscogsService":{"url":"\/documentation\/discogsservice","abstract":[],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService","kind":"symbol","role":"collection","type":"topic","title":"DiscogsService"},"doc://DiscogsService/documentation/DiscogsService/Operations":{"navigatorTitle":[{"kind":"identifier","text":"Operations"}],"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Operations"}],"url":"\/documentation\/discogsservice\/operations","role":"symbol","type":"topic","kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","abstract":[{"text":"API operations, with input and output types, generated from ","type":"text"},{"code":"#\/paths","type":"codeVoice"},{"text":" in the OpenAPI document.","type":"text"}],"title":"Operations"},"doc://DiscogsService/documentation/DiscogsService/Operations/getArtistReleases/Output":{"navigatorTitle":[{"text":"Output","kind":"identifier"}],"fragments":[{"kind":"keyword","text":"enum"},{"text":" ","kind":"text"},{"text":"Output","kind":"identifier"}],"url":"\/documentation\/discogsservice\/operations\/getartistreleases\/output","role":"symbol","type":"topic","kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getArtistReleases\/Output","abstract":[],"title":"Operations.getArtistReleases.Output"},"doc://DiscogsService/documentation/DiscogsService/Operations/getArtistReleases":{"navigatorTitle":[{"kind":"identifier","text":"getArtistReleases"}],"fragments":[{"text":"enum","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"getArtistReleases"}],"url":"\/documentation\/discogsservice\/operations\/getartistreleases","role":"symbol","type":"topic","kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getArtistReleases","abstract":[{"type":"text","text":"Get information about releases of an artist."}],"title":"Operations.getArtistReleases"},"doc://DiscogsService/documentation/DiscogsService/Operations/getArtistReleases/Output/undocumented(statusCode:_:)":{"type":"topic","url":"\/documentation\/discogsservice\/operations\/getartistreleases\/output\/undocumented(statuscode:_:)","role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getArtistReleases\/Output\/undocumented(statusCode:_:)","kind":"symbol","title":"Operations.getArtistReleases.Output.undocumented(statusCode:_:)","abstract":[{"text":"Undocumented response.","type":"text"}],"fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"undocumented"},{"kind":"text","text":"("},{"kind":"externalParam","text":"statusCode"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"UndocumentedPayload","preciseIdentifier":"s:14OpenAPIRuntime19UndocumentedPayloadV"},{"kind":"text","text":")"}]}}} |