Files
discogs-service/docs/data/documentation/discogsservice/components/schemas/community/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
14 KiB
JSON

{"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Community"]]},"schemaVersion":{"minor":3,"patch":0,"major":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["macOS"],"tokens":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CodingKeys","kind":"identifier"}],"languages":["swift"]}]}],"topicSections":[{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Community\/CodingKeys\/contributors","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Community\/CodingKeys\/data_quality","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Community\/CodingKeys\/have","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Community\/CodingKeys\/rating","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Community\/CodingKeys\/status","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Community\/CodingKeys\/submitter","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Community\/CodingKeys\/want"],"anchor":"Enumeration-Cases","title":"Enumeration Cases","generated":true},{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Community\/CodingKeys\/init(intValue:)","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Community\/CodingKeys\/init(rawValue:)","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Community\/CodingKeys\/init(stringValue:)"],"anchor":"Initializers","title":"Initializers","generated":true},{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Community\/CodingKeys\/CodingKey-Implementations","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Community\/CodingKeys\/Equatable-Implementations","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Community\/CodingKeys\/RawRepresentable-Implementations"],"anchor":"Default-Implementations","title":"Default Implementations","generated":true}],"relationshipsSections":[{"kind":"relationships","title":"Conforms To","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"]}],"metadata":{"navigatorTitle":[{"text":"CodingKeys","kind":"identifier"}],"fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CodingKeys","kind":"identifier"}],"modules":[{"name":"DiscogsService"}],"role":"symbol","symbolKind":"enum","externalID":"s:14DiscogsService10ComponentsO7SchemasO9CommunityV10CodingKeysO","roleHeading":"Enumeration","title":"Components.Schemas.Community.CodingKeys"},"kind":"symbol","identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Community\/CodingKeys","interfaceLanguage":"swift"},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/discogsservice\/components\/schemas\/community\/codingkeys"]}],"references":{"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Community/CodingKeys/init(stringValue:)":{"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":")"}],"url":"\/documentation\/discogsservice\/components\/schemas\/community\/codingkeys\/init(stringvalue:)","role":"symbol","type":"topic","kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Community\/CodingKeys\/init(stringValue:)","abstract":[],"title":"init(stringValue:)"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Community/CodingKeys/CodingKey-Implementations":{"url":"\/documentation\/discogsservice\/components\/schemas\/community\/codingkeys\/codingkey-implementations","role":"collectionGroup","type":"topic","kind":"article","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Community\/CodingKeys\/CodingKey-Implementations","abstract":[],"title":"CodingKey Implementations"},"doc://DiscogsService/s9CodingKeyP":{"type":"unresolvable","title":"Swift.CodingKey","identifier":"doc:\/\/DiscogsService\/s9CodingKeyP"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Community/CodingKeys/RawRepresentable-Implementations":{"url":"\/documentation\/discogsservice\/components\/schemas\/community\/codingkeys\/rawrepresentable-implementations","role":"collectionGroup","type":"topic","kind":"article","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Community\/CodingKeys\/RawRepresentable-Implementations","abstract":[],"title":"RawRepresentable Implementations"},"doc://DiscogsService/SH":{"type":"unresolvable","title":"Swift.Hashable","identifier":"doc:\/\/DiscogsService\/SH"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Community/CodingKeys/rating":{"fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"rating"}],"url":"\/documentation\/discogsservice\/components\/schemas\/community\/codingkeys\/rating","role":"symbol","type":"topic","kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Community\/CodingKeys\/rating","abstract":[],"title":"Components.Schemas.Community.CodingKeys.rating"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Community/CodingKeys/init(rawValue:)":{"fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"?("},{"kind":"externalParam","text":"rawValue"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":")"}],"url":"\/documentation\/discogsservice\/components\/schemas\/community\/codingkeys\/init(rawvalue:)","role":"symbol","type":"topic","kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Community\/CodingKeys\/init(rawValue:)","abstract":[],"title":"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/documentation/DiscogsService/Components/Schemas/Community/CodingKeys/data_quality":{"fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"data_quality"}],"url":"\/documentation\/discogsservice\/components\/schemas\/community\/codingkeys\/data_quality","role":"symbol","type":"topic","kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Community\/CodingKeys\/data_quality","abstract":[],"title":"Components.Schemas.Community.CodingKeys.data_quality"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Community/CodingKeys/contributors":{"fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"contributors"}],"url":"\/documentation\/discogsservice\/components\/schemas\/community\/codingkeys\/contributors","role":"symbol","type":"topic","kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Community\/CodingKeys\/contributors","abstract":[],"title":"Components.Schemas.Community.CodingKeys.contributors"},"doc://DiscogsService/s23CustomStringConvertibleP":{"type":"unresolvable","title":"Swift.CustomStringConvertible","identifier":"doc:\/\/DiscogsService\/s23CustomStringConvertibleP"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Community/CodingKeys/init(intValue:)":{"fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"?("},{"kind":"externalParam","text":"intValue"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"},{"kind":"text","text":")"}],"url":"\/documentation\/discogsservice\/components\/schemas\/community\/codingkeys\/init(intvalue:)","role":"symbol","type":"topic","kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Community\/CodingKeys\/init(intValue:)","abstract":[],"title":"init(intValue:)"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Community/CodingKeys":{"navigatorTitle":[{"kind":"identifier","text":"CodingKeys"}],"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"CodingKeys"}],"url":"\/documentation\/discogsservice\/components\/schemas\/community\/codingkeys","role":"symbol","type":"topic","kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Community\/CodingKeys","abstract":[],"title":"Components.Schemas.Community.CodingKeys"},"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":{"type":"unresolvable","title":"Swift.Equatable","identifier":"doc:\/\/DiscogsService\/SQ"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Community/CodingKeys/status":{"fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"status"}],"url":"\/documentation\/discogsservice\/components\/schemas\/community\/codingkeys\/status","role":"symbol","type":"topic","kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Community\/CodingKeys\/status","abstract":[],"title":"Components.Schemas.Community.CodingKeys.status"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Community":{"navigatorTitle":[{"kind":"identifier","text":"Community"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Community"}],"url":"\/documentation\/discogsservice\/components\/schemas\/community","role":"symbol","type":"topic","kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Community","abstract":[{"type":"text","text":"A type that represents a community of users, in relationship to a release."}],"title":"Components.Schemas.Community"},"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/Community/CodingKeys/have":{"fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"have"}],"url":"\/documentation\/discogsservice\/components\/schemas\/community\/codingkeys\/have","role":"symbol","type":"topic","kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Community\/CodingKeys\/have","abstract":[],"title":"Components.Schemas.Community.CodingKeys.have"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Community/CodingKeys/Equatable-Implementations":{"url":"\/documentation\/discogsservice\/components\/schemas\/community\/codingkeys\/equatable-implementations","role":"collectionGroup","type":"topic","kind":"article","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Community\/CodingKeys\/Equatable-Implementations","abstract":[],"title":"Equatable Implementations"},"doc://DiscogsService/s16SendableMetatypeP":{"type":"unresolvable","identifier":"doc:\/\/DiscogsService\/s16SendableMetatypeP","title":"Swift.SendableMetatype"},"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/documentation/DiscogsService/Components/Schemas/Community/CodingKeys/want":{"url":"\/documentation\/discogsservice\/components\/schemas\/community\/codingkeys\/want","abstract":[],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Community\/CodingKeys\/want","kind":"symbol","role":"symbol","type":"topic","title":"Components.Schemas.Community.CodingKeys.want","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"want","kind":"identifier"}]},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Community/CodingKeys/submitter":{"url":"\/documentation\/discogsservice\/components\/schemas\/community\/codingkeys\/submitter","abstract":[],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Community\/CodingKeys\/submitter","kind":"symbol","role":"symbol","title":"Components.Schemas.Community.CodingKeys.submitter","type":"topic","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"submitter","kind":"identifier"}]},"doc://DiscogsService/s28CustomDebugStringConvertibleP":{"type":"unresolvable","identifier":"doc:\/\/DiscogsService\/s28CustomDebugStringConvertibleP","title":"Swift.CustomDebugStringConvertible"}}}