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/track/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

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