rock-n-code/discogs-service
1
0
Fork 0
Code Pull Requests Releases 8 Activity
Files
0f04790d843ea128a309d2a6f1a33fa2b522c51c
discogs-service/docs/data/documentation/discogsservice/components/schemas/labelrelease.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
16 KiB
JSON
Raw Blame History

{"variants":[{"paths":["\/documentation\/discogsservice\/components\/schemas\/labelrelease"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/LabelRelease","interfaceLanguage":"swift"},"metadata":{"modules":[{"name":"DiscogsService"}],"symbolKind":"struct","role":"symbol","roleHeading":"Structure","navigatorTitle":[{"kind":"identifier","text":"LabelRelease"}],"externalID":"s:14DiscogsService10ComponentsO7SchemasO12LabelReleaseV","title":"Components.Schemas.LabelRelease","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"LabelRelease","kind":"identifier"}]},"relationshipsSections":[{"identifiers":["doc:\/\/DiscogsService\/Se","doc:\/\/DiscogsService\/SE","doc:\/\/DiscogsService\/SQ","doc:\/\/DiscogsService\/SH","doc:\/\/DiscogsService\/s8SendableP","doc:\/\/DiscogsService\/s16SendableMetatypeP"],"title":"Conforms To","type":"conformsTo","kind":"relationships"}],"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas"]]},"abstract":[{"type":"text","text":"A type that represents a release of a label."}],"topicSections":[{"generated":true,"anchor":"Initializers","title":"Initializers","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/LabelRelease\/init(from:)","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/LabelRelease\/init(id:resource_url:thumb:artist:title:format:catno:status:year:)"]},{"generated":true,"anchor":"Instance-Properties","title":"Instance Properties","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/LabelRelease\/artist","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/LabelRelease\/catno","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/LabelRelease\/format","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/LabelRelease\/id","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/LabelRelease\/resource_url","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/LabelRelease\/status","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/LabelRelease\/thumb","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/LabelRelease\/title","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/LabelRelease\/year"]},{"generated":true,"anchor":"Enumerations","title":"Enumerations","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/LabelRelease\/CodingKeys"]},{"generated":true,"anchor":"Default-Implementations","title":"Default Implementations","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/LabelRelease\/Equatable-Implementations"]}],"primaryContentSections":[{"declarations":[{"tokens":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"LabelRelease","kind":"identifier"}],"platforms":["macOS"],"languages":["swift"]}],"kind":"declarations"},{"content":[{"type":"heading","anchor":"overview","level":2,"text":"Overview"},{"style":"note","type":"aside","name":"Remark","content":[{"inlineContent":[{"type":"text","text":"Generated from "},{"type":"codeVoice","code":"#\/components\/schemas\/LabelRelease"},{"type":"text","text":"."}],"type":"paragraph"}]}],"kind":"content"}],"kind":"symbol","schemaVersion":{"minor":3,"major":0,"patch":0},"references":{"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/LabelRelease/title":{"url":"\/documentation\/discogsservice\/components\/schemas\/labelrelease\/title","type":"topic","title":"title","abstract":[{"text":"A title of a release.","type":"text"}],"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/LabelRelease\/title","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"title"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"role":"symbol"},"doc://DiscogsService/Se":{"identifier":"doc:\/\/DiscogsService\/Se","title":"Swift.Decodable","type":"unresolvable"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/LabelRelease/status":{"url":"\/documentation\/discogsservice\/components\/schemas\/labelrelease\/status","type":"topic","title":"status","abstract":[{"text":"A status of a release.","type":"text"}],"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/LabelRelease\/status","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"status","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"role":"symbol"},"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/Components/Schemas":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas","type":"topic","url":"\/documentation\/discogsservice\/components\/schemas","abstract":[{"type":"text","text":"Types generated from the "},{"code":"#\/components\/schemas","type":"codeVoice"},{"type":"text","text":" section of the OpenAPI document."}],"role":"symbol","kind":"symbol","navigatorTitle":[{"text":"Schemas","kind":"identifier"}],"title":"Components.Schemas","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Schemas","kind":"identifier"}]},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/LabelRelease/init(from:)":{"url":"\/documentation\/discogsservice\/components\/schemas\/labelrelease\/init(from:)","type":"topic","title":"init(from:)","abstract":[],"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/LabelRelease\/init(from:)","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"text":": any ","kind":"text"},{"preciseIdentifier":"s:s7DecoderP","text":"Decoder","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"kind":"keyword","text":"throws"}],"role":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/LabelRelease/id":{"abstract":[{"type":"text","text":"An identifier of a release."}],"role":"symbol","type":"topic","title":"id","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"id","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"}],"kind":"symbol","url":"\/documentation\/discogsservice\/components\/schemas\/labelrelease\/id","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/LabelRelease\/id"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/LabelRelease/format":{"abstract":[{"type":"text","text":"A format of a release."}],"title":"format","role":"symbol","type":"topic","url":"\/documentation\/discogsservice\/components\/schemas\/labelrelease\/format","kind":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"format"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/LabelRelease\/format"},"doc://DiscogsService/SQ":{"identifier":"doc:\/\/DiscogsService\/SQ","title":"Swift.Equatable","type":"unresolvable"},"doc://DiscogsService/s16SendableMetatypeP":{"identifier":"doc:\/\/DiscogsService\/s16SendableMetatypeP","title":"Swift.SendableMetatype","type":"unresolvable"},"doc://DiscogsService/SE":{"identifier":"doc:\/\/DiscogsService\/SE","title":"Swift.Encodable","type":"unresolvable"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/LabelRelease/year":{"url":"\/documentation\/discogsservice\/components\/schemas\/labelrelease\/year","abstract":[{"text":"A number of year of a release.","type":"text"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/LabelRelease\/year","kind":"symbol","role":"symbol","type":"topic","title":"year","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"year","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Int","preciseIdentifier":"s:Si","kind":"typeIdentifier"}]},"doc://DiscogsService/SH":{"identifier":"doc:\/\/DiscogsService\/SH","title":"Swift.Hashable","type":"unresolvable"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/LabelRelease/CodingKeys":{"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"CodingKeys"}],"type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/LabelRelease\/CodingKeys","navigatorTitle":[{"kind":"identifier","text":"CodingKeys"}],"title":"Components.Schemas.LabelRelease.CodingKeys","role":"symbol","abstract":[],"kind":"symbol","url":"\/documentation\/discogsservice\/components\/schemas\/labelrelease\/codingkeys"},"doc://DiscogsService/documentation/DiscogsService/Components":{"type":"topic","url":"\/documentation\/discogsservice\/components","role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","kind":"symbol","title":"Components","navigatorTitle":[{"text":"Components","kind":"identifier"}],"abstract":[{"text":"Types generated from the components section of the OpenAPI document.","type":"text"}],"fragments":[{"kind":"keyword","text":"enum"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Components"}]},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/LabelRelease":{"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"LabelRelease"}],"type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/LabelRelease","navigatorTitle":[{"kind":"identifier","text":"LabelRelease"}],"title":"Components.Schemas.LabelRelease","role":"symbol","kind":"symbol","abstract":[{"type":"text","text":"A type that represents a release of a label."}],"url":"\/documentation\/discogsservice\/components\/schemas\/labelrelease"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/LabelRelease/artist":{"abstract":[{"type":"text","text":"A name for the artist of a release."}],"title":"artist","role":"symbol","url":"\/documentation\/discogsservice\/components\/schemas\/labelrelease\/artist","type":"topic","kind":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"artist","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/LabelRelease\/artist"},"doc://DiscogsService/s8SendableP":{"identifier":"doc:\/\/DiscogsService\/s8SendableP","title":"Swift.Sendable","type":"unresolvable"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/LabelRelease/Equatable-Implementations":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/LabelRelease\/Equatable-Implementations","type":"topic","abstract":[],"url":"\/documentation\/discogsservice\/components\/schemas\/labelrelease\/equatable-implementations","role":"collectionGroup","kind":"article","title":"Equatable Implementations"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/LabelRelease/thumb":{"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"thumb","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"url":"\/documentation\/discogsservice\/components\/schemas\/labelrelease\/thumb","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/LabelRelease\/thumb","title":"thumb","kind":"symbol","role":"symbol","abstract":[{"type":"text","text":"A URL link to a thumbnail of a release."}],"type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/LabelRelease/catno":{"type":"topic","title":"catno","url":"\/documentation\/discogsservice\/components\/schemas\/labelrelease\/catno","abstract":[{"type":"text","text":"A category number of a release."}],"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"catno","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/LabelRelease\/catno","role":"symbol","kind":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/LabelRelease/resource_url":{"title":"resource_url","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/LabelRelease\/resource_url","type":"topic","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"resource_url"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}],"kind":"symbol","abstract":[{"type":"text","text":"A URI resource of a release."}],"role":"symbol","url":"\/documentation\/discogsservice\/components\/schemas\/labelrelease\/resource_url"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/LabelRelease/init(id:resource_url:thumb:artist:title:format:catno:status:year:)":{"title":"init(id:resource_url:thumb:artist:title:format:catno:status:year:)","type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/LabelRelease\/init(id:resource_url:thumb:artist:title:format:catno:status:year:)","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"id","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Int","preciseIdentifier":"s:Si","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"resource_url","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"thumb","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"artist","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"title","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"format","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"catno","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"status","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"year","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Int","preciseIdentifier":"s:Si","kind":"typeIdentifier"},{"text":")","kind":"text"}],"kind":"symbol","abstract":[{"type":"text","text":"Creates a new "},{"type":"codeVoice","code":"LabelRelease"},{"type":"text","text":"."}],"role":"symbol","url":"\/documentation\/discogsservice\/components\/schemas\/labelrelease\/init(id:resource_url:thumb:artist:title:format:catno:status:year:)"}}}
View Git Blame Copy Permalink