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/userid.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
10 KiB
JSON
Raw Blame History

{"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas"]]},"schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"declarations":[{"tokens":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"UserId","kind":"identifier"}],"languages":["swift"],"platforms":["macOS"]}],"kind":"declarations"},{"content":[{"type":"heading","level":2,"anchor":"overview","text":"Overview"},{"name":"Remark","style":"note","type":"aside","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Generated from "},{"type":"codeVoice","code":"#\/components\/schemas\/UserId"},{"type":"text","text":"."}]}]}],"kind":"content"}],"topicSections":[{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/UserId\/init(from:)","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/UserId\/init(id:username:resource_url:)"],"anchor":"Initializers","title":"Initializers","generated":true},{"title":"Instance Properties","generated":true,"anchor":"Instance-Properties","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/UserId\/id","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/UserId\/resource_url","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/UserId\/username"]},{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/UserId\/CodingKeys"],"anchor":"Enumerations","title":"Enumerations","generated":true},{"title":"Default Implementations","generated":true,"anchor":"Default-Implementations","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/UserId\/Equatable-Implementations"]}],"relationshipsSections":[{"identifiers":["doc:\/\/DiscogsService\/Se","doc:\/\/DiscogsService\/SE","doc:\/\/DiscogsService\/SQ","doc:\/\/DiscogsService\/SH","doc:\/\/DiscogsService\/s8SendableP","doc:\/\/DiscogsService\/s16SendableMetatypeP"],"title":"Conforms To","type":"conformsTo","kind":"relationships"}],"sections":[],"metadata":{"navigatorTitle":[{"kind":"identifier","text":"UserId"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"UserId","kind":"identifier"}],"modules":[{"name":"DiscogsService"}],"role":"symbol","symbolKind":"struct","externalID":"s:14DiscogsService10ComponentsO7SchemasO6UserIdV","roleHeading":"Structure","title":"Components.Schemas.UserId"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/UserId"},"kind":"symbol","abstract":[{"text":"A type that references a user.","type":"text"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/discogsservice\/components\/schemas\/userid"]}],"references":{"doc://DiscogsService/SE":{"type":"unresolvable","identifier":"doc:\/\/DiscogsService\/SE","title":"Swift.Encodable"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/UserId":{"url":"\/documentation\/discogsservice\/components\/schemas\/userid","abstract":[{"type":"text","text":"A type that references a user."}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/UserId","kind":"symbol","role":"symbol","type":"topic","title":"Components.Schemas.UserId","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"UserId","kind":"identifier"}],"navigatorTitle":[{"text":"UserId","kind":"identifier"}]},"doc://DiscogsService/SH":{"type":"unresolvable","title":"Swift.Hashable","identifier":"doc:\/\/DiscogsService\/SH"},"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/documentation/DiscogsService/Components/Schemas/UserId/username":{"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"username"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"url":"\/documentation\/discogsservice\/components\/schemas\/userid\/username","role":"symbol","type":"topic","kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/UserId\/username","abstract":[{"type":"text","text":"A username of a user."}],"title":"username"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/UserId/init(id:username:resource_url:)":{"type":"topic","url":"\/documentation\/discogsservice\/components\/schemas\/userid\/init(id:username:resource_url:)","role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/UserId\/init(id:username:resource_url:)","kind":"symbol","title":"init(id:username:resource_url:)","abstract":[{"type":"text","text":"Creates a new "},{"code":"UserId","type":"codeVoice"},{"type":"text","text":"."}],"fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"id","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"username","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"resource_url","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":")","kind":"text"}]},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/UserId/id":{"type":"topic","url":"\/documentation\/discogsservice\/components\/schemas\/userid\/id","role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/UserId\/id","kind":"symbol","title":"id","abstract":[{"type":"text","text":"An identifier of a user."}],"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"id","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"}]},"doc://DiscogsService/documentation/DiscogsService":{"url":"\/documentation\/discogsservice","abstract":[],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService","kind":"symbol","role":"collection","type":"topic","title":"DiscogsService"},"doc://DiscogsService/s8SendableP":{"identifier":"doc:\/\/DiscogsService\/s8SendableP","title":"Swift.Sendable","type":"unresolvable"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/UserId/Equatable-Implementations":{"type":"topic","url":"\/documentation\/discogsservice\/components\/schemas\/userid\/equatable-implementations","role":"collectionGroup","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/UserId\/Equatable-Implementations","kind":"article","title":"Equatable Implementations","abstract":[]},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/UserId/init(from:)":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/UserId\/init(from:)","type":"topic","url":"\/documentation\/discogsservice\/components\/schemas\/userid\/init(from:)","abstract":[],"role":"symbol","kind":"symbol","title":"init(from:)","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"text":": any ","kind":"text"},{"text":"Decoder","kind":"typeIdentifier","preciseIdentifier":"s:s7DecoderP"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"}]},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/UserId/resource_url":{"abstract":[{"type":"text","text":"A URI resource of a user."}],"role":"symbol","type":"topic","title":"resource_url","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"resource_url","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"kind":"symbol","url":"\/documentation\/discogsservice\/components\/schemas\/userid\/resource_url","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/UserId\/resource_url"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/UserId/CodingKeys":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/UserId\/CodingKeys","type":"topic","abstract":[],"url":"\/documentation\/discogsservice\/components\/schemas\/userid\/codingkeys","role":"symbol","kind":"symbol","navigatorTitle":[{"text":"CodingKeys","kind":"identifier"}],"title":"Components.Schemas.UserId.CodingKeys","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CodingKeys","kind":"identifier"}]},"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","identifier":"doc:\/\/DiscogsService\/SQ","title":"Swift.Equatable"},"doc://DiscogsService/Se":{"identifier":"doc:\/\/DiscogsService\/Se","title":"Swift.Decodable","type":"unresolvable"}}}
View Git Blame Copy Permalink