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
7.4 KiB
JSON
1 line
7.4 KiB
JSON
{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"PostReleaseToCollectionFolder"}],"platforms":["macOS"],"languages":["swift"]}]},{"kind":"content","content":[{"level":2,"anchor":"overview","type":"heading","text":"Overview"},{"inlineContent":[{"text":"Adds a release to a collection folder of a user.","type":"text"}],"type":"paragraph"},{"content":[{"inlineContent":[{"text":"A ","type":"text"},{"code":"folder_id","type":"codeVoice"},{"text":" must not be ","type":"text"},{"code":"0","type":"codeVoice"},{"text":", so it is possible to use the identifier ","type":"text"},{"code":"1","type":"codeVoice"},{"text":" for the ","type":"text"},{"type":"emphasis","inlineContent":[{"text":"Uncategorized","type":"text"}]},{"text":" folder.","type":"text"}],"type":"paragraph"}],"style":"important","name":"Important","type":"aside"},{"inlineContent":[{"text":"This endpoint requires authentication as the collection owner.","type":"text"}],"type":"paragraph"},{"content":[{"inlineContent":[{"text":"HTTP ","type":"text"},{"code":"POST \/users\/{username}\/collection\/folders\/{folder_id}\/releases\/{release_id}","type":"codeVoice"},{"text":".","type":"text"}],"type":"paragraph"}],"style":"note","name":"Remark","type":"aside"},{"content":[{"inlineContent":[{"text":"Generated from ","type":"text"},{"code":"#\/paths\/\/users\/{username}\/collection\/folders\/{folder_id}\/releases\/{release_id}\/post(postReleaseToCollectionFolder)","type":"codeVoice"},{"text":".","type":"text"}],"type":"paragraph"}],"style":"note","name":"Remark","type":"aside"}]}],"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations"]]},"topicSections":[{"anchor":"Structures","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostReleaseToCollectionFolder\/Input"],"generated":true,"title":"Structures"},{"anchor":"Type-Properties","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostReleaseToCollectionFolder\/id"],"generated":true,"title":"Type Properties"},{"anchor":"Enumerations","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostReleaseToCollectionFolder\/AcceptableContentType","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostReleaseToCollectionFolder\/Output"],"generated":true,"title":"Enumerations"}],"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/discogsservice\/operations\/postreleasetocollectionfolder"]}],"kind":"symbol","schemaVersion":{"patch":0,"major":0,"minor":3},"metadata":{"navigatorTitle":[{"kind":"identifier","text":"PostReleaseToCollectionFolder"}],"roleHeading":"Enumeration","externalID":"s:14DiscogsService10OperationsO29PostReleaseToCollectionFolderO","symbolKind":"enum","title":"Operations.PostReleaseToCollectionFolder","modules":[{"name":"DiscogsService"}],"role":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PostReleaseToCollectionFolder","kind":"identifier"}]},"abstract":[{"text":"Add a release to a collection folder of a user.","type":"text"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostReleaseToCollectionFolder"},"references":{"doc://DiscogsService/documentation/DiscogsService/Operations/PostReleaseToCollectionFolder/id":{"fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"id","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostReleaseToCollectionFolder\/id","kind":"symbol","abstract":[],"title":"id","role":"symbol","url":"\/documentation\/discogsservice\/operations\/postreleasetocollectionfolder\/id","type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Operations/PostReleaseToCollectionFolder/Input":{"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Input","kind":"identifier"}],"navigatorTitle":[{"text":"Input","kind":"identifier"}],"abstract":[],"kind":"symbol","type":"topic","title":"Operations.PostReleaseToCollectionFolder.Input","url":"\/documentation\/discogsservice\/operations\/postreleasetocollectionfolder\/input","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostReleaseToCollectionFolder\/Input","role":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Operations/PostReleaseToCollectionFolder/AcceptableContentType":{"role":"symbol","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"AcceptableContentType"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostReleaseToCollectionFolder\/AcceptableContentType","kind":"symbol","abstract":[],"url":"\/documentation\/discogsservice\/operations\/postreleasetocollectionfolder\/acceptablecontenttype","navigatorTitle":[{"kind":"identifier","text":"AcceptableContentType"}],"type":"topic","title":"Operations.PostReleaseToCollectionFolder.AcceptableContentType"},"doc://DiscogsService/documentation/DiscogsService/Operations/PostReleaseToCollectionFolder/Output":{"fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Output","kind":"identifier"}],"title":"Operations.PostReleaseToCollectionFolder.Output","abstract":[],"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostReleaseToCollectionFolder\/Output","role":"symbol","navigatorTitle":[{"text":"Output","kind":"identifier"}],"type":"topic","url":"\/documentation\/discogsservice\/operations\/postreleasetocollectionfolder\/output"},"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/Operations":{"abstract":[{"type":"text","text":"API operations, with input and output types, generated from "},{"code":"#\/paths","type":"codeVoice"},{"text":" in the OpenAPI document.","type":"text"}],"title":"Operations","fragments":[{"text":"enum","kind":"keyword"},{"kind":"text","text":" "},{"text":"Operations","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","url":"\/documentation\/discogsservice\/operations","navigatorTitle":[{"text":"Operations","kind":"identifier"}],"type":"topic","kind":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Operations/PostReleaseToCollectionFolder":{"fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PostReleaseToCollectionFolder","kind":"identifier"}],"title":"Operations.PostReleaseToCollectionFolder","abstract":[{"type":"text","text":"Add a release to a collection folder of a user."}],"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostReleaseToCollectionFolder","role":"symbol","navigatorTitle":[{"text":"PostReleaseToCollectionFolder","kind":"identifier"}],"type":"topic","url":"\/documentation\/discogsservice\/operations\/postreleasetocollectionfolder"}}} |