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
7.2 KiB
JSON
1 line
7.2 KiB
JSON
{"schemaVersion":{"patch":0,"minor":3,"major":0},"sections":[],"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getLabelReleases","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getLabelReleases\/Output"]]},"variants":[{"paths":["\/documentation\/discogsservice\/operations\/getlabelreleases\/output\/ok(_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"abstract":[{"type":"text","text":"A paginated list of the label’s releases."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"ok"},{"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\/getLabelReleases","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO16getLabelReleasesO","text":"getLabelReleases"},{"kind":"text","text":"."},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getLabelReleases\/Output","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO16getLabelReleasesO6OutputO","text":"Output"},{"kind":"text","text":"."},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getLabelReleases\/Output\/Ok-swift.struct","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO16getLabelReleasesO6OutputO2OkV","text":"Ok"},{"kind":"text","text":")"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"content","content":[{"type":"heading","text":"Discussion","level":2,"anchor":"discussion"},{"type":"aside","content":[{"inlineContent":[{"type":"text","text":"Generated from "},{"code":"#\/paths\/\/labels\/{label_id}\/releases\/get(getLabelReleases)\/responses\/200","type":"codeVoice"},{"text":".","type":"text"}],"type":"paragraph"}],"style":"note","name":"Remark"},{"inlineContent":[{"type":"text","text":"HTTP response code: "},{"type":"codeVoice","code":"200 ok"},{"type":"text","text":"."}],"type":"paragraph"}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getLabelReleases\/Output\/ok(_:)"},"kind":"symbol","metadata":{"symbolKind":"case","role":"symbol","externalID":"s:14DiscogsService10OperationsO16getLabelReleasesO6OutputO2okyA2G2OkVcAGmF","title":"Operations.getLabelReleases.Output.ok(_:)","modules":[{"name":"DiscogsService"}],"roleHeading":"Case","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"ok","kind":"identifier"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO16getLabelReleasesO","text":"getLabelReleases","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO16getLabelReleasesO6OutputO","text":"Output","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO16getLabelReleasesO6OutputO2OkV","text":"Ok","kind":"typeIdentifier"},{"text":")","kind":"text"}]},"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/getLabelReleases/Output":{"url":"\/documentation\/discogsservice\/operations\/getlabelreleases\/output","abstract":[],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getLabelReleases\/Output","kind":"symbol","role":"symbol","title":"Operations.getLabelReleases.Output","type":"topic","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Output"}],"navigatorTitle":[{"kind":"identifier","text":"Output"}]},"doc://DiscogsService/documentation/DiscogsService/Operations/getLabelReleases/Output/ok(_:)":{"abstract":[{"type":"text","text":"A paginated list of the label’s releases."}],"title":"Operations.getLabelReleases.Output.ok(_:)","role":"symbol","url":"\/documentation\/discogsservice\/operations\/getlabelreleases\/output\/ok(_:)","type":"topic","kind":"symbol","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"ok","kind":"identifier"},{"text":"(","kind":"text"},{"text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"getLabelReleases","preciseIdentifier":"s:14DiscogsService10OperationsO16getLabelReleasesO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Output","preciseIdentifier":"s:14DiscogsService10OperationsO16getLabelReleasesO6OutputO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Ok","preciseIdentifier":"s:14DiscogsService10OperationsO16getLabelReleasesO6OutputO2OkV","kind":"typeIdentifier"},{"text":")","kind":"text"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getLabelReleases\/Output\/ok(_:)"},"doc://DiscogsService/documentation/DiscogsService/Operations/getLabelReleases":{"url":"\/documentation\/discogsservice\/operations\/getlabelreleases","abstract":[{"type":"text","text":"Get information about the releases of a label."}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getLabelReleases","kind":"symbol","role":"symbol","title":"Operations.getLabelReleases","type":"topic","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"getLabelReleases"}],"navigatorTitle":[{"kind":"identifier","text":"getLabelReleases"}]},"doc://DiscogsService/documentation/DiscogsService/Operations/getLabelReleases/Output/Ok-swift.struct":{"url":"\/documentation\/discogsservice\/operations\/getlabelreleases\/output\/ok-swift.struct","abstract":[],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getLabelReleases\/Output\/Ok-swift.struct","kind":"symbol","role":"symbol","title":"Operations.getLabelReleases.Output.Ok","type":"topic","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Ok"}],"navigatorTitle":[{"kind":"identifier","text":"Ok"}]}}} |