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
9.0 KiB
JSON
1 line
9.0 KiB
JSON
{"sections":[],"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Ok"}],"platforms":["macOS"]}],"kind":"declarations"}],"topicSections":[{"generated":true,"title":"Initializers","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getLabel\/Output\/Ok-swift.struct\/init(body:)"],"anchor":"Initializers"},{"generated":true,"title":"Instance Properties","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getLabel\/Output\/Ok-swift.struct\/body-swift.property"],"anchor":"Instance-Properties"},{"generated":true,"title":"Enumerations","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getLabel\/Output\/Ok-swift.struct\/Body-swift.enum"],"anchor":"Enumerations"},{"generated":true,"title":"Default Implementations","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getLabel\/Output\/Ok-swift.struct\/Equatable-Implementations"],"anchor":"Default-Implementations"}],"kind":"symbol","schemaVersion":{"minor":3,"patch":0,"major":0},"metadata":{"navigatorTitle":[{"text":"Ok","kind":"identifier"}],"role":"symbol","title":"Operations.getLabel.Output.Ok","roleHeading":"Structure","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Ok"}],"externalID":"s:14DiscogsService10OperationsO8getLabelO6OutputO2OkV","symbolKind":"struct","modules":[{"name":"DiscogsService"}]},"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getLabel","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getLabel\/Output"]]},"relationshipsSections":[{"title":"Conforms To","kind":"relationships","identifiers":["doc:\/\/DiscogsService\/SQ","doc:\/\/DiscogsService\/SH","doc:\/\/DiscogsService\/s8SendableP","doc:\/\/DiscogsService\/s16SendableMetatypeP"],"type":"conformsTo"}],"variants":[{"paths":["\/documentation\/discogsservice\/operations\/getlabel\/output\/ok-swift.struct"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getLabel\/Output\/Ok-swift.struct","interfaceLanguage":"swift"},"references":{"doc://DiscogsService/documentation/DiscogsService/Operations/getLabel/Output/Ok-swift.struct/Body-swift.enum":{"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Body"}],"type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getLabel\/Output\/Ok-swift.struct\/Body-swift.enum","navigatorTitle":[{"kind":"identifier","text":"Body"}],"title":"Operations.getLabel.Output.Ok.Body","role":"symbol","abstract":[],"kind":"symbol","url":"\/documentation\/discogsservice\/operations\/getlabel\/output\/ok-swift.struct\/body-swift.enum"},"doc://DiscogsService/documentation/DiscogsService":{"url":"\/documentation\/discogsservice","abstract":[],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService","kind":"symbol","role":"collection","type":"topic","title":"DiscogsService"},"doc://DiscogsService/s16SendableMetatypeP":{"title":"Swift.SendableMetatype","type":"unresolvable","identifier":"doc:\/\/DiscogsService\/s16SendableMetatypeP"},"doc://DiscogsService/SQ":{"title":"Swift.Equatable","type":"unresolvable","identifier":"doc:\/\/DiscogsService\/SQ"},"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/getLabel/Output/Ok-swift.struct/body-swift.property":{"url":"\/documentation\/discogsservice\/operations\/getlabel\/output\/ok-swift.struct\/body-swift.property","abstract":[{"text":"Received HTTP response body","type":"text"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getLabel\/Output\/Ok-swift.struct\/body-swift.property","kind":"symbol","role":"symbol","type":"topic","title":"body","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"body"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"getLabel","preciseIdentifier":"s:14DiscogsService10OperationsO8getLabelO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Output","preciseIdentifier":"s:14DiscogsService10OperationsO8getLabelO6OutputO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Ok","preciseIdentifier":"s:14DiscogsService10OperationsO8getLabelO6OutputO2OkV"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Body","preciseIdentifier":"s:14DiscogsService10OperationsO8getLabelO6OutputO2OkV4BodyO"}]},"doc://DiscogsService/documentation/DiscogsService/Operations/getLabel/Output/Ok-swift.struct/init(body:)":{"type":"topic","url":"\/documentation\/discogsservice\/operations\/getlabel\/output\/ok-swift.struct\/init(body:)","role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getLabel\/Output\/Ok-swift.struct\/init(body:)","kind":"symbol","title":"init(body:)","abstract":[{"type":"text","text":"Creates a new "},{"type":"codeVoice","code":"Ok"},{"text":".","type":"text"}],"fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"body"},{"kind":"text","text":": "},{"preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier","text":"Operations"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO8getLabelO","kind":"typeIdentifier","text":"getLabel"},{"text":".","kind":"text"},{"text":"Output","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO8getLabelO6OutputO"},{"kind":"text","text":"."},{"text":"Ok","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO8getLabelO6OutputO2OkV"},{"kind":"text","text":"."},{"text":"Body","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO8getLabelO6OutputO2OkV4BodyO"},{"text":")","kind":"text"}]},"doc://DiscogsService/SH":{"title":"Swift.Hashable","type":"unresolvable","identifier":"doc:\/\/DiscogsService\/SH"},"doc://DiscogsService/s8SendableP":{"title":"Swift.Sendable","type":"unresolvable","identifier":"doc:\/\/DiscogsService\/s8SendableP"},"doc://DiscogsService/documentation/DiscogsService/Operations/getLabel":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getLabel","type":"topic","url":"\/documentation\/discogsservice\/operations\/getlabel","abstract":[{"type":"text","text":"Get information about a label"}],"role":"symbol","kind":"symbol","navigatorTitle":[{"text":"getLabel","kind":"identifier"}],"title":"Operations.getLabel","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getLabel","kind":"identifier"}]},"doc://DiscogsService/documentation/DiscogsService/Operations/getLabel/Output/Ok-swift.struct":{"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Ok"}],"type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getLabel\/Output\/Ok-swift.struct","navigatorTitle":[{"kind":"identifier","text":"Ok"}],"title":"Operations.getLabel.Output.Ok","role":"symbol","abstract":[],"kind":"symbol","url":"\/documentation\/discogsservice\/operations\/getlabel\/output\/ok-swift.struct"},"doc://DiscogsService/documentation/DiscogsService/Operations/getLabel/Output":{"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Output"}],"type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getLabel\/Output","navigatorTitle":[{"kind":"identifier","text":"Output"}],"title":"Operations.getLabel.Output","role":"symbol","abstract":[],"kind":"symbol","url":"\/documentation\/discogsservice\/operations\/getlabel\/output"},"doc://DiscogsService/documentation/DiscogsService/Operations/getLabel/Output/Ok-swift.struct/Equatable-Implementations":{"url":"\/documentation\/discogsservice\/operations\/getlabel\/output\/ok-swift.struct\/equatable-implementations","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getLabel\/Output\/Ok-swift.struct\/Equatable-Implementations","title":"Equatable Implementations","kind":"article","role":"collectionGroup","abstract":[],"type":"topic"}}} |