Files
discogs-service/docs/data/documentation/discogsservice/components/schemas/community/init(have:want:rating:submitter:contributors:dataquality:status:).json
T
javier f3d5c0e6ac Implemented the User Wantlist endpoints (#13)
This PR contains the work done to implement the *User Wantlist* endpoints of the *Discogs API* online service in the `Open API` specification document:

* GET `/users/{username}/wants`
* POST `/users/{username}/wants/{release_id}`
* PUT `/users/{username}/wants/{release_id}`
* DELETE `/users/{username}/wants/{release_id}`

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

1 line
13 KiB
JSON

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