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

{"metadata":{"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"CodingKeys"}],"navigatorTitle":[{"text":"CodingKeys","kind":"identifier"}],"title":"Components.Schemas.ReleaseVersion.CodingKeys","role":"symbol","roleHeading":"Enumeration","modules":[{"name":"DiscogsService"}],"symbolKind":"enum","externalID":"s:14DiscogsService10ComponentsO7SchemasO14ReleaseVersionV10CodingKeysO"},"schemaVersion":{"minor":3,"patch":0,"major":0},"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseVersion"]]},"topicSections":[{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseVersion\/CodingKeys\/catno","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseVersion\/CodingKeys\/country","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseVersion\/CodingKeys\/format","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseVersion\/CodingKeys\/id","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseVersion\/CodingKeys\/label","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseVersion\/CodingKeys\/major_formats","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseVersion\/CodingKeys\/released","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseVersion\/CodingKeys\/resource_url","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseVersion\/CodingKeys\/stats","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseVersion\/CodingKeys\/status","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseVersion\/CodingKeys\/thumb","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseVersion\/CodingKeys\/title"],"anchor":"Enumeration-Cases","title":"Enumeration Cases","generated":true},{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseVersion\/CodingKeys\/init(intValue:)","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseVersion\/CodingKeys\/init(rawValue:)","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseVersion\/CodingKeys\/init(stringValue:)"],"anchor":"Initializers","title":"Initializers","generated":true},{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseVersion\/CodingKeys\/CodingKey-Implementations","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseVersion\/CodingKeys\/Equatable-Implementations","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseVersion\/CodingKeys\/RawRepresentable-Implementations"],"anchor":"Default-Implementations","title":"Default Implementations","generated":true}],"relationshipsSections":[{"type":"conformsTo","identifiers":["doc:\/\/DiscogsService\/s9CodingKeyP","doc:\/\/DiscogsService\/s28CustomDebugStringConvertibleP","doc:\/\/DiscogsService\/s23CustomStringConvertibleP","doc:\/\/DiscogsService\/SQ","doc:\/\/DiscogsService\/SH","doc:\/\/DiscogsService\/SY","doc:\/\/DiscogsService\/s8SendableP","doc:\/\/DiscogsService\/s16SendableMetatypeP"],"title":"Conforms To","kind":"relationships"}],"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseVersion\/CodingKeys","interfaceLanguage":"swift"},"variants":[{"paths":["\/documentation\/discogsservice\/components\/schemas\/releaseversion\/codingkeys"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","primaryContentSections":[{"declarations":[{"platforms":["macOS"],"tokens":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"CodingKeys"}],"languages":["swift"]}],"kind":"declarations"}],"sections":[],"references":{"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ReleaseVersion/CodingKeys/released":{"fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"released","kind":"identifier"}],"url":"\/documentation\/discogsservice\/components\/schemas\/releaseversion\/codingkeys\/released","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseVersion\/CodingKeys\/released","title":"Components.Schemas.ReleaseVersion.CodingKeys.released","kind":"symbol","role":"symbol","type":"topic","abstract":[]},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ReleaseVersion":{"url":"\/documentation\/discogsservice\/components\/schemas\/releaseversion","abstract":[{"text":"A type that represents a version of a release.","type":"text"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseVersion","kind":"symbol","role":"symbol","type":"topic","title":"Components.Schemas.ReleaseVersion","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"ReleaseVersion"}],"navigatorTitle":[{"kind":"identifier","text":"ReleaseVersion"}]},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ReleaseVersion/CodingKeys/format":{"role":"symbol","type":"topic","abstract":[],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseVersion\/CodingKeys\/format","url":"\/documentation\/discogsservice\/components\/schemas\/releaseversion\/codingkeys\/format","title":"Components.Schemas.ReleaseVersion.CodingKeys.format","kind":"symbol","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"format","kind":"identifier"}]},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ReleaseVersion/CodingKeys/label":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseVersion\/CodingKeys\/label","type":"topic","url":"\/documentation\/discogsservice\/components\/schemas\/releaseversion\/codingkeys\/label","abstract":[],"role":"symbol","kind":"symbol","title":"Components.Schemas.ReleaseVersion.CodingKeys.label","fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"label"}]},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ReleaseVersion/CodingKeys/status":{"title":"Components.Schemas.ReleaseVersion.CodingKeys.status","kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseVersion\/CodingKeys\/status","url":"\/documentation\/discogsservice\/components\/schemas\/releaseversion\/codingkeys\/status","abstract":[],"type":"topic","fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"status"}],"role":"symbol"},"doc://DiscogsService/s9CodingKeyP":{"type":"unresolvable","identifier":"doc:\/\/DiscogsService\/s9CodingKeyP","title":"Swift.CodingKey"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ReleaseVersion/CodingKeys/catno":{"fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"catno","kind":"identifier"}],"url":"\/documentation\/discogsservice\/components\/schemas\/releaseversion\/codingkeys\/catno","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseVersion\/CodingKeys\/catno","title":"Components.Schemas.ReleaseVersion.CodingKeys.catno","kind":"symbol","role":"symbol","type":"topic","abstract":[]},"doc://DiscogsService/SH":{"type":"unresolvable","identifier":"doc:\/\/DiscogsService\/SH","title":"Swift.Hashable"},"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/ReleaseVersion/CodingKeys/Equatable-Implementations":{"abstract":[],"role":"collectionGroup","type":"topic","title":"Equatable Implementations","kind":"article","url":"\/documentation\/discogsservice\/components\/schemas\/releaseversion\/codingkeys\/equatable-implementations","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseVersion\/CodingKeys\/Equatable-Implementations"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ReleaseVersion/CodingKeys/RawRepresentable-Implementations":{"url":"\/documentation\/discogsservice\/components\/schemas\/releaseversion\/codingkeys\/rawrepresentable-implementations","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseVersion\/CodingKeys\/RawRepresentable-Implementations","title":"RawRepresentable Implementations","kind":"article","role":"collectionGroup","type":"topic","abstract":[]},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ReleaseVersion/CodingKeys/resource_url":{"fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"resource_url","kind":"identifier"}],"url":"\/documentation\/discogsservice\/components\/schemas\/releaseversion\/codingkeys\/resource_url","role":"symbol","type":"topic","kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseVersion\/CodingKeys\/resource_url","abstract":[],"title":"Components.Schemas.ReleaseVersion.CodingKeys.resource_url"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ReleaseVersion/CodingKeys/stats":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseVersion\/CodingKeys\/stats","type":"topic","url":"\/documentation\/discogsservice\/components\/schemas\/releaseversion\/codingkeys\/stats","abstract":[],"role":"symbol","kind":"symbol","title":"Components.Schemas.ReleaseVersion.CodingKeys.stats","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"stats","kind":"identifier"}]},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ReleaseVersion/CodingKeys/init(rawValue:)":{"type":"topic","url":"\/documentation\/discogsservice\/components\/schemas\/releaseversion\/codingkeys\/init(rawvalue:)","role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseVersion\/CodingKeys\/init(rawValue:)","kind":"symbol","title":"init(rawValue:)","abstract":[],"fragments":[{"text":"init","kind":"identifier"},{"text":"?(","kind":"text"},{"text":"rawValue","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":")","kind":"text"}]},"doc://DiscogsService/s23CustomStringConvertibleP":{"type":"unresolvable","identifier":"doc:\/\/DiscogsService\/s23CustomStringConvertibleP","title":"Swift.CustomStringConvertible"},"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/SQ":{"identifier":"doc:\/\/DiscogsService\/SQ","type":"unresolvable","title":"Swift.Equatable"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ReleaseVersion/CodingKeys/CodingKey-Implementations":{"url":"\/documentation\/discogsservice\/components\/schemas\/releaseversion\/codingkeys\/codingkey-implementations","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseVersion\/CodingKeys\/CodingKey-Implementations","title":"CodingKey Implementations","kind":"article","role":"collectionGroup","abstract":[],"type":"topic"},"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/ReleaseVersion/CodingKeys/init(stringValue:)":{"title":"init(stringValue:)","kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseVersion\/CodingKeys\/init(stringValue:)","abstract":[],"url":"\/documentation\/discogsservice\/components\/schemas\/releaseversion\/codingkeys\/init(stringvalue:)","type":"topic","fragments":[{"text":"init","kind":"identifier"},{"text":"?(","kind":"text"},{"text":"stringValue","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":")","kind":"text"}],"role":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ReleaseVersion/CodingKeys":{"url":"\/documentation\/discogsservice\/components\/schemas\/releaseversion\/codingkeys","abstract":[],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseVersion\/CodingKeys","kind":"symbol","role":"symbol","type":"topic","title":"Components.Schemas.ReleaseVersion.CodingKeys","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"CodingKeys"}],"navigatorTitle":[{"kind":"identifier","text":"CodingKeys"}]},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ReleaseVersion/CodingKeys/country":{"abstract":[],"role":"symbol","type":"topic","title":"Components.Schemas.ReleaseVersion.CodingKeys.country","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"country","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/discogsservice\/components\/schemas\/releaseversion\/codingkeys\/country","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseVersion\/CodingKeys\/country"},"doc://DiscogsService/s16SendableMetatypeP":{"type":"unresolvable","identifier":"doc:\/\/DiscogsService\/s16SendableMetatypeP","title":"Swift.SendableMetatype"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ReleaseVersion/CodingKeys/title":{"role":"symbol","type":"topic","abstract":[],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseVersion\/CodingKeys\/title","title":"Components.Schemas.ReleaseVersion.CodingKeys.title","url":"\/documentation\/discogsservice\/components\/schemas\/releaseversion\/codingkeys\/title","kind":"symbol","fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"text":"title","kind":"identifier"}]},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ReleaseVersion/CodingKeys/major_formats":{"fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"major_formats","kind":"identifier"}],"url":"\/documentation\/discogsservice\/components\/schemas\/releaseversion\/codingkeys\/major_formats","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseVersion\/CodingKeys\/major_formats","title":"Components.Schemas.ReleaseVersion.CodingKeys.major_formats","kind":"symbol","role":"symbol","type":"topic","abstract":[]},"doc://DiscogsService/s8SendableP":{"type":"unresolvable","identifier":"doc:\/\/DiscogsService\/s8SendableP","title":"Swift.Sendable"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ReleaseVersion/CodingKeys/id":{"fragments":[{"text":"case","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"id"}],"type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseVersion\/CodingKeys\/id","title":"Components.Schemas.ReleaseVersion.CodingKeys.id","role":"symbol","abstract":[],"kind":"symbol","url":"\/documentation\/discogsservice\/components\/schemas\/releaseversion\/codingkeys\/id"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ReleaseVersion/CodingKeys/init(intValue:)":{"abstract":[],"role":"symbol","type":"topic","title":"init(intValue:)","fragments":[{"text":"init","kind":"identifier"},{"text":"?(","kind":"text"},{"text":"intValue","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Int","preciseIdentifier":"s:Si","kind":"typeIdentifier"},{"text":")","kind":"text"}],"kind":"symbol","url":"\/documentation\/discogsservice\/components\/schemas\/releaseversion\/codingkeys\/init(intvalue:)","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseVersion\/CodingKeys\/init(intValue:)"},"doc://DiscogsService/SY":{"type":"unresolvable","identifier":"doc:\/\/DiscogsService\/SY","title":"Swift.RawRepresentable"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ReleaseVersion/CodingKeys/thumb":{"title":"Components.Schemas.ReleaseVersion.CodingKeys.thumb","kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseVersion\/CodingKeys\/thumb","abstract":[],"url":"\/documentation\/discogsservice\/components\/schemas\/releaseversion\/codingkeys\/thumb","type":"topic","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"thumb","kind":"identifier"}],"role":"symbol"},"doc://DiscogsService/s28CustomDebugStringConvertibleP":{"type":"unresolvable","identifier":"doc:\/\/DiscogsService\/s28CustomDebugStringConvertibleP","title":"Swift.CustomDebugStringConvertible"}}}
View Git Blame Copy Permalink