rock-n-code/discogs-service
1
0
Fork 0
Code Pull Requests Releases 8 Activity
Files
de5b4ff5d0506f8354e28ef31060eb09f754aece
discogs-service/docs/data/documentation/discogsservice/authmethod.json
T
javier de5b4ff5d0 Implemented the missing Database endpoints (#8) 
This PR contains the work done to declare the missing, non-GET endpoints of the *Database* section in the [Discogs API documentation](https://www.discogs.com/developers#page:database) into the `OpenAPI` specification document.

Furthermore, documentation extensions have been defined for the `APIProtocol` and `Client` types in the `DocC` documentation catalog to match the categories of these endpoint calls to the categories in the Discogs documentation.

Reviewed-on: #8
Co-authored-by: Javier Cicchelli <javier@rock-n-code.com>
Co-committed-by: Javier Cicchelli <javier@rock-n-code.com>
2025-10-13 15:20:20 +00:00

1 line
9.2 KiB
JSON
Raw Blame History

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