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.0 KiB
JSON
1 line
6.0 KiB
JSON
{"metadata":{"navigatorTitle":[{"kind":"identifier","text":"getRelease"}],"modules":[{"name":"DiscogsService"}],"externalID":"s:14DiscogsService10OperationsO10getReleaseO","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getRelease","kind":"identifier"}],"title":"Operations.getRelease","symbolKind":"enum","role":"symbol","roleHeading":"Enumeration"},"schemaVersion":{"minor":3,"patch":0,"major":0},"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations"]]},"topicSections":[{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getRelease\/Input"],"generated":true,"title":"Structures","anchor":"Structures"},{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getRelease\/id"],"generated":true,"title":"Type Properties","anchor":"Type-Properties"},{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getRelease\/AcceptableContentType","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getRelease\/Output"],"generated":true,"title":"Enumerations","anchor":"Enumerations"}],"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getRelease","interfaceLanguage":"swift"},"variants":[{"paths":["\/documentation\/discogsservice\/operations\/getrelease"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getRelease","kind":"identifier"}],"platforms":["macOS"],"languages":["swift"]}]},{"kind":"content","content":[{"type":"heading","anchor":"overview","level":2,"text":"Overview"},{"type":"paragraph","inlineContent":[{"text":"Retrieves details for a specific release.","type":"text"}]},{"type":"aside","name":"Remark","style":"note","content":[{"inlineContent":[{"text":"HTTP ","type":"text"},{"type":"codeVoice","code":"GET \/releases\/{release_id}"},{"text":".","type":"text"}],"type":"paragraph"}]},{"type":"aside","name":"Remark","style":"note","content":[{"inlineContent":[{"text":"Generated from ","type":"text"},{"type":"codeVoice","code":"#\/paths\/\/releases\/{release_id}\/get(getRelease)"},{"text":".","type":"text"}],"type":"paragraph"}]}]}],"abstract":[{"type":"text","text":"Get information about a release"}],"sections":[],"references":{"doc://DiscogsService/documentation/DiscogsService/Operations/getRelease/id":{"fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"id","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"url":"\/documentation\/discogsservice\/operations\/getrelease\/id","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getRelease\/id","title":"id","kind":"symbol","role":"symbol","type":"topic","abstract":[]},"doc://DiscogsService/documentation/DiscogsService/Operations/getRelease/Input":{"navigatorTitle":[{"text":"Input","kind":"identifier"}],"abstract":[],"role":"symbol","type":"topic","title":"Operations.getRelease.Input","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Input","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/discogsservice\/operations\/getrelease\/input","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getRelease\/Input"},"doc://DiscogsService/documentation/DiscogsService/Operations/getRelease/AcceptableContentType":{"navigatorTitle":[{"text":"AcceptableContentType","kind":"identifier"}],"fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AcceptableContentType","kind":"identifier"}],"url":"\/documentation\/discogsservice\/operations\/getrelease\/acceptablecontenttype","role":"symbol","type":"topic","kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getRelease\/AcceptableContentType","abstract":[],"title":"Operations.getRelease.AcceptableContentType"},"doc://DiscogsService/documentation/DiscogsService/Operations/getRelease/Output":{"title":"Operations.getRelease.Output","kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getRelease\/Output","url":"\/documentation\/discogsservice\/operations\/getrelease\/output","abstract":[],"type":"topic","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Output"}],"role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Output"}]},"doc://DiscogsService/documentation/DiscogsService/Operations/getRelease":{"navigatorTitle":[{"text":"getRelease","kind":"identifier"}],"abstract":[{"text":"Get information about a release","type":"text"}],"role":"symbol","type":"topic","title":"Operations.getRelease","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getRelease","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/discogsservice\/operations\/getrelease","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getRelease"},"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"}}} |