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
13 KiB
JSON
1 line
13 KiB
JSON
{"primaryContentSections":[{"declarations":[{"platforms":["macOS"],"tokens":[{"kind":"keyword","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"have"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Si","kind":"typeIdentifier","text":"Int"},{"kind":"text","text":", "},{"kind":"externalParam","text":"want"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Si","kind":"typeIdentifier","text":"Int"},{"kind":"text","text":", "},{"kind":"externalParam","text":"rating"},{"kind":"text","text":": "},{"preciseIdentifier":"s:14DiscogsService10ComponentsO","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","text":"Components"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas","text":"Schemas"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO6RatingV","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Rating","text":"Rating"},{"kind":"text","text":"? = nil, "},{"kind":"externalParam","text":"submitter"},{"kind":"text","text":": "},{"preciseIdentifier":"s:14DiscogsService10ComponentsO","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","text":"Components"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas","text":"Schemas"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO6UserIdV","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/UserId","text":"UserId"},{"kind":"text","text":"? = nil, "},{"kind":"externalParam","text":"contributors"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:14DiscogsService10ComponentsO","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","text":"Components"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas","text":"Schemas"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO6UserIdV","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/UserId","text":"UserId"},{"kind":"text","text":"]? = nil, "},{"kind":"externalParam","text":"dataQuality"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"? = nil, "},{"kind":"externalParam","text":"status"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"? = nil)"}],"languages":["swift"]}],"kind":"declarations"},{"parameters":[{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"A number of users that have a release."}]}],"name":"have"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"A number of users that want a release."}]}],"name":"want"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":""}]}],"name":"rating"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"A reference of a user that submitted the release into the database."}]}],"name":"submitter"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"A list of references of users that contributed data of a release into the database."}]}],"name":"contributors"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"An explanation for the data quality related to a community."}]}],"name":"dataQuality"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"An explanation for the stat status of a community."}]}],"name":"status"}],"kind":"parameters"}],"metadata":{"fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"have"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Si","kind":"typeIdentifier","text":"Int"},{"kind":"text","text":", "},{"kind":"externalParam","text":"want"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Si","kind":"typeIdentifier","text":"Int"},{"kind":"text","text":", "},{"kind":"externalParam","text":"rating"},{"kind":"text","text":": "},{"preciseIdentifier":"s:14DiscogsService10ComponentsO","kind":"typeIdentifier","text":"Components"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO","kind":"typeIdentifier","text":"Schemas"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO6RatingV","kind":"typeIdentifier","text":"Rating"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"submitter"},{"kind":"text","text":": "},{"preciseIdentifier":"s:14DiscogsService10ComponentsO","kind":"typeIdentifier","text":"Components"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO","kind":"typeIdentifier","text":"Schemas"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO6UserIdV","kind":"typeIdentifier","text":"UserId"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"contributors"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:14DiscogsService10ComponentsO","kind":"typeIdentifier","text":"Components"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO","kind":"typeIdentifier","text":"Schemas"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO6UserIdV","kind":"typeIdentifier","text":"UserId"},{"kind":"text","text":"]?, "},{"kind":"externalParam","text":"dataQuality"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"status"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?)"}],"roleHeading":"Initializer","role":"symbol","title":"init(have:want:rating:submitter:contributors:dataQuality:status:)","symbolKind":"init","externalID":"s:14DiscogsService10ComponentsO7SchemasO9CommunityV4have4want6rating9submitter12contributors11dataQuality6statusAGSi_SiAE6RatingVSgAE6UserIdVSgSayASGSgSSSgAWtcfc","modules":[{"name":"DiscogsService"}]},"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Community"]]},"sections":[],"schemaVersion":{"patch":0,"major":0,"minor":3},"abstract":[{"type":"text","text":"Creates a new "},{"type":"codeVoice","code":"Community"},{"type":"text","text":"."}],"variants":[{"paths":["\/documentation\/discogsservice\/components\/schemas\/community\/init(have:want:rating:submitter:contributors:dataquality:status:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Community\/init(have:want:rating:submitter:contributors:dataQuality:status:)","interfaceLanguage":"swift"},"kind":"symbol","references":{"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Rating":{"kind":"symbol","navigatorTitle":[{"text":"Rating","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Rating","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Rating","kind":"identifier"}],"role":"symbol","type":"topic","title":"Components.Schemas.Rating","abstract":[{"text":"A type that represents a community rating of a release.","type":"text"}],"url":"\/documentation\/discogsservice\/components\/schemas\/rating"},"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/Components/Schemas/Community":{"type":"topic","navigatorTitle":[{"kind":"identifier","text":"Community"}],"title":"Components.Schemas.Community","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Community"}],"abstract":[{"type":"text","text":"A type that represents a community of users, in relationship to a release."}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Community","role":"symbol","url":"\/documentation\/discogsservice\/components\/schemas\/community"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas":{"type":"topic","navigatorTitle":[{"kind":"identifier","text":"Schemas"}],"url":"\/documentation\/discogsservice\/components\/schemas","abstract":[{"text":"Types generated from the ","type":"text"},{"code":"#\/components\/schemas","type":"codeVoice"},{"type":"text","text":" section of the OpenAPI document."}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas","fragments":[{"kind":"keyword","text":"enum"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Schemas"}],"role":"symbol","kind":"symbol","title":"Components.Schemas"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/UserId":{"url":"\/documentation\/discogsservice\/components\/schemas\/userid","abstract":[{"text":"A type that references a user.","type":"text"}],"title":"Components.Schemas.UserId","type":"topic","role":"symbol","navigatorTitle":[{"text":"UserId","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/UserId","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"UserId","kind":"identifier"}]},"doc://DiscogsService/documentation/DiscogsService/Components":{"url":"\/documentation\/discogsservice\/components","role":"symbol","navigatorTitle":[{"text":"Components","kind":"identifier"}],"abstract":[{"type":"text","text":"Types generated from the components section of the OpenAPI document."}],"title":"Components","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"text":"Components","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Community/init(have:want:rating:submitter:contributors:dataQuality:status:)":{"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Community\/init(have:want:rating:submitter:contributors:dataQuality:status:)","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"have","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Int","preciseIdentifier":"s:Si","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"want","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Int","preciseIdentifier":"s:Si","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"rating","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Components","preciseIdentifier":"s:14DiscogsService10ComponentsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Schemas","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Rating","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO6RatingV","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"submitter","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Components","preciseIdentifier":"s:14DiscogsService10ComponentsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Schemas","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"UserId","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO6UserIdV","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"contributors","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"Components","preciseIdentifier":"s:14DiscogsService10ComponentsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Schemas","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"UserId","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO6UserIdV","kind":"typeIdentifier"},{"text":"]?, ","kind":"text"},{"text":"dataQuality","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"kind":"externalParam","text":"status"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?)"}],"role":"symbol","type":"topic","title":"init(have:want:rating:submitter:contributors:dataQuality:status:)","abstract":[{"text":"Creates a new ","type":"text"},{"code":"Community","type":"codeVoice"},{"text":".","type":"text"}],"url":"\/documentation\/discogsservice\/components\/schemas\/community\/init(have:want:rating:submitter:contributors:dataquality:status:)"}}} |