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
16 KiB
JSON
1 line
16 KiB
JSON
{"schemaVersion":{"minor":3,"major":0,"patch":0},"sections":[],"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/APIProtocol"]]},"variants":[{"paths":["\/documentation\/discogsservice\/apiprotocol\/getlabelreleases(path:query:headers:)"],"traits":[{"interfaceLanguage":"swift"}]}],"abstract":[{"text":"Get information about the releases of a label.","type":"text"}],"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getLabelReleases"},{"kind":"text","text":"("},{"kind":"externalParam","text":"path"},{"kind":"text","text":": "},{"preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","text":"Operations"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO16getLabelReleasesO","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getLabelReleases","text":"getLabelReleases"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO16getLabelReleasesO5InputV","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getLabelReleases\/Input","text":"Input"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO16getLabelReleasesO5InputV4PathV","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getLabelReleases\/Input\/Path-swift.struct","text":"Path"},{"kind":"text","text":", "},{"kind":"externalParam","text":"query"},{"kind":"text","text":": "},{"preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","text":"Operations"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO16getLabelReleasesO","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getLabelReleases","text":"getLabelReleases"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO16getLabelReleasesO5InputV","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getLabelReleases\/Input","text":"Input"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO16getLabelReleasesO5InputV5QueryV","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getLabelReleases\/Input\/Query-swift.struct","text":"Query"},{"kind":"text","text":" = .init(), "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": "},{"preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","text":"Operations"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO16getLabelReleasesO","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getLabelReleases","text":"getLabelReleases"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO16getLabelReleasesO5InputV","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getLabelReleases\/Input","text":"Input"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO16getLabelReleasesO5InputV7HeadersV","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getLabelReleases\/Input\/Headers-swift.struct","text":"Headers"},{"kind":"text","text":" = .init()) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","text":"Operations"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO16getLabelReleasesO","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getLabelReleases","text":"getLabelReleases"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO16getLabelReleasesO6OutputO","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getLabelReleases\/Output","text":"Output"}],"languages":["swift"],"platforms":["macOS"]}],"kind":"declarations"},{"content":[{"type":"heading","text":"Discussion","level":2,"anchor":"discussion"},{"type":"paragraph","inlineContent":[{"type":"text","text":"Returns a list of releases associated with a label."}]},{"type":"paragraph","inlineContent":[{"type":"text","text":"This endpoint Supports pagination."}]},{"type":"aside","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"HTTP "},{"code":"GET \/labels\/{label_id}\/releases","type":"codeVoice"},{"type":"text","text":"."}]}],"style":"note","name":"Remark"},{"type":"aside","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Generated from "},{"code":"#\/paths\/\/labels\/{label_id}\/releases\/get(getLabelReleases)","type":"codeVoice"},{"type":"text","text":"."}]}],"style":"note","name":"Remark"}],"kind":"content"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/APIProtocol\/getLabelReleases(path:query:headers:)"},"kind":"symbol","metadata":{"symbolKind":"method","role":"symbol","externalID":"s:14DiscogsService11APIProtocolPAAE16getLabelReleases4path5query7headersAA10OperationsOADO6OutputOAJ5InputV4PathV_AN5QueryVAN7HeadersVtYaKF","title":"getLabelReleases(path:query:headers:)","modules":[{"name":"DiscogsService"}],"roleHeading":"Instance Method","extendedModule":"DiscogsService","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getLabelReleases","kind":"identifier"},{"text":"(","kind":"text"},{"text":"path","kind":"externalParam"},{"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:14DiscogsService10OperationsO16getLabelReleasesO5InputV","text":"Input","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO16getLabelReleasesO5InputV4PathV","text":"Path","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"query","kind":"externalParam"},{"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:14DiscogsService10OperationsO16getLabelReleasesO5InputV","text":"Input","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO16getLabelReleasesO5InputV5QueryV","text":"Query","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"headers","kind":"externalParam"},{"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:14DiscogsService10OperationsO16getLabelReleasesO5InputV","text":"Input","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO16getLabelReleasesO5InputV7HeadersV","text":"Headers","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"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"}]},"references":{"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/Input/Path-swift.struct":{"navigatorTitle":[{"kind":"identifier","text":"Path"}],"abstract":[],"title":"Operations.getLabelReleases.Input.Path","role":"symbol","type":"topic","url":"\/documentation\/discogsservice\/operations\/getlabelreleases\/input\/path-swift.struct","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Path","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getLabelReleases\/Input\/Path-swift.struct"},"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":{"url":"\/documentation\/discogsservice","abstract":[],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService","kind":"symbol","role":"collection","type":"topic","title":"DiscogsService"},"doc://DiscogsService/documentation/DiscogsService/Operations/getLabelReleases/Input/Query-swift.struct":{"url":"\/documentation\/discogsservice\/operations\/getlabelreleases\/input\/query-swift.struct","type":"topic","title":"Operations.getLabelReleases.Input.Query","abstract":[],"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getLabelReleases\/Input\/Query-swift.struct","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Query"}],"role":"symbol","navigatorTitle":[{"text":"Query","kind":"identifier"}]},"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/Input/Headers-swift.struct":{"url":"\/documentation\/discogsservice\/operations\/getlabelreleases\/input\/headers-swift.struct","type":"topic","title":"Operations.getLabelReleases.Input.Headers","abstract":[],"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getLabelReleases\/Input\/Headers-swift.struct","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Headers","kind":"identifier"}],"role":"symbol","navigatorTitle":[{"text":"Headers","kind":"identifier"}]},"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/APIProtocol/getLabelReleases(path:query:headers:)":{"role":"symbol","type":"topic","abstract":[{"type":"text","text":"Get information about the releases of a label."}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/APIProtocol\/getLabelReleases(path:query:headers:)","title":"getLabelReleases(path:query:headers:)","url":"\/documentation\/discogsservice\/apiprotocol\/getlabelreleases(path:query:headers:)","kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getLabelReleases","kind":"identifier"},{"text":"(","kind":"text"},{"text":"path","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"getLabelReleases","preciseIdentifier":"s:14DiscogsService10OperationsO16getLabelReleasesO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Input","preciseIdentifier":"s:14DiscogsService10OperationsO16getLabelReleasesO5InputV","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Path","preciseIdentifier":"s:14DiscogsService10OperationsO16getLabelReleasesO5InputV4PathV","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"query","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"getLabelReleases","preciseIdentifier":"s:14DiscogsService10OperationsO16getLabelReleasesO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Input","preciseIdentifier":"s:14DiscogsService10OperationsO16getLabelReleasesO5InputV","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Query","preciseIdentifier":"s:14DiscogsService10OperationsO16getLabelReleasesO5InputV5QueryV","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"getLabelReleases","preciseIdentifier":"s:14DiscogsService10OperationsO16getLabelReleasesO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Input","preciseIdentifier":"s:14DiscogsService10OperationsO16getLabelReleasesO5InputV","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Headers","preciseIdentifier":"s:14DiscogsService10OperationsO16getLabelReleasesO5InputV7HeadersV","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"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"}]},"doc://DiscogsService/documentation/DiscogsService/APIProtocol":{"navigatorTitle":[{"kind":"identifier","text":"APIProtocol"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"APIProtocol"}],"url":"\/documentation\/discogsservice\/apiprotocol","role":"symbol","type":"topic","kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/APIProtocol","abstract":[{"type":"text","text":"A type that performs HTTP operations defined by the OpenAPI document."}],"title":"APIProtocol"}}} |