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
6.5 KiB
JSON
1 line
6.5 KiB
JSON
{"schemaVersion":{"patch":0,"major":0,"minor":3},"sections":[],"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getMasterVersions","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getMasterVersions\/Input"]]},"variants":[{"paths":["\/documentation\/discogsservice\/operations\/getmasterversions\/input\/query-swift.property"],"traits":[{"interfaceLanguage":"swift"}]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"query"},{"kind":"text","text":": "},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations"},{"kind":"text","text":"."},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getMasterVersions","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO17getMasterVersionsO","text":"getMasterVersions"},{"kind":"text","text":"."},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getMasterVersions\/Input","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO17getMasterVersionsO5InputV","text":"Input"},{"kind":"text","text":"."},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getMasterVersions\/Input\/Query-swift.struct","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO17getMasterVersionsO5InputV5QueryV","text":"Query"}],"platforms":["macOS"],"languages":["swift"]}]}],"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getMasterVersions\/Input\/query-swift.property","interfaceLanguage":"swift"},"kind":"symbol","metadata":{"title":"query","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"query"},{"kind":"text","text":": "},{"preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier","text":"Operations"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO17getMasterVersionsO","kind":"typeIdentifier","text":"getMasterVersions"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO17getMasterVersionsO5InputV","kind":"typeIdentifier","text":"Input"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO17getMasterVersionsO5InputV5QueryV","kind":"typeIdentifier","text":"Query"}],"modules":[{"name":"DiscogsService"}],"externalID":"s:14DiscogsService10OperationsO17getMasterVersionsO5InputV5queryAG5QueryVvp","role":"symbol","symbolKind":"property","roleHeading":"Instance Property"},"references":{"doc://DiscogsService/documentation/DiscogsService/Operations/getMasterVersions/Input/Query-swift.struct":{"navigatorTitle":[{"kind":"identifier","text":"Query"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Query"}],"url":"\/documentation\/discogsservice\/operations\/getmasterversions\/input\/query-swift.struct","role":"symbol","type":"topic","kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getMasterVersions\/Input\/Query-swift.struct","abstract":[],"title":"Operations.getMasterVersions.Input.Query"},"doc://DiscogsService/documentation/DiscogsService/Operations/getMasterVersions/Input/query-swift.property":{"title":"query","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getMasterVersions\/Input\/query-swift.property","type":"topic","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"query","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO17getMasterVersionsO","text":"getMasterVersions","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO17getMasterVersionsO5InputV","text":"Input","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO17getMasterVersionsO5InputV5QueryV","text":"Query","kind":"typeIdentifier"}],"kind":"symbol","abstract":[],"role":"symbol","url":"\/documentation\/discogsservice\/operations\/getmasterversions\/input\/query-swift.property"},"doc://DiscogsService/documentation/DiscogsService/Operations/getMasterVersions/Input":{"navigatorTitle":[{"kind":"identifier","text":"Input"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Input"}],"url":"\/documentation\/discogsservice\/operations\/getmasterversions\/input","role":"symbol","type":"topic","kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getMasterVersions\/Input","abstract":[],"title":"Operations.getMasterVersions.Input"},"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":{"url":"\/documentation\/discogsservice","abstract":[],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService","kind":"symbol","role":"collection","type":"topic","title":"DiscogsService"},"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"}}} |