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
9.1 KiB
JSON
1 line
9.1 KiB
JSON
{"sections":[],"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"attribute","text":"@frozen"},{"kind":"text","text":" "},{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Body"}],"languages":["swift"],"platforms":["macOS"]}],"kind":"declarations"},{"content":[{"type":"heading","text":"Overview","level":2,"anchor":"overview"},{"type":"aside","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Generated from "},{"code":"#\/paths\/masters\/{master_id}\/GET\/responses\/200\/content","type":"codeVoice"},{"type":"text","text":"."}]}],"style":"note","name":"Remark"}],"kind":"content"}],"topicSections":[{"title":"Enumeration Cases","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getMaster\/Output\/Ok-swift.struct\/Body-swift.enum\/json(_:)"],"generated":true,"anchor":"Enumeration-Cases"},{"title":"Instance Properties","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getMaster\/Output\/Ok-swift.struct\/Body-swift.enum\/json"],"generated":true,"anchor":"Instance-Properties"},{"title":"Default Implementations","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getMaster\/Output\/Ok-swift.struct\/Body-swift.enum\/Equatable-Implementations"],"generated":true,"anchor":"Default-Implementations"}],"kind":"symbol","schemaVersion":{"patch":0,"major":0,"minor":3},"metadata":{"navigatorTitle":[{"text":"Body","kind":"identifier"}],"role":"symbol","title":"Operations.getMaster.Output.Ok.Body","roleHeading":"Enumeration","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Body"}],"externalID":"s:14DiscogsService10OperationsO9getMasterO6OutputO2OkV4BodyO","symbolKind":"enum","modules":[{"name":"DiscogsService"}]},"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getMaster","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getMaster\/Output","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getMaster\/Output\/Ok-swift.struct"]]},"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\/getmaster\/output\/ok-swift.struct\/body-swift.enum"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getMaster\/Output\/Ok-swift.struct\/Body-swift.enum","interfaceLanguage":"swift"},"references":{"doc://DiscogsService/documentation/DiscogsService/Operations/getMaster/Output/Ok-swift.struct/Body-swift.enum/json(_:)":{"abstract":[],"title":"Operations.getMaster.Output.Ok.Body.json(_:)","role":"symbol","type":"topic","url":"\/documentation\/discogsservice\/operations\/getmaster\/output\/ok-swift.struct\/body-swift.enum\/json(_:)","kind":"symbol","fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"json"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"Components","preciseIdentifier":"s:14DiscogsService10ComponentsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Schemas","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Master","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO6MasterV"},{"kind":"text","text":")"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getMaster\/Output\/Ok-swift.struct\/Body-swift.enum\/json(_:)"},"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/SQ":{"title":"Swift.Equatable","identifier":"doc:\/\/DiscogsService\/SQ","type":"unresolvable"},"doc://DiscogsService/SH":{"title":"Swift.Hashable","identifier":"doc:\/\/DiscogsService\/SH","type":"unresolvable"},"doc://DiscogsService/documentation/DiscogsService/Operations/getMaster/Output":{"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Output"}],"type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getMaster\/Output","navigatorTitle":[{"kind":"identifier","text":"Output"}],"title":"Operations.getMaster.Output","role":"symbol","abstract":[],"kind":"symbol","url":"\/documentation\/discogsservice\/operations\/getmaster\/output"},"doc://DiscogsService/documentation/DiscogsService/Operations/getMaster/Output/Ok-swift.struct":{"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Ok"}],"type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getMaster\/Output\/Ok-swift.struct","navigatorTitle":[{"kind":"identifier","text":"Ok"}],"title":"Operations.getMaster.Output.Ok","role":"symbol","abstract":[],"kind":"symbol","url":"\/documentation\/discogsservice\/operations\/getmaster\/output\/ok-swift.struct"},"doc://DiscogsService/documentation/DiscogsService/Operations/getMaster/Output/Ok-swift.struct/Body-swift.enum/json":{"type":"topic","url":"\/documentation\/discogsservice\/operations\/getmaster\/output\/ok-swift.struct\/body-swift.enum\/json","role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getMaster\/Output\/Ok-swift.struct\/Body-swift.enum\/json","kind":"symbol","title":"json","abstract":[{"text":"The associated value of the enum case if ","type":"text"},{"type":"codeVoice","code":"self"},{"text":" is ","type":"text"},{"type":"codeVoice","code":".json"},{"text":".","type":"text"}],"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"json"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO","text":"Components"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO","text":"Schemas"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO6MasterV","text":"Master"}]},"doc://DiscogsService/documentation/DiscogsService/Operations/getMaster":{"url":"\/documentation\/discogsservice\/operations\/getmaster","abstract":[{"text":"Get information about a master release.","type":"text"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getMaster","kind":"symbol","role":"symbol","title":"Operations.getMaster","type":"topic","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"getMaster"}],"navigatorTitle":[{"kind":"identifier","text":"getMaster"}]},"doc://DiscogsService/documentation/DiscogsService/Operations/getMaster/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\/getMaster\/Output\/Ok-swift.struct\/Body-swift.enum","navigatorTitle":[{"kind":"identifier","text":"Body"}],"title":"Operations.getMaster.Output.Ok.Body","role":"symbol","abstract":[],"kind":"symbol","url":"\/documentation\/discogsservice\/operations\/getmaster\/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/s8SendableP":{"title":"Swift.Sendable","identifier":"doc:\/\/DiscogsService\/s8SendableP","type":"unresolvable"},"doc://DiscogsService/s16SendableMetatypeP":{"title":"Swift.SendableMetatype","identifier":"doc:\/\/DiscogsService\/s16SendableMetatypeP","type":"unresolvable"},"doc://DiscogsService/documentation/DiscogsService/Operations/getMaster/Output/Ok-swift.struct/Body-swift.enum/Equatable-Implementations":{"abstract":[],"role":"collectionGroup","type":"topic","title":"Equatable Implementations","kind":"article","url":"\/documentation\/discogsservice\/operations\/getmaster\/output\/ok-swift.struct\/body-swift.enum\/equatable-implementations","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getMaster\/Output\/Ok-swift.struct\/Body-swift.enum\/Equatable-Implementations"}}} |