Files
discogs-service/docs/data/documentation/discogsservice.json
T
javier 2a7b9746a7 Implemented the User Collection endpoints (#12)
This PR contains the work done to implement the *User Collection* endpoints of the Discogs API into the `OpenAPI` specification document:

* GET `/users/{username}/collection/folders`
* POST `/users/{username}/collection/folders`
* GET `/users/{username}/collection/folders/{folder_id}`
* POST `/users/{username}/collection/folders/{folder_id}`
* DELETE `/users/{username}/collection/folders/{folder_id}`
* GET `/users/{username}/collection/releases/{release_id}`
* GET `/users/{username}/collection/folders/{folder_id}/releases`
* POST `/users/{username}/collection/folders/{folder_id}/releases/{release_id}`
* POST `/users/{username}/collection/folders/{folder_id}/releases/{release_id}/instances/{instance_id}`
* DELETE `/users/{username}/collection/folders/{folder_id}/releases/{release_id}/instances/{instance_id}`
* GET `/users/{username}/collection/fields`
* POST `/users/{username}/collection/folders/{folder_id}/releases/{release_id}/instances/{instance_id}/fields/{field_id}`
* GET `/users/{username}/collection/value`

Reviewed-on: #12
Co-authored-by: Javier Cicchelli <javier@rock-n-code.com>
Co-committed-by: Javier Cicchelli <javier@rock-n-code.com>
2025-10-16 14:38:41 +00:00

1 line
9.7 KiB
JSON

{"metadata":{"roleHeading":"Framework","modules":[{"name":"DiscogsService"}],"title":"DiscogsService","externalID":"DiscogsService","symbolKind":"module","role":"collection"},"topicSections":[{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client"],"anchor":"Clients","title":"Clients"},{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/LiveService"],"anchor":"Servers","title":"Servers"},{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/AuthMiddleware","doc:\/\/DiscogsService\/documentation\/DiscogsService\/AuthMethod","doc:\/\/DiscogsService\/documentation\/DiscogsService\/AuthTransport"],"anchor":"Authentication","title":"Authentication"},{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/UserAgentMiddleware","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Product"],"anchor":"User-Agent","title":"User Agent"},{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Servers"],"anchor":"Types","title":"Types"},{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/InputValidationError"],"anchor":"Errors","title":"Errors"},{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/APIProtocol"],"anchor":"Protocols","title":"Protocols"}],"primaryContentSections":[{"content":[{"level":2,"type":"heading","text":"Overview","anchor":"Overview"}],"kind":"content"}],"hierarchy":{"paths":[[]]},"schemaVersion":{"patch":0,"minor":3,"major":0},"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/DiscogsService\/documentation\/DiscogsService"},"kind":"symbol","variants":[{"paths":["\/documentation\/discogsservice"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://DiscogsService/documentation/DiscogsService/APIProtocol":{"fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"APIProtocol","kind":"identifier"}],"title":"APIProtocol","abstract":[{"type":"text","text":"A type that performs HTTP operations defined by the OpenAPI document."}],"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/APIProtocol","role":"symbol","navigatorTitle":[{"text":"APIProtocol","kind":"identifier"}],"type":"topic","url":"\/documentation\/discogsservice\/apiprotocol"},"doc://DiscogsService/documentation/DiscogsService/AuthMiddleware":{"url":"\/documentation\/discogsservice\/authmiddleware","navigatorTitle":[{"text":"AuthMiddleware","kind":"identifier"}],"abstract":[{"type":"text","text":"A middleware that attaches any defined authentication credentials into the requests to the service."}],"kind":"symbol","type":"topic","title":"AuthMiddleware","role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/AuthMiddleware","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthMiddleware","kind":"identifier"}]},"doc://DiscogsService/documentation/DiscogsService/Operations":{"abstract":[{"type":"text","text":"API operations, with input and output types, generated from "},{"code":"#\/paths","type":"codeVoice"},{"text":" in the OpenAPI document.","type":"text"}],"title":"Operations","fragments":[{"text":"enum","kind":"keyword"},{"kind":"text","text":" "},{"text":"Operations","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","url":"\/documentation\/discogsservice\/operations","navigatorTitle":[{"text":"Operations","kind":"identifier"}],"type":"topic","kind":"symbol"},"doc://DiscogsService/documentation/DiscogsService/LiveService":{"navigatorTitle":[{"kind":"identifier","text":"LiveService"}],"type":"topic","title":"LiveService","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/LiveService","url":"\/documentation\/discogsservice\/liveservice","fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"LiveService"}],"kind":"symbol","role":"symbol","abstract":[{"type":"text","text":"A reference to a live (or production) service defined in the OpenAPI document."}]},"doc://DiscogsService/documentation/DiscogsService/AuthTransport":{"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthTransport"}],"title":"AuthTransport","abstract":[{"type":"text","text":"A representation of the available transport options to send credentials in authenticated requests."}],"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/AuthTransport","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"AuthTransport"}],"type":"topic","url":"\/documentation\/discogsservice\/authtransport"},"doc://DiscogsService/documentation/DiscogsService/Components":{"abstract":[{"text":"Types generated from the components section of the OpenAPI document.","type":"text"}],"title":"Components","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Components"}],"role":"symbol","url":"\/documentation\/discogsservice\/components","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","navigatorTitle":[{"kind":"identifier","text":"Components"}],"type":"topic","kind":"symbol"},"doc://DiscogsService/documentation/DiscogsService/UserAgentMiddleware":{"navigatorTitle":[{"kind":"identifier","text":"UserAgentMiddleware"}],"type":"topic","title":"UserAgentMiddleware","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/UserAgentMiddleware","url":"\/documentation\/discogsservice\/useragentmiddleware","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"UserAgentMiddleware"}],"kind":"symbol","role":"symbol","abstract":[{"type":"text","text":"A middleware that attaches the user agent header into the requests to the service."}]},"doc://DiscogsService/documentation/DiscogsService/AuthMethod":{"title":"AuthMethod","abstract":[{"type":"text","text":"A representation of the available authentication methods at the Discogs service."}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/AuthMethod","navigatorTitle":[{"text":"AuthMethod","kind":"identifier"}],"role":"symbol","type":"topic","url":"\/documentation\/discogsservice\/authmethod","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthMethod","kind":"identifier"}],"kind":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Servers":{"navigatorTitle":[{"text":"Servers","kind":"identifier"}],"kind":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Servers","kind":"identifier"}],"type":"topic","url":"\/documentation\/discogsservice\/servers","title":"Servers","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Servers","abstract":[{"text":"Server URLs defined in the OpenAPI document.","type":"text"}],"role":"symbol"},"doc://DiscogsService/documentation/DiscogsService":{"url":"\/documentation\/discogsservice","abstract":[],"kind":"symbol","type":"topic","title":"DiscogsService","role":"collection","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService"},"doc://DiscogsService/documentation/DiscogsService/InputValidationError":{"url":"\/documentation\/discogsservice\/inputvalidationerror","navigatorTitle":[{"kind":"identifier","text":"InputValidationError"}],"type":"topic","abstract":[{"type":"text","text":"A representation of all the possible validation error that could be thrown while validating an input."}],"kind":"symbol","title":"InputValidationError","role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/InputValidationError","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"InputValidationError"}]},"doc://DiscogsService/documentation/DiscogsService/Product":{"navigatorTitle":[{"kind":"identifier","text":"Product"}],"type":"topic","title":"Product","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Product","url":"\/documentation\/discogsservice\/product","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Product"}],"kind":"symbol","role":"symbol","abstract":[{"type":"text","text":"A type that represents a product that uses the "},{"isActive":true,"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client","type":"reference"},{"type":"text","text":" client."}]},"doc://DiscogsService/documentation/DiscogsService/Client":{"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Client"}],"title":"Client","abstract":[{"text":"The Discogs API v2.0 is a RESTful interface to Discogs data. You can access JSON-formatted information about Database objects such as ","type":"text"},{"inlineContent":[{"text":"Artists","type":"text"}],"type":"emphasis"},{"text":", ","type":"text"},{"inlineContent":[{"text":"Releases","type":"text"}],"type":"emphasis"},{"text":", and ","type":"text"},{"inlineContent":[{"text":"Labels","type":"text"}],"type":"emphasis"},{"text":". Your application can also manage ","type":"text"},{"inlineContent":[{"text":"User Collections","type":"text"}],"type":"emphasis"},{"text":" and ","type":"text"},{"inlineContent":[{"text":"Wantlists","type":"text"}],"type":"emphasis"},{"text":", create ","type":"text"},{"inlineContent":[{"text":"Marketplace","type":"text"}],"type":"emphasis"},{"text":" listings, and more.","type":"text"}],"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Client"}],"type":"topic","url":"\/documentation\/discogsservice\/client"}}}