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.4 KiB
JSON
1 line
6.4 KiB
JSON
{"schemaVersion":{"patch":0,"minor":3,"major":0},"sections":[],"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations"]]},"variants":[{"paths":["\/documentation\/discogsservice\/operations\/getlabelreleases"],"traits":[{"interfaceLanguage":"swift"}]}],"abstract":[{"type":"text","text":"Get information about the releases of a label."}],"primaryContentSections":[{"declarations":[{"platforms":["macOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"getLabelReleases"}]}],"kind":"declarations"},{"content":[{"text":"Overview","type":"heading","level":2,"anchor":"overview"},{"inlineContent":[{"type":"text","text":"Returns a list of releases associated with a label."}],"type":"paragraph"},{"inlineContent":[{"type":"text","text":"This endpoint Supports pagination."}],"type":"paragraph"},{"style":"note","name":"Remark","type":"aside","content":[{"inlineContent":[{"text":"HTTP ","type":"text"},{"code":"GET \/labels\/{label_id}\/releases","type":"codeVoice"},{"text":".","type":"text"}],"type":"paragraph"}]},{"style":"note","name":"Remark","type":"aside","content":[{"inlineContent":[{"type":"text","text":"Generated from "},{"type":"codeVoice","code":"#\/paths\/\/labels\/{label_id}\/releases\/get(getLabelReleases)"},{"type":"text","text":"."}],"type":"paragraph"}]}],"kind":"content"}],"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getLabelReleases","interfaceLanguage":"swift"},"kind":"symbol","topicSections":[{"title":"Structures","generated":true,"anchor":"Structures","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getLabelReleases\/Input"]},{"title":"Type Properties","generated":true,"anchor":"Type-Properties","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getLabelReleases\/id"]},{"title":"Enumerations","generated":true,"anchor":"Enumerations","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getLabelReleases\/AcceptableContentType","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getLabelReleases\/Output"]}],"metadata":{"navigatorTitle":[{"kind":"identifier","text":"getLabelReleases"}],"role":"symbol","title":"Operations.getLabelReleases","roleHeading":"Enumeration","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"getLabelReleases"}],"externalID":"s:14DiscogsService10OperationsO16getLabelReleasesO","symbolKind":"enum","modules":[{"name":"DiscogsService"}]},"references":{"doc://DiscogsService/documentation/DiscogsService/Operations/getLabelReleases/id":{"title":"id","abstract":[],"role":"symbol","url":"\/documentation\/discogsservice\/operations\/getlabelreleases\/id","type":"topic","kind":"symbol","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"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getLabelReleases\/id"},"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":{"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/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/Input":{"url":"\/documentation\/discogsservice\/operations\/getlabelreleases\/input","abstract":[],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getLabelReleases\/Input","kind":"symbol","role":"symbol","type":"topic","title":"Operations.getLabelReleases.Input","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Input","kind":"identifier"}],"navigatorTitle":[{"text":"Input","kind":"identifier"}]},"doc://DiscogsService/documentation/DiscogsService/Operations/getLabelReleases/AcceptableContentType":{"type":"topic","url":"\/documentation\/discogsservice\/operations\/getlabelreleases\/acceptablecontenttype","role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getLabelReleases\/AcceptableContentType","kind":"symbol","title":"Operations.getLabelReleases.AcceptableContentType","navigatorTitle":[{"text":"AcceptableContentType","kind":"identifier"}],"abstract":[],"fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AcceptableContentType","kind":"identifier"}]}}} |