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
{"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Responses\/InternalError\/body-swift.property","interfaceLanguage":"swift"},"metadata":{"title":"body","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"body","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO","text":"Components","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO9ResponsesO","text":"Responses","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO9ResponsesO13InternalErrorV","text":"InternalError","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO9ResponsesO13InternalErrorV4BodyO","text":"Body","kind":"typeIdentifier"}],"modules":[{"name":"DiscogsService"}],"externalID":"s:14DiscogsService10ComponentsO9ResponsesO13InternalErrorV4bodyAG4BodyOvp","symbolKind":"property","role":"symbol","roleHeading":"Instance Property"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/discogsservice\/components\/responses\/internalerror\/body-swift.property"]}],"kind":"symbol","schemaVersion":{"minor":3,"patch":0,"major":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["macOS"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"body","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO","text":"Components","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO9ResponsesO","text":"Responses","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Responses","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO9ResponsesO13InternalErrorV","text":"InternalError","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Responses\/InternalError","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO9ResponsesO13InternalErrorV4BodyO","text":"Body","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Responses\/InternalError\/Body-swift.enum","kind":"typeIdentifier"}],"languages":["swift"]}]}],"abstract":[{"type":"text","text":"Received HTTP response body"}],"sections":[],"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Responses","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Responses\/InternalError"]]},"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/Components/Responses/InternalError/Body-swift.enum":{"navigatorTitle":[{"kind":"identifier","text":"Body"}],"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Body"}],"url":"\/documentation\/discogsservice\/components\/responses\/internalerror\/body-swift.enum","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Responses\/InternalError\/Body-swift.enum","title":"Components.Responses.InternalError.Body","kind":"symbol","role":"symbol","abstract":[],"type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Components/Responses/InternalError/body-swift.property":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Responses\/InternalError\/body-swift.property","type":"topic","url":"\/documentation\/discogsservice\/components\/responses\/internalerror\/body-swift.property","abstract":[{"type":"text","text":"Received HTTP response body"}],"role":"symbol","kind":"symbol","title":"body","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"body","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Components","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO"},{"text":".","kind":"text"},{"text":"Responses","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO9ResponsesO"},{"text":".","kind":"text"},{"text":"InternalError","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO9ResponsesO13InternalErrorV"},{"text":".","kind":"text"},{"text":"Body","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO9ResponsesO13InternalErrorV4BodyO"}]},"doc://DiscogsService/documentation/DiscogsService/Components/Responses/InternalError":{"role":"symbol","type":"topic","abstract":[],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Responses\/InternalError","url":"\/documentation\/discogsservice\/components\/responses\/internalerror","title":"Components.Responses.InternalError","kind":"symbol","navigatorTitle":[{"text":"InternalError","kind":"identifier"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"InternalError"}]},"doc://DiscogsService/documentation/DiscogsService/Components/Responses":{"url":"\/documentation\/discogsservice\/components\/responses","type":"topic","title":"Components.Responses","abstract":[{"type":"text","text":"Types generated from the "},{"type":"codeVoice","code":"#\/components\/responses"},{"type":"text","text":" section of the OpenAPI document."}],"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Responses","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Responses"}],"role":"symbol","navigatorTitle":[{"text":"Responses","kind":"identifier"}]},"doc://DiscogsService/documentation/DiscogsService/Components":{"type":"topic","url":"\/documentation\/discogsservice\/components","role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","kind":"symbol","title":"Components","navigatorTitle":[{"text":"Components","kind":"identifier"}],"abstract":[{"text":"Types generated from the components section of the OpenAPI document.","type":"text"}],"fragments":[{"kind":"keyword","text":"enum"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Components"}]}}} |