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

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