2a7b9746a7
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>
1 line
6.4 KiB
JSON
1 line
6.4 KiB
JSON
{"sections":[],"primaryContentSections":[{"declarations":[{"platforms":["macOS"],"tokens":[{"kind":"keyword","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"method"},{"kind":"text","text":": "},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/AuthMethod","preciseIdentifier":"s:14DiscogsService10AuthMethodO","kind":"typeIdentifier","text":"AuthMethod"},{"kind":"text","text":" = .none, "},{"kind":"externalParam","text":"transport"},{"kind":"text","text":": "},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/AuthTransport","preciseIdentifier":"s:14DiscogsService13AuthTransportO","kind":"typeIdentifier","text":"AuthTransport"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"languages":["swift"]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"name":"method","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"A representation of an authentication method to use to authenticate requests."}]}]},{"name":"transport","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"A representation of a transport option to send credentials in requests."}]}]}]},{"content":[{"type":"heading","anchor":"discussion","level":2,"text":"Discussion"},{"type":"aside","style":"note","name":"Throws","content":[{"type":"paragraph","inlineContent":[{"text":"An error of type ","type":"text"},{"type":"reference","isActive":true,"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/InputValidationError"},{"text":" in case an input failed any validation.","type":"text"}]}]}],"kind":"content"}],"kind":"symbol","metadata":{"fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"method"},{"kind":"text","text":": "},{"preciseIdentifier":"s:14DiscogsService10AuthMethodO","kind":"typeIdentifier","text":"AuthMethod"},{"kind":"text","text":", "},{"kind":"externalParam","text":"transport"},{"kind":"text","text":": "},{"preciseIdentifier":"s:14DiscogsService13AuthTransportO","kind":"typeIdentifier","text":"AuthTransport"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"role":"symbol","title":"init(method:transport:)","symbolKind":"init","externalID":"s:14DiscogsService14AuthMiddlewareV6method9transportAcA0C6MethodO_AA0C9TransportOtKcfc","roleHeading":"Initializer","modules":[{"name":"DiscogsService"}]},"abstract":[{"text":"Initializes this middleware.","type":"text"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/AuthMiddleware\/init(method:transport:)"},"schemaVersion":{"major":0,"patch":0,"minor":3},"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/AuthMiddleware"]]},"variants":[{"paths":["\/documentation\/discogsservice\/authmiddleware\/init(method:transport:)"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"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/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/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/AuthMiddleware/init(method:transport:)":{"fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"method","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"AuthMethod","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10AuthMethodO"},{"text":", ","kind":"text"},{"text":"transport","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"AuthTransport","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService13AuthTransportO"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"}],"type":"topic","kind":"symbol","role":"symbol","title":"init(method:transport:)","abstract":[{"type":"text","text":"Initializes this middleware."}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/AuthMiddleware\/init(method:transport:)","url":"\/documentation\/discogsservice\/authmiddleware\/init(method:transport:)"},"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"}]}}} |