Files
discogs-service/docs/data/documentation/discogsservice/authmethod.json
T
javier 9a30b69561 Implemented the Authentication endpoints (#9)
This PR contains the work done to implement the *Authentication* endpoints of the Discogs API:
* GET `/oauth/request_token`
* POST `/oauth/access_token`
* GET `/oauth/identity`

Reviewed-on: #9
Co-authored-by: Javier Cicchelli <javier@rock-n-code.com>
Co-committed-by: Javier Cicchelli <javier@rock-n-code.com>
2025-10-13 17:55:48 +00:00

1 line
9.2 KiB
JSON

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