39e9dc5d53
This PR contains the rock done to securize the /GET `/oauth/identity` endpoints on the OpenAPI specification document, plus it also improves the endpoints ordering in the *Database* section. Reviewed-on: #10 Co-authored-by: Javier Cicchelli <javier@rock-n-code.com> Co-committed-by: Javier Cicchelli <javier@rock-n-code.com>
1 line
9.2 KiB
JSON
1 line
9.2 KiB
JSON
{"topicSections":[{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/AuthMethod\/consumer(key:secret:)","doc:\/\/DiscogsService\/documentation\/DiscogsService\/AuthMethod\/none","doc:\/\/DiscogsService\/documentation\/DiscogsService\/AuthMethod\/user(token:)"],"anchor":"Enumeration-Cases","generated":true,"title":"Enumeration Cases"},{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/AuthMethod\/Equatable-Implementations"],"anchor":"Default-Implementations","generated":true,"title":"Default Implementations"}],"relationshipsSections":[{"identifiers":["doc:\/\/DiscogsService\/SQ","doc:\/\/DiscogsService\/s8SendableP","doc:\/\/DiscogsService\/s16SendableMetatypeP"],"type":"conformsTo","title":"Conforms To","kind":"relationships"}],"seeAlsoSections":[{"anchor":"Authentication","title":"Authentication","generated":true,"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"]}]},{"content":[{"level":2,"type":"heading","text":"Overview","anchor":"overview"},{"type":"paragraph","inlineContent":[{"text":"The differences between these authentication methods.","type":"text"}]},{"alignments":["unset","center","center","center"],"type":"table","rows":[[[{"type":"paragraph","inlineContent":[{"text":"Credentials in request","type":"text"}]}],[{"type":"paragraph","inlineContent":[{"text":"Rate limiting?","type":"text"}]}],[{"type":"paragraph","inlineContent":[{"text":"Image URLs?","type":"text"}]}],[{"type":"paragraph","inlineContent":[{"text":"Authenticated as user?","type":"text"}]}]],[[{"type":"paragraph","inlineContent":[{"text":"None","type":"text"}]}],[{"type":"paragraph","inlineContent":[{"text":"🐢 Low tier","type":"text"}]}],[{"type":"paragraph","inlineContent":[{"text":"❌ No","type":"text"}]}],[{"type":"paragraph","inlineContent":[{"text":"❌ No","type":"text"}]}]],[[{"type":"paragraph","inlineContent":[{"text":"Only Consumer key\/secret","type":"text"}]}],[{"type":"paragraph","inlineContent":[{"text":"🐰 High tier","type":"text"}]}],[{"type":"paragraph","inlineContent":[{"text":"✔️ Yes","type":"text"}]}],[{"type":"paragraph","inlineContent":[{"text":"❌ No","type":"text"}]}]],[[{"type":"paragraph","inlineContent":[{"text":"Personal access token","type":"text"}]}],[{"type":"paragraph","inlineContent":[{"text":"🐰 High tier","type":"text"}]}],[{"type":"paragraph","inlineContent":[{"text":"✔️ Yes","type":"text"}]}],[{"type":"paragraph","inlineContent":[{"text":"✔️ Yes, for token holder only 👩","type":"text"}]}]]],"header":"row"},{"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."}]}],"kind":"content"}],"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/AuthMethod","interfaceLanguage":"swift"},"variants":[{"paths":["\/documentation\/discogsservice\/authmethod"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService"]]},"sections":[],"metadata":{"modules":[{"name":"DiscogsService"}],"title":"AuthMethod","roleHeading":"Enumeration","navigatorTitle":[{"text":"AuthMethod","kind":"identifier"}],"symbolKind":"enum","externalID":"s:14DiscogsService10AuthMethodO","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthMethod","kind":"identifier"}],"role":"symbol"},"schemaVersion":{"minor":3,"major":0,"patch":0},"kind":"symbol","abstract":[{"text":"A representation of the available authentication methods at the Discogs service.","type":"text"}],"references":{"doc://DiscogsService/documentation/DiscogsService":{"type":"topic","role":"collection","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService","title":"DiscogsService","abstract":[],"url":"\/documentation\/discogsservice","kind":"symbol"},"doc://DiscogsService/documentation/DiscogsService/AuthMethod/none":{"role":"symbol","type":"topic","abstract":[{"type":"text","text":"No authentication method defined."}],"kind":"symbol","title":"AuthMethod.none","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/AuthMethod\/none","url":"\/documentation\/discogsservice\/authmethod\/none","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"none","kind":"identifier"}]},"doc://DiscogsService/documentation/DiscogsService/AuthMethod/user(token:)":{"kind":"symbol","role":"symbol","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"}],"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"}],"url":"\/documentation\/discogsservice\/authmethod\/user(token:)","type":"topic"},"doc://DiscogsService/documentation/DiscogsService/AuthMethod/consumer(key:secret:)":{"kind":"symbol","role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/AuthMethod\/consumer(key:secret:)","title":"AuthMethod.consumer(key:secret:)","abstract":[{"text":"A consumer key and secret that allows access to endpoints that requires authentication.","type":"text"}],"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"}],"url":"\/documentation\/discogsservice\/authmethod\/consumer(key:secret:)","type":"topic"},"doc://DiscogsService/documentation/DiscogsService/AuthMethod/Equatable-Implementations":{"kind":"article","role":"collectionGroup","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/AuthMethod\/Equatable-Implementations","title":"Equatable Implementations","abstract":[],"url":"\/documentation\/discogsservice\/authmethod\/equatable-implementations","type":"topic"},"doc://DiscogsService/documentation/DiscogsService/AuthMethod":{"title":"AuthMethod","kind":"symbol","abstract":[{"text":"A representation of the available authentication methods at the Discogs service.","type":"text"}],"navigatorTitle":[{"text":"AuthMethod","kind":"identifier"}],"fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthMethod","kind":"identifier"}],"url":"\/documentation\/discogsservice\/authmethod","type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/AuthMethod","role":"symbol"},"doc://DiscogsService/documentation/DiscogsService/AuthTransport":{"kind":"symbol","role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/AuthTransport","title":"AuthTransport","abstract":[{"text":"A representation of the available transport options to send credentials in authenticated requests.","type":"text"}],"fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthTransport","kind":"identifier"}],"navigatorTitle":[{"text":"AuthTransport","kind":"identifier"}],"url":"\/documentation\/discogsservice\/authtransport","type":"topic"},"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","identifier":"https:\/\/www.discogs.com\/developers#page:authentication,header:authentication-discogs-auth-flow","title":"Discogs documentation","titleInlineContent":[{"text":"Discogs documentation","type":"text"}]},"doc://DiscogsService/s8SendableP":{"type":"unresolvable","identifier":"doc:\/\/DiscogsService\/s8SendableP","title":"Swift.Sendable"},"doc://DiscogsService/documentation/DiscogsService/AuthMiddleware":{"kind":"symbol","role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/AuthMiddleware","title":"AuthMiddleware","abstract":[{"text":"A middleware that attaches any defined authentication credentials into the requests to the service.","type":"text"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthMiddleware","kind":"identifier"}],"navigatorTitle":[{"text":"AuthMiddleware","kind":"identifier"}],"url":"\/documentation\/discogsservice\/authmiddleware","type":"topic"},"doc://DiscogsService/s16SendableMetatypeP":{"type":"unresolvable","identifier":"doc:\/\/DiscogsService\/s16SendableMetatypeP","title":"Swift.SendableMetatype"},"doc://DiscogsService/SQ":{"type":"unresolvable","identifier":"doc:\/\/DiscogsService\/SQ","title":"Swift.Equatable"}}} |