rock-n-code/discogs-service
1
0
Fork 0
Code Pull Requests Releases 8 Activity
Files
a4c84f940f59198702716f785fa9f65b646eb8a4
discogs-service/docs/data/documentation/discogsservice/operations/getreleaserating/input/headers-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
8.7 KiB
JSON
Raw Blame History

{"schemaVersion":{"minor":3,"major":0,"patch":0},"sections":[],"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getReleaseRating","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getReleaseRating\/Input"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/discogsservice\/operations\/getreleaserating\/input\/headers-swift.struct"]}],"primaryContentSections":[{"declarations":[{"tokens":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Headers","kind":"identifier"}],"languages":["swift"],"platforms":["macOS"]}],"kind":"declarations"},{"kind":"content","content":[{"type":"heading","level":2,"text":"Overview","anchor":"overview"},{"style":"note","name":"Remark","type":"aside","content":[{"type":"paragraph","inlineContent":[{"text":"Generated from ","type":"text"},{"type":"codeVoice","code":"#\/paths\/releases\/{release_id}\/rating\/GET\/header"},{"text":".","type":"text"}]}]}]}],"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getReleaseRating\/Input\/Headers-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\/getReleaseRating\/Input\/Headers-swift.struct\/init(accept:)"],"generated":true,"anchor":"Initializers"},{"title":"Instance Properties","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getReleaseRating\/Input\/Headers-swift.struct\/accept"],"generated":true,"anchor":"Instance-Properties"},{"title":"Default Implementations","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getReleaseRating\/Input\/Headers-swift.struct\/Equatable-Implementations"],"generated":true,"anchor":"Default-Implementations"}],"metadata":{"symbolKind":"struct","role":"symbol","externalID":"s:14DiscogsService10OperationsO16getReleaseRatingO5InputV7HeadersV","title":"Operations.getReleaseRating.Input.Headers","modules":[{"name":"DiscogsService"}],"roleHeading":"Structure","navigatorTitle":[{"text":"Headers","kind":"identifier"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Headers","kind":"identifier"}]},"references":{"doc://DiscogsService/s16SendableMetatypeP":{"title":"Swift.SendableMetatype","type":"unresolvable","identifier":"doc:\/\/DiscogsService\/s16SendableMetatypeP"},"doc://DiscogsService/documentation/DiscogsService/Operations/getReleaseRating/Input/Headers-swift.struct/init(accept:)":{"role":"symbol","type":"topic","abstract":[{"type":"text","text":"Creates a new "},{"type":"codeVoice","code":"Headers"},{"type":"text","text":"."}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getReleaseRating\/Input\/Headers-swift.struct\/init(accept:)","title":"init(accept:)","url":"\/documentation\/discogsservice\/operations\/getreleaserating\/input\/headers-swift.struct\/init(accept:)","kind":"symbol","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"accept","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"AcceptHeaderContentType","preciseIdentifier":"s:14OpenAPIRuntime23AcceptHeaderContentTypeV","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"getReleaseRating","preciseIdentifier":"s:14DiscogsService10OperationsO16getReleaseRatingO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"AcceptableContentType","preciseIdentifier":"s:14DiscogsService10OperationsO16getReleaseRatingO21AcceptableContentTypeO","kind":"typeIdentifier"},{"text":">])","kind":"text"}]},"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":{"url":"\/documentation\/discogsservice","abstract":[],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService","kind":"symbol","role":"collection","type":"topic","title":"DiscogsService"},"doc://DiscogsService/SH":{"type":"unresolvable","identifier":"doc:\/\/DiscogsService\/SH","title":"Swift.Hashable"},"doc://DiscogsService/documentation/DiscogsService/Operations/getReleaseRating/Input/Headers-swift.struct/Equatable-Implementations":{"role":"collectionGroup","type":"topic","abstract":[],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getReleaseRating\/Input\/Headers-swift.struct\/Equatable-Implementations","title":"Equatable Implementations","url":"\/documentation\/discogsservice\/operations\/getreleaserating\/input\/headers-swift.struct\/equatable-implementations","kind":"article"},"doc://DiscogsService/SQ":{"title":"Swift.Equatable","type":"unresolvable","identifier":"doc:\/\/DiscogsService\/SQ"},"doc://DiscogsService/s8SendableP":{"title":"Swift.Sendable","type":"unresolvable","identifier":"doc:\/\/DiscogsService\/s8SendableP"},"doc://DiscogsService/documentation/DiscogsService/Operations/getReleaseRating/Input/Headers-swift.struct":{"role":"symbol","type":"topic","abstract":[],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getReleaseRating\/Input\/Headers-swift.struct","url":"\/documentation\/discogsservice\/operations\/getreleaserating\/input\/headers-swift.struct","title":"Operations.getReleaseRating.Input.Headers","kind":"symbol","navigatorTitle":[{"text":"Headers","kind":"identifier"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Headers","kind":"identifier"}]},"doc://DiscogsService/documentation/DiscogsService/Operations/getReleaseRating/Input":{"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Input","kind":"identifier"}],"type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getReleaseRating\/Input","navigatorTitle":[{"text":"Input","kind":"identifier"}],"title":"Operations.getReleaseRating.Input","role":"symbol","abstract":[],"kind":"symbol","url":"\/documentation\/discogsservice\/operations\/getreleaserating\/input"},"doc://DiscogsService/documentation/DiscogsService/Operations/getReleaseRating/Input/Headers-swift.struct/accept":{"role":"symbol","type":"topic","abstract":[],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getReleaseRating\/Input\/Headers-swift.struct\/accept","title":"accept","url":"\/documentation\/discogsservice\/operations\/getreleaserating\/input\/headers-swift.struct\/accept","kind":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"accept","kind":"identifier"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:14OpenAPIRuntime23AcceptHeaderContentTypeV","text":"AcceptHeaderContentType","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"getReleaseRating","preciseIdentifier":"s:14DiscogsService10OperationsO16getReleaseRatingO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"AcceptableContentType","preciseIdentifier":"s:14DiscogsService10OperationsO16getReleaseRatingO21AcceptableContentTypeO","kind":"typeIdentifier"},{"text":">]","kind":"text"}]},"doc://DiscogsService/documentation/DiscogsService/Operations/getReleaseRating":{"url":"\/documentation\/discogsservice\/operations\/getreleaserating","abstract":[{"text":"Get information about a rating of release.","type":"text"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getReleaseRating","kind":"symbol","role":"symbol","title":"Operations.getReleaseRating","type":"topic","fragments":[{"kind":"keyword","text":"enum"},{"text":" ","kind":"text"},{"text":"getReleaseRating","kind":"identifier"}],"navigatorTitle":[{"text":"getReleaseRating","kind":"identifier"}]}}}
View Git Blame Copy Permalink