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
18 KiB
JSON
1 line
18 KiB
JSON
{"schemaVersion":{"minor":3,"patch":0,"major":0},"relationshipsSections":[{"kind":"relationships","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":"symbol","identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseInFolder","interfaceLanguage":"swift"},"metadata":{"role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"ReleaseInFolder","kind":"identifier"}],"modules":[{"name":"DiscogsService"}],"symbolKind":"struct","navigatorTitle":[{"text":"ReleaseInFolder","kind":"identifier"}],"roleHeading":"Structure","title":"Components.Schemas.ReleaseInFolder","externalID":"s:14DiscogsService10ComponentsO7SchemasO15ReleaseInFolderV"},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["macOS"],"languages":["swift"],"tokens":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"ReleaseInFolder","kind":"identifier"}]}]},{"kind":"content","content":[{"level":2,"text":"Overview","type":"heading","anchor":"overview"},{"name":"Remark","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Generated from "},{"type":"codeVoice","code":"#\/components\/schemas\/ReleaseInFolder"},{"text":".","type":"text"}]}],"type":"aside","style":"note"}]}],"abstract":[{"text":"A type that represents an appearance of a release in a collection folder of a user.","type":"text"}],"topicSections":[{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseInFolder\/NotesPayloadPayload"],"generated":true,"anchor":"Structures","title":"Structures"},{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseInFolder\/init(from:)","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseInFolder\/init(id:folderId:instanceId:dateAdded:rating:basicInformation:notes:)"],"generated":true,"anchor":"Initializers","title":"Initializers"},{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseInFolder\/basicInformation","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseInFolder\/dateAdded","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseInFolder\/folderId","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseInFolder\/id","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseInFolder\/instanceId","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseInFolder\/notes","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseInFolder\/rating"],"generated":true,"anchor":"Instance-Properties","title":"Instance Properties"},{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseInFolder\/NotesPayload"],"generated":true,"anchor":"Type-Aliases","title":"Type Aliases"},{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseInFolder\/CodingKeys"],"generated":true,"anchor":"Enumerations","title":"Enumerations"},{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseInFolder\/Equatable-Implementations"],"generated":true,"anchor":"Default-Implementations","title":"Default Implementations"}],"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas"]]},"sections":[],"variants":[{"paths":["\/documentation\/discogsservice\/components\/schemas\/releaseinfolder"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ReleaseInFolder/rating":{"url":"\/documentation\/discogsservice\/components\/schemas\/releaseinfolder\/rating","abstract":[{"type":"text","text":"A rating given to a release by a user that added it into a collection folder."}],"kind":"symbol","type":"topic","title":"rating","role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseInFolder\/rating","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"rating","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"}]},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ReleaseInFolder":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseInFolder","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"ReleaseInFolder","kind":"identifier"}],"url":"\/documentation\/discogsservice\/components\/schemas\/releaseinfolder","role":"symbol","navigatorTitle":[{"text":"ReleaseInFolder","kind":"identifier"}],"title":"Components.Schemas.ReleaseInFolder","type":"topic","abstract":[{"type":"text","text":"A type that represents an appearance of a release in a collection folder of a user."}]},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ReleaseInFolder/dateAdded":{"url":"\/documentation\/discogsservice\/components\/schemas\/releaseinfolder\/dateadded","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseInFolder\/dateAdded","abstract":[{"text":"A date and time in which a release was added into the collection folder of a user.","type":"text"}],"kind":"symbol","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"dateAdded","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:10Foundation4DateV","text":"Date","kind":"typeIdentifier"}],"type":"topic","title":"dateAdded"},"doc://DiscogsService/Se":{"title":"Swift.Decodable","identifier":"doc:\/\/DiscogsService\/Se","type":"unresolvable"},"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/documentation/DiscogsService/Components/Schemas/ReleaseInFolder/NotesPayloadPayload":{"fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"NotesPayloadPayload","kind":"identifier"}],"title":"Components.Schemas.ReleaseInFolder.NotesPayloadPayload","abstract":[{"text":"A type that represents a note about a release in a collection folder of a user.","type":"text"}],"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseInFolder\/NotesPayloadPayload","role":"symbol","navigatorTitle":[{"text":"NotesPayloadPayload","kind":"identifier"}],"url":"\/documentation\/discogsservice\/components\/schemas\/releaseinfolder\/notespayloadpayload","type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ReleaseInFolder/init(from:)":{"url":"\/documentation\/discogsservice\/components\/schemas\/releaseinfolder\/init(from:)","abstract":[],"kind":"symbol","type":"topic","title":"init(from:)","role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseInFolder\/init(from:)","fragments":[{"kind":"identifier","text":"init"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"from"},{"text":": any ","kind":"text"},{"kind":"typeIdentifier","text":"Decoder","preciseIdentifier":"s:s7DecoderP"},{"text":") ","kind":"text"},{"kind":"keyword","text":"throws"}]},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ReleaseInFolder/folderId":{"role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"folderId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"},{"kind":"text","text":"?"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseInFolder\/folderId","kind":"symbol","abstract":[{"type":"text","text":"An identifier of a collection folder that contains a specified release."}],"url":"\/documentation\/discogsservice\/components\/schemas\/releaseinfolder\/folderid","title":"folderId","type":"topic"},"doc://DiscogsService/SH":{"title":"Swift.Hashable","identifier":"doc:\/\/DiscogsService\/SH","type":"unresolvable"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ReleaseInFolder/id":{"url":"\/documentation\/discogsservice\/components\/schemas\/releaseinfolder\/id","abstract":[{"type":"text","text":"An identifier of an appearance of a release in a collection folder."}],"kind":"symbol","type":"topic","title":"id","role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseInFolder\/id","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"id"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"}]},"doc://DiscogsService/SE":{"title":"Swift.Encodable","identifier":"doc:\/\/DiscogsService\/SE","type":"unresolvable"},"doc://DiscogsService/s8SendableP":{"title":"Swift.Sendable","identifier":"doc:\/\/DiscogsService\/s8SendableP","type":"unresolvable"},"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/ReleaseInFolder/Equatable-Implementations":{"url":"\/documentation\/discogsservice\/components\/schemas\/releaseinfolder\/equatable-implementations","abstract":[],"kind":"article","type":"topic","title":"Equatable Implementations","role":"collectionGroup","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseInFolder\/Equatable-Implementations"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ReleaseInFolder/NotesPayload":{"url":"\/documentation\/discogsservice\/components\/schemas\/releaseinfolder\/notespayload","navigatorTitle":[{"kind":"identifier","text":"NotesPayload"}],"abstract":[{"type":"text","text":"A list of additional notes related to a release in a collection folder of a user."}],"kind":"symbol","type":"topic","title":"Components.Schemas.ReleaseInFolder.NotesPayload","role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseInFolder\/NotesPayload","fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"NotesPayload"}]},"doc://DiscogsService/s16SendableMetatypeP":{"title":"Swift.SendableMetatype","identifier":"doc:\/\/DiscogsService\/s16SendableMetatypeP","type":"unresolvable"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ReleaseInFolder/notes":{"url":"\/documentation\/discogsservice\/components\/schemas\/releaseinfolder\/notes","abstract":[{"type":"text","text":"A list of additional notes related to a release in a collection folder of a user."}],"kind":"symbol","type":"topic","title":"notes","role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseInFolder\/notes","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"notes"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Components","preciseIdentifier":"s:14DiscogsService10ComponentsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Schemas","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"ReleaseInFolder","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO15ReleaseInFolderV"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"NotesPayload","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO15ReleaseInFolderV12NotesPayloada"},{"kind":"text","text":"?"}]},"doc://DiscogsService/SQ":{"title":"Swift.Equatable","identifier":"doc:\/\/DiscogsService\/SQ","type":"unresolvable"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ReleaseInFolder/instanceId":{"url":"\/documentation\/discogsservice\/components\/schemas\/releaseinfolder\/instanceid","abstract":[{"type":"text","text":"An identifier of a release instance."}],"kind":"symbol","type":"topic","title":"instanceId","role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseInFolder\/instanceId","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"instanceId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"}]},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ReleaseInFolder/init(id:folderId:instanceId:dateAdded:rating:basicInformation:notes:)":{"url":"\/documentation\/discogsservice\/components\/schemas\/releaseinfolder\/init(id:folderid:instanceid:dateadded:rating:basicinformation:notes:)","abstract":[{"type":"text","text":"Creates a new "},{"type":"codeVoice","code":"ReleaseInFolder"},{"type":"text","text":"."}],"kind":"symbol","type":"topic","title":"init(id:folderId:instanceId:dateAdded:rating:basicInformation:notes:)","role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseInFolder\/init(id:folderId:instanceId:dateAdded:rating:basicInformation:notes:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"id"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"},{"kind":"text","text":", "},{"kind":"externalParam","text":"folderId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"instanceId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"},{"kind":"text","text":", "},{"kind":"externalParam","text":"dateAdded"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Date","preciseIdentifier":"s:10Foundation4DateV"},{"kind":"text","text":", "},{"kind":"externalParam","text":"rating"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"},{"kind":"text","text":", "},{"kind":"externalParam","text":"basicInformation"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Components","preciseIdentifier":"s:14DiscogsService10ComponentsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Schemas","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Release","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO7ReleaseV"},{"kind":"text","text":", "},{"kind":"externalParam","text":"notes"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Components","preciseIdentifier":"s:14DiscogsService10ComponentsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Schemas","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"ReleaseInFolder","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO15ReleaseInFolderV"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"NotesPayload","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO15ReleaseInFolderV12NotesPayloada"},{"kind":"text","text":"?)"}]},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ReleaseInFolder/CodingKeys":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseInFolder\/CodingKeys","kind":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CodingKeys","kind":"identifier"}],"url":"\/documentation\/discogsservice\/components\/schemas\/releaseinfolder\/codingkeys","role":"symbol","navigatorTitle":[{"text":"CodingKeys","kind":"identifier"}],"title":"Components.Schemas.ReleaseInFolder.CodingKeys","type":"topic","abstract":[]},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ReleaseInFolder/basicInformation":{"url":"\/documentation\/discogsservice\/components\/schemas\/releaseinfolder\/basicinformation","abstract":[{"type":"text","text":"The available information about a release that was added into a collection folder of a user."}],"kind":"symbol","type":"topic","title":"basicInformation","role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseInFolder\/basicInformation","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"basicInformation"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Components","preciseIdentifier":"s:14DiscogsService10ComponentsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Schemas","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Release","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO7ReleaseV"}]},"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"}}} |