rock-n-code/discogs-service
1
0
Fork 0
Code Pull Requests Releases 8 Activity
Files
2a7b9746a774ba216578062531d65ae32a4f53b6
discogs-service/docs/data/documentation/discogsservice/authmethod.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.2 KiB
JSON
Raw Blame History

{"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthMethod","kind":"identifier"}],"platforms":["macOS"]}]},{"kind":"content","content":[{"type":"heading","level":2,"anchor":"overview","text":"Overview"},{"type":"paragraph","inlineContent":[{"text":"The differences between these authentication methods.","type":"text"}]},{"type":"table","alignments":["unset","center","center","center"],"header":"row","rows":[[[{"inlineContent":[{"type":"text","text":"Credentials in request"}],"type":"paragraph"}],[{"inlineContent":[{"text":"Rate limiting?","type":"text"}],"type":"paragraph"}],[{"inlineContent":[{"type":"text","text":"Image URLs?"}],"type":"paragraph"}],[{"inlineContent":[{"text":"Authenticated as user?","type":"text"}],"type":"paragraph"}]],[[{"inlineContent":[{"type":"text","text":"None"}],"type":"paragraph"}],[{"inlineContent":[{"text":"🐢 Low tier","type":"text"}],"type":"paragraph"}],[{"inlineContent":[{"type":"text","text":"❌ No"}],"type":"paragraph"}],[{"inlineContent":[{"text":"❌ No","type":"text"}],"type":"paragraph"}]],[[{"inlineContent":[{"type":"text","text":"Only Consumer key\/secret"}],"type":"paragraph"}],[{"inlineContent":[{"text":"🐰 High tier","type":"text"}],"type":"paragraph"}],[{"inlineContent":[{"type":"text","text":"✔️ Yes"}],"type":"paragraph"}],[{"inlineContent":[{"text":"❌ No","type":"text"}],"type":"paragraph"}]],[[{"inlineContent":[{"type":"text","text":"Personal access token"}],"type":"paragraph"}],[{"inlineContent":[{"text":"🐰 High tier","type":"text"}],"type":"paragraph"}],[{"inlineContent":[{"type":"text","text":"✔️ Yes"}],"type":"paragraph"}],[{"inlineContent":[{"text":"✔️ Yes, for token holder only 👩","type":"text"}],"type":"paragraph"}]]]},{"inlineContent":[{"type":"text","text":"Please refer to the "},{"isActive":true,"identifier":"https:\/\/www.discogs.com\/developers#page:authentication,header:authentication-discogs-auth-flow","type":"reference"},{"type":"text","text":" for further details."}],"type":"paragraph"}]}],"metadata":{"modules":[{"name":"DiscogsService"}],"title":"AuthMethod","externalID":"s:14DiscogsService10AuthMethodO","symbolKind":"enum","role":"symbol","roleHeading":"Enumeration","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AuthMethod"}],"navigatorTitle":[{"text":"AuthMethod","kind":"identifier"}]},"variants":[{"paths":["\/documentation\/discogsservice\/authmethod"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","relationshipsSections":[{"kind":"relationships","title":"Conforms To","type":"conformsTo","identifiers":["doc:\/\/DiscogsService\/SQ","doc:\/\/DiscogsService\/s8SendableP","doc:\/\/DiscogsService\/s16SendableMetatypeP"]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"seeAlsoSections":[{"generated":true,"anchor":"Authentication","title":"Authentication","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/AuthMiddleware","doc:\/\/DiscogsService\/documentation\/DiscogsService\/AuthTransport"]}],"topicSections":[{"generated":true,"anchor":"Enumeration-Cases","title":"Enumeration Cases","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/AuthMethod\/consumer(key:secret:)","doc:\/\/DiscogsService\/documentation\/DiscogsService\/AuthMethod\/none","doc:\/\/DiscogsService\/documentation\/DiscogsService\/AuthMethod\/user(token:)"]},{"generated":true,"anchor":"Default-Implementations","title":"Default Implementations","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/AuthMethod\/Equatable-Implementations"]}],"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService"]]},"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/AuthMethod","interfaceLanguage":"swift"},"sections":[],"abstract":[{"text":"A representation of the available authentication methods at the Discogs service.","type":"text"}],"references":{"doc://DiscogsService/documentation/DiscogsService/AuthMethod/Equatable-Implementations":{"kind":"article","type":"topic","url":"\/documentation\/discogsservice\/authmethod\/equatable-implementations","title":"Equatable Implementations","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/AuthMethod\/Equatable-Implementations","abstract":[],"role":"collectionGroup"},"doc://DiscogsService/documentation/DiscogsService/AuthMethod/none":{"role":"symbol","type":"topic","url":"\/documentation\/discogsservice\/authmethod\/none","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/AuthMethod\/none","abstract":[{"type":"text","text":"No authentication method defined."}],"title":"AuthMethod.none","kind":"symbol","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"none","kind":"identifier"}]},"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/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":{"url":"\/documentation\/discogsservice","abstract":[],"kind":"symbol","type":"topic","title":"DiscogsService","role":"collection","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService"},"doc://DiscogsService/SQ":{"title":"Swift.Equatable","identifier":"doc:\/\/DiscogsService\/SQ","type":"unresolvable"},"https://www.discogs.com/developers#page:authentication,header:authentication-discogs-auth-flow":{"title":"Discogs documentation","identifier":"https:\/\/www.discogs.com\/developers#page:authentication,header:authentication-discogs-auth-flow","titleInlineContent":[{"type":"text","text":"Discogs documentation"}],"type":"link","url":"https:\/\/www.discogs.com\/developers#page:authentication,header:authentication-discogs-auth-flow"},"doc://DiscogsService/s8SendableP":{"title":"Swift.Sendable","identifier":"doc:\/\/DiscogsService\/s8SendableP","type":"unresolvable"},"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/AuthMethod/user(token:)":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/AuthMethod\/user(token:)","title":"AuthMethod.user(token:)","abstract":[{"text":"A user token that allows access to its own account information.","type":"text"}],"role":"symbol","type":"topic","url":"\/documentation\/discogsservice\/authmethod\/user(token:)","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"user","kind":"identifier"},{"text":"(","kind":"text"},{"text":"token","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":")","kind":"text"}],"kind":"symbol"},"doc://DiscogsService/s16SendableMetatypeP":{"title":"Swift.SendableMetatype","identifier":"doc:\/\/DiscogsService\/s16SendableMetatypeP","type":"unresolvable"},"doc://DiscogsService/documentation/DiscogsService/AuthMethod/consumer(key:secret:)":{"url":"\/documentation\/discogsservice\/authmethod\/consumer(key:secret:)","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"consumer","kind":"identifier"},{"text":"(","kind":"text"},{"text":"key","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"secret","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":")","kind":"text"}],"kind":"symbol","title":"AuthMethod.consumer(key:secret:)","type":"topic","abstract":[{"text":"A consumer key and secret that allows access to endpoints that requires authentication.","type":"text"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/AuthMethod\/consumer(key:secret:)","role":"symbol"}}}
View Git Blame Copy Permalink