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
8.1 KiB
JSON
1 line
8.1 KiB
JSON
{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getMasterVersions\/Output\/Ok-swift.struct\/body-swift.property"},"metadata":{"title":"body","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"body"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO17getMasterVersionsO","text":"getMasterVersions"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO17getMasterVersionsO6OutputO","text":"Output"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO17getMasterVersionsO6OutputO2OkV","text":"Ok"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO17getMasterVersionsO6OutputO2OkV4BodyO","text":"Body"}],"modules":[{"name":"DiscogsService"}],"externalID":"s:14DiscogsService10OperationsO17getMasterVersionsO6OutputO2OkV4bodyAI4BodyOvp","role":"symbol","symbolKind":"property","roleHeading":"Instance Property"},"variants":[{"paths":["\/documentation\/discogsservice\/operations\/getmasterversions\/output\/ok-swift.struct\/body-swift.property"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","schemaVersion":{"patch":0,"minor":3,"major":0},"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"body"},{"kind":"text","text":": "},{"preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","text":"Operations"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO17getMasterVersionsO","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getMasterVersions","text":"getMasterVersions"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO17getMasterVersionsO6OutputO","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getMasterVersions\/Output","text":"Output"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO17getMasterVersionsO6OutputO2OkV","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getMasterVersions\/Output\/Ok-swift.struct","text":"Ok"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO17getMasterVersionsO6OutputO2OkV4BodyO","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getMasterVersions\/Output\/Ok-swift.struct\/Body-swift.enum","text":"Body"}],"languages":["swift"],"platforms":["macOS"]}],"kind":"declarations"}],"abstract":[{"type":"text","text":"Received HTTP response body"}],"sections":[],"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getMasterVersions","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getMasterVersions\/Output","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getMasterVersions\/Output\/Ok-swift.struct"]]},"references":{"doc://DiscogsService/documentation/DiscogsService/Operations/getMasterVersions":{"navigatorTitle":[{"kind":"identifier","text":"getMasterVersions"}],"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"getMasterVersions"}],"url":"\/documentation\/discogsservice\/operations\/getmasterversions","role":"symbol","type":"topic","kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getMasterVersions","abstract":[{"type":"text","text":"Get information about the versions of a master release."}],"title":"Operations.getMasterVersions"},"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/getMasterVersions/Output/Ok-swift.struct/body-swift.property":{"title":"body","kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getMasterVersions\/Output\/Ok-swift.struct\/body-swift.property","url":"\/documentation\/discogsservice\/operations\/getmasterversions\/output\/ok-swift.struct\/body-swift.property","abstract":[{"text":"Received HTTP response body","type":"text"}],"type":"topic","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"body"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier","text":"Operations"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO17getMasterVersionsO","text":"getMasterVersions","kind":"typeIdentifier"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO17getMasterVersionsO6OutputO","text":"Output","kind":"typeIdentifier"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO17getMasterVersionsO6OutputO2OkV","kind":"typeIdentifier","text":"Ok"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO17getMasterVersionsO6OutputO2OkV4BodyO","text":"Body","kind":"typeIdentifier"}],"role":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Operations/getMasterVersions/Output/Ok-swift.struct":{"navigatorTitle":[{"text":"Ok","kind":"identifier"}],"abstract":[],"role":"symbol","type":"topic","title":"Operations.getMasterVersions.Output.Ok","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Ok","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/discogsservice\/operations\/getmasterversions\/output\/ok-swift.struct","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getMasterVersions\/Output\/Ok-swift.struct"},"doc://DiscogsService/documentation/DiscogsService/Operations/getMasterVersions/Output/Ok-swift.struct/Body-swift.enum":{"navigatorTitle":[{"text":"Body","kind":"identifier"}],"abstract":[],"role":"symbol","type":"topic","title":"Operations.getMasterVersions.Output.Ok.Body","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Body","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/discogsservice\/operations\/getmasterversions\/output\/ok-swift.struct\/body-swift.enum","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getMasterVersions\/Output\/Ok-swift.struct\/Body-swift.enum"},"doc://DiscogsService/documentation/DiscogsService/Operations/getMasterVersions/Output":{"navigatorTitle":[{"kind":"identifier","text":"Output"}],"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Output"}],"url":"\/documentation\/discogsservice\/operations\/getmasterversions\/output","role":"symbol","type":"topic","kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getMasterVersions\/Output","abstract":[],"title":"Operations.getMasterVersions.Output"}}} |