rock-n-code/discogs-service
1
0
Fork 0
Code Pull Requests Releases 8 Activity
Files
ea39b68a4d1c6c5c87df9712fe2b0d180bf083b5
discogs-service/docs/data/documentation/discogsservice/operations/getreleasestats/output/ok-swift.struct.json
T
javier 428eedd89d Implemented the Services and Database GET endpoints (#2) 
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>
2025-10-09 23:51:39 +00:00

1 line
9.4 KiB
JSON
Raw Blame History

{"schemaVersion":{"major":0,"patch":0,"minor":3},"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"]]},"variants":[{"paths":["\/documentation\/discogsservice\/operations\/getreleasestats\/output\/ok-swift.struct"],"traits":[{"interfaceLanguage":"swift"}]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Ok","kind":"identifier"}],"languages":["swift"],"platforms":["macOS"]}]}],"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getReleaseStats\/Output\/Ok-swift.struct","interfaceLanguage":"swift"},"relationshipsSections":[{"title":"Conforms To","identifiers":["doc:\/\/DiscogsService\/SQ","doc:\/\/DiscogsService\/SH","doc:\/\/DiscogsService\/s8SendableP","doc:\/\/DiscogsService\/s16SendableMetatypeP"],"type":"conformsTo","kind":"relationships"}],"kind":"symbol","topicSections":[{"title":"Initializers","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getReleaseStats\/Output\/Ok-swift.struct\/init(body:)"],"anchor":"Initializers","generated":true},{"title":"Instance Properties","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getReleaseStats\/Output\/Ok-swift.struct\/body-swift.property"],"anchor":"Instance-Properties","generated":true},{"title":"Enumerations","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getReleaseStats\/Output\/Ok-swift.struct\/Body-swift.enum"],"anchor":"Enumerations","generated":true},{"title":"Default Implementations","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getReleaseStats\/Output\/Ok-swift.struct\/Equatable-Implementations"],"anchor":"Default-Implementations","generated":true}],"metadata":{"symbolKind":"struct","role":"symbol","externalID":"s:14DiscogsService10OperationsO15getReleaseStatsO6OutputO2OkV","title":"Operations.getReleaseStats.Output.Ok","modules":[{"name":"DiscogsService"}],"roleHeading":"Structure","navigatorTitle":[{"text":"Ok","kind":"identifier"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Ok","kind":"identifier"}]},"references":{"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/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","type":"unresolvable","identifier":"doc:\/\/DiscogsService\/SQ"},"doc://DiscogsService/documentation/DiscogsService/Operations/getReleaseStats/Output/Ok-swift.struct/body-swift.property":{"role":"symbol","type":"topic","abstract":[{"type":"text","text":"Received HTTP response body"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getReleaseStats\/Output\/Ok-swift.struct\/body-swift.property","title":"body","url":"\/documentation\/discogsservice\/operations\/getreleasestats\/output\/ok-swift.struct\/body-swift.property","kind":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"body"},{"kind":"text","text":": "},{"preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier","text":"Operations"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO15getReleaseStatsO","kind":"typeIdentifier","text":"getReleaseStats"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO15getReleaseStatsO6OutputO","kind":"typeIdentifier","text":"Output"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO15getReleaseStatsO6OutputO2OkV","kind":"typeIdentifier","text":"Ok"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO15getReleaseStatsO6OutputO2OkV4BodyO","kind":"typeIdentifier","text":"Body"}]},"doc://DiscogsService/SH":{"title":"Swift.Hashable","type":"unresolvable","identifier":"doc:\/\/DiscogsService\/SH"},"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/init(body:)":{"type":"topic","url":"\/documentation\/discogsservice\/operations\/getreleasestats\/output\/ok-swift.struct\/init(body:)","role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getReleaseStats\/Output\/Ok-swift.struct\/init(body:)","kind":"symbol","title":"init(body:)","abstract":[{"type":"text","text":"Creates a new "},{"type":"codeVoice","code":"Ok"},{"type":"text","text":"."}],"fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"body","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO15getReleaseStatsO","text":"getReleaseStats","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO15getReleaseStatsO6OutputO","text":"Output","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO15getReleaseStatsO6OutputO2OkV","text":"Ok","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO15getReleaseStatsO6OutputO2OkV4BodyO","text":"Body","kind":"typeIdentifier"},{"text":")","kind":"text"}]},"doc://DiscogsService/documentation/DiscogsService/Operations/getReleaseStats/Output/Ok-swift.struct/Equatable-Implementations":{"role":"collectionGroup","type":"topic","abstract":[],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getReleaseStats\/Output\/Ok-swift.struct\/Equatable-Implementations","title":"Equatable Implementations","url":"\/documentation\/discogsservice\/operations\/getreleasestats\/output\/ok-swift.struct\/equatable-implementations","kind":"article"},"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/s8SendableP":{"title":"Swift.Sendable","type":"unresolvable","identifier":"doc:\/\/DiscogsService\/s8SendableP"},"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":{"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"}}}
View Git Blame Copy Permalink