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