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
12 KiB
JSON
1 line
12 KiB
JSON
{"metadata":{"roleHeading":"Structure","modules":[{"name":"DiscogsService"}],"symbolKind":"struct","externalID":"s:14DiscogsService10ComponentsO7SchemasO12UserIdentityV","title":"Components.Schemas.UserIdentity","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"UserIdentity","kind":"identifier"}],"navigatorTitle":[{"text":"UserIdentity","kind":"identifier"}]},"relationshipsSections":[{"type":"conformsTo","title":"Conforms To","identifiers":["doc:\/\/DiscogsService\/Se","doc:\/\/DiscogsService\/SE","doc:\/\/DiscogsService\/SQ","doc:\/\/DiscogsService\/SH","doc:\/\/DiscogsService\/s8SendableP","doc:\/\/DiscogsService\/s16SendableMetatypeP"],"kind":"relationships"}],"schemaVersion":{"major":0,"patch":0,"minor":3},"abstract":[{"type":"text","text":"A type that represents a user identity."}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/UserIdentity"},"topicSections":[{"generated":true,"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/UserIdentity\/Value2Payload"],"title":"Structures","anchor":"Structures"},{"anchor":"Initializers","title":"Initializers","generated":true,"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/UserIdentity\/init(from:)","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/UserIdentity\/init(value1:value2:)"]},{"generated":true,"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/UserIdentity\/value1","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/UserIdentity\/value2"],"title":"Instance Properties","anchor":"Instance-Properties"},{"generated":true,"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/UserIdentity\/encode(to:)"],"title":"Instance Methods","anchor":"Instance-Methods"},{"anchor":"Default-Implementations","title":"Default Implementations","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/UserIdentity\/Equatable-Implementations"],"generated":true}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"UserIdentity"}],"languages":["swift"],"platforms":["macOS"]}]},{"content":[{"level":2,"anchor":"overview","text":"Overview","type":"heading"},{"style":"note","type":"aside","name":"Remark","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Generated from "},{"code":"#\/components\/schemas\/UserIdentity","type":"codeVoice"},{"type":"text","text":"."}]}]}],"kind":"content"}],"variants":[{"paths":["\/documentation\/discogsservice\/components\/schemas\/useridentity"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","sections":[],"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas"]]},"references":{"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/UserIdentity/encode(to:)":{"type":"topic","title":"encode(to:)","url":"\/documentation\/discogsservice\/components\/schemas\/useridentity\/encode(to:)","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/UserIdentity\/encode(to:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"encode"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"to"},{"kind":"text","text":": any "},{"kind":"typeIdentifier","preciseIdentifier":"s:s7EncoderP","text":"Encoder"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"kind":"symbol","role":"symbol","abstract":[]},"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/s16SendableMetatypeP":{"title":"Swift.SendableMetatype","identifier":"doc:\/\/DiscogsService\/s16SendableMetatypeP","type":"unresolvable"},"doc://DiscogsService/SE":{"title":"Swift.Encodable","type":"unresolvable","identifier":"doc:\/\/DiscogsService\/SE"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/UserIdentity":{"fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"UserIdentity","kind":"identifier"}],"title":"Components.Schemas.UserIdentity","abstract":[{"text":"A type that represents a user identity.","type":"text"}],"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/UserIdentity","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"UserIdentity"}],"url":"\/documentation\/discogsservice\/components\/schemas\/useridentity","type":"topic"},"doc://DiscogsService/SH":{"title":"Swift.Hashable","identifier":"doc:\/\/DiscogsService\/SH","type":"unresolvable"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/UserIdentity/init(value1:value2:)":{"role":"symbol","type":"topic","abstract":[{"text":"Creates a new ","type":"text"},{"code":"UserIdentity","type":"codeVoice"},{"text":".","type":"text"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/UserIdentity\/init(value1:value2:)","url":"\/documentation\/discogsservice\/components\/schemas\/useridentity\/init(value1:value2:)","title":"init(value1:value2:)","kind":"symbol","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"value1"},{"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"},{"kind":"text","text":", "},{"text":"value2","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Components","preciseIdentifier":"s:14DiscogsService10ComponentsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO","text":"Schemas"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO12UserIdentityV","text":"UserIdentity"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO12UserIdentityV13Value2PayloadV","text":"Value2Payload"},{"kind":"text","text":")"}]},"doc://DiscogsService/s8SendableP":{"identifier":"doc:\/\/DiscogsService\/s8SendableP","type":"unresolvable","title":"Swift.Sendable"},"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"},"doc://DiscogsService/SQ":{"type":"unresolvable","title":"Swift.Equatable","identifier":"doc:\/\/DiscogsService\/SQ"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/UserIdentity/value1":{"role":"symbol","type":"topic","abstract":[],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/UserIdentity\/value1","url":"\/documentation\/discogsservice\/components\/schemas\/useridentity\/value1","title":"value1","kind":"symbol","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"value1"},{"kind":"text","text":": "},{"text":"Components","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO"},{"text":".","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO","text":"Schemas"},{"text":".","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO6UserIdV","text":"UserId"}]},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/UserIdentity/Equatable-Implementations":{"type":"topic","title":"Equatable Implementations","url":"\/documentation\/discogsservice\/components\/schemas\/useridentity\/equatable-implementations","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/UserIdentity\/Equatable-Implementations","kind":"article","role":"collectionGroup","abstract":[]},"doc://DiscogsService/documentation/DiscogsService":{"url":"\/documentation\/discogsservice","abstract":[],"kind":"symbol","type":"topic","title":"DiscogsService","role":"collection","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/UserIdentity/Value2Payload":{"role":"symbol","type":"topic","url":"\/documentation\/discogsservice\/components\/schemas\/useridentity\/value2payload","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/UserIdentity\/Value2Payload","abstract":[],"title":"Components.Schemas.UserIdentity.Value2Payload","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Value2Payload","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"Value2Payload"}]},"doc://DiscogsService/Se":{"identifier":"doc:\/\/DiscogsService\/Se","title":"Swift.Decodable","type":"unresolvable"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/UserIdentity/init(from:)":{"role":"symbol","type":"topic","url":"\/documentation\/discogsservice\/components\/schemas\/useridentity\/init(from:)","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/UserIdentity\/init(from:)","abstract":[],"title":"init(from:)","kind":"symbol","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":": any "},{"kind":"typeIdentifier","preciseIdentifier":"s:s7DecoderP","text":"Decoder"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}]},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/UserIdentity/value2":{"fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"value2"},{"text":": ","kind":"text"},{"text":"Components","preciseIdentifier":"s:14DiscogsService10ComponentsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Schemas","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO"},{"text":".","kind":"text"},{"text":"UserIdentity","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO12UserIdentityV","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Value2Payload","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO12UserIdentityV13Value2PayloadV","kind":"typeIdentifier"}],"title":"value2","abstract":[],"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/UserIdentity\/value2","role":"symbol","type":"topic","url":"\/documentation\/discogsservice\/components\/schemas\/useridentity\/value2"}}} |