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

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