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