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

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