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
11 KiB
JSON
1 line
11 KiB
JSON
{"sections":[],"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getReleaseStats","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getReleaseStats\/Output","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getReleaseStats\/Output\/Ok-swift.struct"]]},"schemaVersion":{"minor":3,"patch":0,"major":0},"topicSections":[{"title":"Enumeration Cases","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getReleaseStats\/Output\/Ok-swift.struct\/Body-swift.enum\/json(_:)"],"anchor":"Enumeration-Cases","generated":true},{"title":"Instance Properties","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getReleaseStats\/Output\/Ok-swift.struct\/Body-swift.enum\/json"],"anchor":"Instance-Properties","generated":true},{"title":"Enumerations","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getReleaseStats\/Output\/Ok-swift.struct\/Body-swift.enum\/jsonPayload"],"anchor":"Enumerations","generated":true},{"title":"Default Implementations","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getReleaseStats\/Output\/Ok-swift.struct\/Body-swift.enum\/Equatable-Implementations"],"anchor":"Default-Implementations","generated":true}],"relationshipsSections":[{"identifiers":["doc:\/\/DiscogsService\/SQ","doc:\/\/DiscogsService\/SH","doc:\/\/DiscogsService\/s8SendableP","doc:\/\/DiscogsService\/s16SendableMetatypeP"],"kind":"relationships","type":"conformsTo","title":"Conforms To"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getReleaseStats\/Output\/Ok-swift.struct\/Body-swift.enum"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/discogsservice\/operations\/getreleasestats\/output\/ok-swift.struct\/body-swift.enum"]}],"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["macOS"],"languages":["swift"],"tokens":[{"text":"@frozen","kind":"attribute"},{"text":" ","kind":"text"},{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Body","kind":"identifier"}]}]},{"content":[{"anchor":"overview","type":"heading","level":2,"text":"Overview"},{"style":"note","type":"aside","name":"Remark","content":[{"inlineContent":[{"type":"text","text":"Generated from "},{"type":"codeVoice","code":"#\/paths\/releases\/{release_id}\/stats\/GET\/responses\/200\/content"},{"type":"text","text":"."}],"type":"paragraph"}]}],"kind":"content"}],"metadata":{"title":"Operations.getReleaseStats.Output.Ok.Body","navigatorTitle":[{"kind":"identifier","text":"Body"}],"fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Body","kind":"identifier"}],"modules":[{"name":"DiscogsService"}],"externalID":"s:14DiscogsService10OperationsO15getReleaseStatsO6OutputO2OkV4BodyO","role":"symbol","symbolKind":"enum","roleHeading":"Enumeration"},"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/getReleaseStats/Output/Ok-swift.struct/Body-swift.enum":{"fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Body","kind":"identifier"}],"type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getReleaseStats\/Output\/Ok-swift.struct\/Body-swift.enum","navigatorTitle":[{"text":"Body","kind":"identifier"}],"title":"Operations.getReleaseStats.Output.Ok.Body","role":"symbol","abstract":[],"kind":"symbol","url":"\/documentation\/discogsservice\/operations\/getreleasestats\/output\/ok-swift.struct\/body-swift.enum"},"doc://DiscogsService/SH":{"type":"unresolvable","identifier":"doc:\/\/DiscogsService\/SH","title":"Swift.Hashable"},"doc://DiscogsService/SQ":{"type":"unresolvable","identifier":"doc:\/\/DiscogsService\/SQ","title":"Swift.Equatable"},"doc://DiscogsService/documentation/DiscogsService/Operations/getReleaseStats/Output":{"navigatorTitle":[{"kind":"identifier","text":"Output"}],"abstract":[],"role":"symbol","type":"topic","title":"Operations.getReleaseStats.Output","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Output"}],"kind":"symbol","url":"\/documentation\/discogsservice\/operations\/getreleasestats\/output","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getReleaseStats\/Output"},"doc://DiscogsService/documentation/DiscogsService/Operations/getReleaseStats/Output/Ok-swift.struct/Body-swift.enum/json(_:)":{"abstract":[],"role":"symbol","type":"topic","title":"Operations.getReleaseStats.Output.Ok.Body.json(_:)","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"json","kind":"identifier"},{"text":"(","kind":"text"},{"text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"getReleaseStats","preciseIdentifier":"s:14DiscogsService10OperationsO15getReleaseStatsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Output","preciseIdentifier":"s:14DiscogsService10OperationsO15getReleaseStatsO6OutputO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Ok","preciseIdentifier":"s:14DiscogsService10OperationsO15getReleaseStatsO6OutputO2OkV","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Body","preciseIdentifier":"s:14DiscogsService10OperationsO15getReleaseStatsO6OutputO2OkV4BodyO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"jsonPayload","preciseIdentifier":"s:14DiscogsService10OperationsO15getReleaseStatsO6OutputO2OkV4BodyO11jsonPayloadO","kind":"typeIdentifier"},{"text":")","kind":"text"}],"kind":"symbol","url":"\/documentation\/discogsservice\/operations\/getreleasestats\/output\/ok-swift.struct\/body-swift.enum\/json(_:)","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getReleaseStats\/Output\/Ok-swift.struct\/Body-swift.enum\/json(_:)"},"doc://DiscogsService/documentation/DiscogsService/Operations/getReleaseStats/Output/Ok-swift.struct/Body-swift.enum/json":{"title":"json","kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getReleaseStats\/Output\/Ok-swift.struct\/Body-swift.enum\/json","url":"\/documentation\/discogsservice\/operations\/getreleasestats\/output\/ok-swift.struct\/body-swift.enum\/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"}],"type":"topic","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"json"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO15getReleaseStatsO","text":"getReleaseStats"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO15getReleaseStatsO6OutputO","text":"Output"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO15getReleaseStatsO6OutputO2OkV","text":"Ok"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO15getReleaseStatsO6OutputO2OkV4BodyO","text":"Body"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO15getReleaseStatsO6OutputO2OkV4BodyO11jsonPayloadO","text":"jsonPayload"}],"role":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Operations/getReleaseStats/Output/Ok-swift.struct":{"title":"Operations.getReleaseStats.Output.Ok","kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getReleaseStats\/Output\/Ok-swift.struct","url":"\/documentation\/discogsservice\/operations\/getreleasestats\/output\/ok-swift.struct","abstract":[],"type":"topic","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Ok"}],"role":"symbol","navigatorTitle":[{"text":"Ok","kind":"identifier"}]},"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/getReleaseStats/Output/Ok-swift.struct/Body-swift.enum/Equatable-Implementations":{"url":"\/documentation\/discogsservice\/operations\/getreleasestats\/output\/ok-swift.struct\/body-swift.enum\/equatable-implementations","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getReleaseStats\/Output\/Ok-swift.struct\/Body-swift.enum\/Equatable-Implementations","title":"Equatable Implementations","kind":"article","role":"collectionGroup","type":"topic","abstract":[]},"doc://DiscogsService/s8SendableP":{"type":"unresolvable","identifier":"doc:\/\/DiscogsService\/s8SendableP","title":"Swift.Sendable"},"doc://DiscogsService/documentation/DiscogsService/Operations/getReleaseStats":{"type":"topic","url":"\/documentation\/discogsservice\/operations\/getreleasestats","role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getReleaseStats","kind":"symbol","title":"Operations.getReleaseStats","navigatorTitle":[{"kind":"identifier","text":"getReleaseStats"}],"abstract":[{"text":"Get information about statistics of release.","type":"text"}],"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"getReleaseStats"}]},"doc://DiscogsService/documentation/DiscogsService/Operations/getReleaseStats/Output/Ok-swift.struct/Body-swift.enum/jsonPayload":{"fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"jsonPayload","kind":"identifier"}],"type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getReleaseStats\/Output\/Ok-swift.struct\/Body-swift.enum\/jsonPayload","navigatorTitle":[{"text":"jsonPayload","kind":"identifier"}],"title":"Operations.getReleaseStats.Output.Ok.Body.jsonPayload","role":"symbol","abstract":[],"kind":"symbol","url":"\/documentation\/discogsservice\/operations\/getreleasestats\/output\/ok-swift.struct\/body-swift.enum\/jsonpayload"},"doc://DiscogsService/s16SendableMetatypeP":{"type":"unresolvable","title":"Swift.SendableMetatype","identifier":"doc:\/\/DiscogsService\/s16SendableMetatypeP"}}} |