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/pagination/urlspayload/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
Raw Blame History

{"schemaVersion":{"minor":3,"patch":0,"major":0},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/discogsservice\/components\/schemas\/pagination\/urlspayload\/codingkeys"]}],"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Pagination","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Pagination\/urlsPayload"]]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Pagination\/urlsPayload\/CodingKeys"},"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"},{"text":" ","kind":"text"},{"kind":"identifier","text":"CodingKeys"}]}],"kind":"declarations"}],"sections":[],"topicSections":[{"title":"Enumeration Cases","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Pagination\/urlsPayload\/CodingKeys\/first","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Pagination\/urlsPayload\/CodingKeys\/last","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Pagination\/urlsPayload\/CodingKeys\/next","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Pagination\/urlsPayload\/CodingKeys\/prev"],"anchor":"Enumeration-Cases","generated":true},{"anchor":"Initializers","title":"Initializers","generated":true,"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Pagination\/urlsPayload\/CodingKeys\/init(intValue:)","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Pagination\/urlsPayload\/CodingKeys\/init(rawValue:)","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Pagination\/urlsPayload\/CodingKeys\/init(stringValue:)"]},{"anchor":"Default-Implementations","title":"Default Implementations","generated":true,"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Pagination\/urlsPayload\/CodingKeys\/CodingKey-Implementations","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Pagination\/urlsPayload\/CodingKeys\/Equatable-Implementations","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Pagination\/urlsPayload\/CodingKeys\/RawRepresentable-Implementations"]}],"metadata":{"navigatorTitle":[{"kind":"identifier","text":"CodingKeys"}],"role":"symbol","title":"Components.Schemas.Pagination.urlsPayload.CodingKeys","roleHeading":"Enumeration","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"CodingKeys"}],"externalID":"s:14DiscogsService10ComponentsO7SchemasO10PaginationV11urlsPayloadV10CodingKeysO","symbolKind":"enum","modules":[{"name":"DiscogsService"}]},"references":{"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Pagination":{"navigatorTitle":[{"kind":"identifier","text":"Pagination"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Pagination"}],"url":"\/documentation\/discogsservice\/components\/schemas\/pagination","role":"symbol","type":"topic","kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Pagination","abstract":[{"type":"text","text":"A type that provides details about a paginated result."}],"title":"Components.Schemas.Pagination"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Pagination/urlsPayload/CodingKeys/last":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Pagination\/urlsPayload\/CodingKeys\/last","type":"topic","url":"\/documentation\/discogsservice\/components\/schemas\/pagination\/urlspayload\/codingkeys\/last","abstract":[],"role":"symbol","kind":"symbol","title":"Components.Schemas.Pagination.urlsPayload.CodingKeys.last","fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"last"}]},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Pagination/urlsPayload":{"navigatorTitle":[{"kind":"identifier","text":"urlsPayload"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"urlsPayload"}],"url":"\/documentation\/discogsservice\/components\/schemas\/pagination\/urlspayload","role":"symbol","type":"topic","kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Pagination\/urlsPayload","abstract":[{"type":"text","text":"A collection of URLs to navigate through the pages in a result."}],"title":"Components.Schemas.Pagination.urlsPayload"},"doc://DiscogsService/SY":{"type":"unresolvable","identifier":"doc:\/\/DiscogsService\/SY","title":"Swift.RawRepresentable"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Pagination/urlsPayload/CodingKeys/init(stringValue:)":{"fragments":[{"text":"init","kind":"identifier"},{"text":"?(","kind":"text"},{"text":"stringValue","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":")","kind":"text"}],"url":"\/documentation\/discogsservice\/components\/schemas\/pagination\/urlspayload\/codingkeys\/init(stringvalue:)","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Pagination\/urlsPayload\/CodingKeys\/init(stringValue:)","title":"init(stringValue:)","kind":"symbol","role":"symbol","type":"topic","abstract":[]},"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/Pagination/urlsPayload/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\/pagination\/urlspayload\/codingkeys\/init(intvalue:)","role":"symbol","type":"topic","kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Pagination\/urlsPayload\/CodingKeys\/init(intValue:)","abstract":[],"title":"init(intValue:)"},"doc://DiscogsService/s23CustomStringConvertibleP":{"type":"unresolvable","identifier":"doc:\/\/DiscogsService\/s23CustomStringConvertibleP","title":"Swift.CustomStringConvertible"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Pagination/urlsPayload/CodingKeys":{"fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CodingKeys","kind":"identifier"}],"type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Pagination\/urlsPayload\/CodingKeys","navigatorTitle":[{"text":"CodingKeys","kind":"identifier"}],"title":"Components.Schemas.Pagination.urlsPayload.CodingKeys","role":"symbol","abstract":[],"kind":"symbol","url":"\/documentation\/discogsservice\/components\/schemas\/pagination\/urlspayload\/codingkeys"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Pagination/urlsPayload/CodingKeys/RawRepresentable-Implementations":{"url":"\/documentation\/discogsservice\/components\/schemas\/pagination\/urlspayload\/codingkeys\/rawrepresentable-implementations","role":"collectionGroup","type":"topic","kind":"article","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Pagination\/urlsPayload\/CodingKeys\/RawRepresentable-Implementations","abstract":[],"title":"RawRepresentable Implementations"},"doc://DiscogsService/s28CustomDebugStringConvertibleP":{"type":"unresolvable","identifier":"doc:\/\/DiscogsService\/s28CustomDebugStringConvertibleP","title":"Swift.CustomDebugStringConvertible"},"doc://DiscogsService/SH":{"title":"Swift.Hashable","type":"unresolvable","identifier":"doc:\/\/DiscogsService\/SH"},"doc://DiscogsService/SQ":{"title":"Swift.Equatable","type":"unresolvable","identifier":"doc:\/\/DiscogsService\/SQ"},"doc://DiscogsService/s8SendableP":{"identifier":"doc:\/\/DiscogsService\/s8SendableP","title":"Swift.Sendable","type":"unresolvable"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Pagination/urlsPayload/CodingKeys/first":{"url":"\/documentation\/discogsservice\/components\/schemas\/pagination\/urlspayload\/codingkeys\/first","abstract":[],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Pagination\/urlsPayload\/CodingKeys\/first","kind":"symbol","role":"symbol","title":"Components.Schemas.Pagination.urlsPayload.CodingKeys.first","type":"topic","fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"first"}]},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Pagination/urlsPayload/CodingKeys/prev":{"title":"Components.Schemas.Pagination.urlsPayload.CodingKeys.prev","type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Pagination\/urlsPayload\/CodingKeys\/prev","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"prev","kind":"identifier"}],"kind":"symbol","abstract":[],"role":"symbol","url":"\/documentation\/discogsservice\/components\/schemas\/pagination\/urlspayload\/codingkeys\/prev"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Pagination/urlsPayload/CodingKeys/Equatable-Implementations":{"url":"\/documentation\/discogsservice\/components\/schemas\/pagination\/urlspayload\/codingkeys\/equatable-implementations","abstract":[],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Pagination\/urlsPayload\/CodingKeys\/Equatable-Implementations","kind":"article","role":"collectionGroup","title":"Equatable Implementations","type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Pagination/urlsPayload/CodingKeys/init(rawValue:)":{"url":"\/documentation\/discogsservice\/components\/schemas\/pagination\/urlspayload\/codingkeys\/init(rawvalue:)","abstract":[],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Pagination\/urlsPayload\/CodingKeys\/init(rawValue:)","kind":"symbol","role":"symbol","type":"topic","title":"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":")"}]},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Pagination/urlsPayload/CodingKeys/CodingKey-Implementations":{"url":"\/documentation\/discogsservice\/components\/schemas\/pagination\/urlspayload\/codingkeys\/codingkey-implementations","role":"collectionGroup","type":"topic","kind":"article","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Pagination\/urlsPayload\/CodingKeys\/CodingKey-Implementations","abstract":[],"title":"CodingKey Implementations"},"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":{"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/Pagination/urlsPayload/CodingKeys/next":{"type":"topic","abstract":[],"title":"Components.Schemas.Pagination.urlsPayload.CodingKeys.next","url":"\/documentation\/discogsservice\/components\/schemas\/pagination\/urlspayload\/codingkeys\/next","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"next","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Pagination\/urlsPayload\/CodingKeys\/next","role":"symbol","kind":"symbol"},"doc://DiscogsService/s16SendableMetatypeP":{"title":"Swift.SendableMetatype","type":"unresolvable","identifier":"doc:\/\/DiscogsService\/s16SendableMetatypeP"},"doc://DiscogsService/s9CodingKeyP":{"title":"Swift.CodingKey","type":"unresolvable","identifier":"doc:\/\/DiscogsService\/s9CodingKeyP"}}}
View Git Blame Copy Permalink