2a7b9746a7
This PR contains the work done to implement the *User Collection* endpoints of the Discogs API into the `OpenAPI` specification document:
* GET `/users/{username}/collection/folders`
* POST `/users/{username}/collection/folders`
* GET `/users/{username}/collection/folders/{folder_id}`
* POST `/users/{username}/collection/folders/{folder_id}`
* DELETE `/users/{username}/collection/folders/{folder_id}`
* GET `/users/{username}/collection/releases/{release_id}`
* GET `/users/{username}/collection/folders/{folder_id}/releases`
* POST `/users/{username}/collection/folders/{folder_id}/releases/{release_id}`
* POST `/users/{username}/collection/folders/{folder_id}/releases/{release_id}/instances/{instance_id}`
* DELETE `/users/{username}/collection/folders/{folder_id}/releases/{release_id}/instances/{instance_id}`
* GET `/users/{username}/collection/fields`
* POST `/users/{username}/collection/folders/{folder_id}/releases/{release_id}/instances/{instance_id}/fields/{field_id}`
* GET `/users/{username}/collection/value`
Reviewed-on: #12
Co-authored-by: Javier Cicchelli <javier@rock-n-code.com>
Co-committed-by: Javier Cicchelli <javier@rock-n-code.com>
1 line
16 KiB
JSON
1 line
16 KiB
JSON
{"metadata":{"role":"symbol","externalID":"s:14DiscogsService10ComponentsO7SchemasO9CommunityV","title":"Components.Schemas.Community","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Community","kind":"identifier"}],"symbolKind":"struct","roleHeading":"Structure","modules":[{"name":"DiscogsService"}],"navigatorTitle":[{"text":"Community","kind":"identifier"}]},"relationshipsSections":[{"identifiers":["doc:\/\/DiscogsService\/Se","doc:\/\/DiscogsService\/SE","doc:\/\/DiscogsService\/SQ","doc:\/\/DiscogsService\/SH","doc:\/\/DiscogsService\/s8SendableP","doc:\/\/DiscogsService\/s16SendableMetatypeP"],"type":"conformsTo","title":"Conforms To","kind":"relationships"}],"schemaVersion":{"patch":0,"minor":3,"major":0},"abstract":[{"text":"A type that represents a community of users, in relationship to a release.","type":"text"}],"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Community","interfaceLanguage":"swift"},"topicSections":[{"generated":true,"anchor":"Initializers","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Community\/init(from:)","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Community\/init(have:want:rating:submitter:contributors:dataQuality:status:)"],"title":"Initializers"},{"generated":true,"anchor":"Instance-Properties","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Community\/contributors","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Community\/dataQuality","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Community\/have","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Community\/rating","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Community\/status","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Community\/submitter","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Community\/want"],"title":"Instance Properties"},{"generated":true,"anchor":"Enumerations","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Community\/CodingKeys"],"title":"Enumerations"},{"generated":true,"anchor":"Default-Implementations","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Community\/Equatable-Implementations"],"title":"Default Implementations"}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["macOS"],"tokens":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Community","kind":"identifier"}]}],"kind":"declarations"},{"content":[{"text":"Overview","type":"heading","level":2,"anchor":"overview"},{"name":"Remark","type":"aside","content":[{"inlineContent":[{"text":"Generated from ","type":"text"},{"type":"codeVoice","code":"#\/components\/schemas\/Community"},{"text":".","type":"text"}],"type":"paragraph"}],"style":"note"}],"kind":"content"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/discogsservice\/components\/schemas\/community"]}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas"]]},"sections":[],"references":{"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Community/want":{"role":"symbol","type":"topic","url":"\/documentation\/discogsservice\/components\/schemas\/community\/want","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Community\/want","abstract":[{"text":"A number of users that want a release.","type":"text"}],"title":"want","kind":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"want","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Int","preciseIdentifier":"s:Si","kind":"typeIdentifier"}]},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Community/Equatable-Implementations":{"role":"collectionGroup","type":"topic","url":"\/documentation\/discogsservice\/components\/schemas\/community\/equatable-implementations","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Community\/Equatable-Implementations","abstract":[],"title":"Equatable Implementations","kind":"article"},"doc://DiscogsService/Se":{"identifier":"doc:\/\/DiscogsService\/Se","type":"unresolvable","title":"Swift.Decodable"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas":{"url":"\/documentation\/discogsservice\/components\/schemas","navigatorTitle":[{"kind":"identifier","text":"Schemas"}],"type":"topic","kind":"symbol","abstract":[{"type":"text","text":"Types generated from the "},{"type":"codeVoice","code":"#\/components\/schemas"},{"type":"text","text":" section of the OpenAPI document."}],"title":"Components.Schemas","role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas","fragments":[{"kind":"keyword","text":"enum"},{"text":" ","kind":"text"},{"text":"Schemas","kind":"identifier"}]},"doc://DiscogsService/SE":{"identifier":"doc:\/\/DiscogsService\/SE","type":"unresolvable","title":"Swift.Encodable"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Community/dataQuality":{"role":"symbol","type":"topic","url":"\/documentation\/discogsservice\/components\/schemas\/community\/dataquality","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Community\/dataQuality","abstract":[{"text":"An explanation for the data quality related to a community.","type":"text"}],"title":"dataQuality","kind":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"dataQuality","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?","kind":"text"}]},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Community/status":{"role":"symbol","type":"topic","url":"\/documentation\/discogsservice\/components\/schemas\/community\/status","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Community\/status","abstract":[{"text":"An explanation for the stat status of a community.","type":"text"}],"title":"status","kind":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"status","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?","kind":"text"}]},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Community":{"role":"symbol","type":"topic","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","url":"\/documentation\/discogsservice\/components\/schemas\/community","title":"Components.Schemas.Community","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Community"}],"navigatorTitle":[{"kind":"identifier","text":"Community"}]},"doc://DiscogsService/SH":{"identifier":"doc:\/\/DiscogsService\/SH","type":"unresolvable","title":"Swift.Hashable"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Community/CodingKeys":{"fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CodingKeys","kind":"identifier"}],"navigatorTitle":[{"text":"CodingKeys","kind":"identifier"}],"abstract":[],"kind":"symbol","type":"topic","url":"\/documentation\/discogsservice\/components\/schemas\/community\/codingkeys","title":"Components.Schemas.Community.CodingKeys","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Community\/CodingKeys","role":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Community/submitter":{"role":"symbol","type":"topic","url":"\/documentation\/discogsservice\/components\/schemas\/community\/submitter","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Community\/submitter","abstract":[{"text":"A reference of a user that submitted the release into the database.","type":"text"}],"title":"submitter","kind":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"submitter","kind":"identifier"},{"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"}]},"doc://DiscogsService/documentation/DiscogsService":{"url":"\/documentation\/discogsservice","abstract":[],"kind":"symbol","type":"topic","title":"DiscogsService","role":"collection","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService"},"doc://DiscogsService/s8SendableP":{"identifier":"doc:\/\/DiscogsService\/s8SendableP","type":"unresolvable","title":"Swift.Sendable"},"doc://DiscogsService/s16SendableMetatypeP":{"identifier":"doc:\/\/DiscogsService\/s16SendableMetatypeP","type":"unresolvable","title":"Swift.SendableMetatype"},"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","kind":"typeIdentifier","preciseIdentifier":"s:Si"},{"text":", ","kind":"text"},{"text":"want","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"},{"text":", ","kind":"text"},{"text":"rating","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Components","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO"},{"text":".","kind":"text"},{"text":"Schemas","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO"},{"text":".","kind":"text"},{"text":"Rating","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO6RatingV"},{"text":"?, ","kind":"text"},{"text":"submitter","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Components","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO"},{"text":".","kind":"text"},{"text":"Schemas","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO"},{"text":".","kind":"text"},{"text":"UserId","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO6UserIdV"},{"text":"?, ","kind":"text"},{"text":"contributors","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"Components","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO"},{"text":".","kind":"text"},{"text":"Schemas","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO"},{"text":".","kind":"text"},{"text":"UserId","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO6UserIdV"},{"text":"]?, ","kind":"text"},{"text":"dataQuality","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?, ","kind":"text"},{"text":"status","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?)","kind":"text"}],"title":"init(have:want:rating:submitter:contributors:dataQuality:status:)","abstract":[{"text":"Creates a new ","type":"text"},{"code":"Community","type":"codeVoice"},{"text":".","type":"text"}],"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Community\/init(have:want:rating:submitter:contributors:dataQuality:status:)","role":"symbol","url":"\/documentation\/discogsservice\/components\/schemas\/community\/init(have:want:rating:submitter:contributors:dataquality:status:)","type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Community/init(from:)":{"url":"\/documentation\/discogsservice\/components\/schemas\/community\/init(from:)","type":"topic","kind":"symbol","abstract":[],"title":"init(from:)","role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Community\/init(from:)","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"text":": any ","kind":"text"},{"text":"Decoder","kind":"typeIdentifier","preciseIdentifier":"s:s7DecoderP"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"}]},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Community/have":{"role":"symbol","type":"topic","url":"\/documentation\/discogsservice\/components\/schemas\/community\/have","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Community\/have","abstract":[{"type":"text","text":"A number of users that have a release."}],"title":"have","kind":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"have","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"}]},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Community/rating":{"kind":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"rating","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Components","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO"},{"text":".","kind":"text"},{"text":"Schemas","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO"},{"text":".","kind":"text"},{"text":"Rating","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO6RatingV"},{"text":"?","kind":"text"}],"type":"topic","url":"\/documentation\/discogsservice\/components\/schemas\/community\/rating","title":"rating","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Community\/rating","abstract":[],"role":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Community/contributors":{"role":"symbol","type":"topic","url":"\/documentation\/discogsservice\/components\/schemas\/community\/contributors","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Community\/contributors","abstract":[{"text":"A list of references of users that contributed data of a release into the database.","type":"text"}],"title":"contributors","kind":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"contributors","kind":"identifier"},{"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"}]},"doc://DiscogsService/SQ":{"identifier":"doc:\/\/DiscogsService\/SQ","type":"unresolvable","title":"Swift.Equatable"},"doc://DiscogsService/documentation/DiscogsService/Components":{"abstract":[{"text":"Types generated from the components section of the OpenAPI document.","type":"text"}],"title":"Components","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Components"}],"role":"symbol","url":"\/documentation\/discogsservice\/components","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","navigatorTitle":[{"kind":"identifier","text":"Components"}],"type":"topic","kind":"symbol"}}} |