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.8 KiB
JSON
1 line
7.8 KiB
JSON
{"sections":[],"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"created"},{"kind":"text","text":": "},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier","text":"Operations"},{"kind":"text","text":"."},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostCollectionFolders","preciseIdentifier":"s:14DiscogsService10OperationsO21PostCollectionFoldersO","kind":"typeIdentifier","text":"PostCollectionFolders"},{"kind":"text","text":"."},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostCollectionFolders\/Output","preciseIdentifier":"s:14DiscogsService10OperationsO21PostCollectionFoldersO6OutputO","kind":"typeIdentifier","text":"Output"},{"kind":"text","text":"."},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostCollectionFolders\/Output\/Created-swift.struct","preciseIdentifier":"s:14DiscogsService10OperationsO21PostCollectionFoldersO6OutputO7CreatedV","kind":"typeIdentifier","text":"Created"},{"kind":"text","text":" { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" }"}],"languages":["swift"],"platforms":["macOS"]}],"kind":"declarations"},{"content":[{"type":"heading","level":2,"anchor":"discussion","text":"Discussion"},{"name":"Throws","type":"aside","style":"note","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"An error if "},{"type":"codeVoice","code":"self"},{"type":"text","text":" is not "},{"type":"codeVoice","code":".created"},{"type":"text","text":"."}]}]},{"name":"See Also","type":"aside","style":"note","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":""},{"type":"codeVoice","code":".created"},{"type":"text","text":"."}]}]}],"kind":"content"}],"kind":"symbol","metadata":{"roleHeading":"Instance Property","modules":[{"name":"DiscogsService"}],"externalID":"s:14DiscogsService10OperationsO21PostCollectionFoldersO6OutputO7createdAG7CreatedVvp","symbolKind":"property","title":"created","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"created","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"PostCollectionFolders","preciseIdentifier":"s:14DiscogsService10OperationsO21PostCollectionFoldersO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Output","preciseIdentifier":"s:14DiscogsService10OperationsO21PostCollectionFoldersO6OutputO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Created","preciseIdentifier":"s:14DiscogsService10OperationsO21PostCollectionFoldersO6OutputO7CreatedV","kind":"typeIdentifier"}]},"abstract":[{"text":"The associated value of the enum case if ","type":"text"},{"code":"self","type":"codeVoice"},{"text":" is ","type":"text"},{"code":".created","type":"codeVoice"},{"text":".","type":"text"}],"schemaVersion":{"patch":0,"minor":3,"major":0},"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostCollectionFolders\/Output\/created-swift.property","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostCollectionFolders","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostCollectionFolders\/Output"]]},"variants":[{"paths":["\/documentation\/discogsservice\/operations\/postcollectionfolders\/output\/created-swift.property"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://DiscogsService/documentation/DiscogsService/Operations/PostCollectionFolders":{"navigatorTitle":[{"text":"PostCollectionFolders","kind":"identifier"}],"type":"topic","title":"Operations.PostCollectionFolders","url":"\/documentation\/discogsservice\/operations\/postcollectionfolders","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostCollectionFolders","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PostCollectionFolders","kind":"identifier"}],"kind":"symbol","role":"symbol","abstract":[{"text":"Create a new collection folder for a user.","type":"text"}]},"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/PostCollectionFolders/Output/created-swift.property":{"role":"symbol","type":"topic","url":"\/documentation\/discogsservice\/operations\/postcollectionfolders\/output\/created-swift.property","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostCollectionFolders\/Output\/created-swift.property","abstract":[{"type":"text","text":"The associated value of the enum case if "},{"type":"codeVoice","code":"self"},{"type":"text","text":" is "},{"type":"codeVoice","code":".created"},{"type":"text","text":"."}],"title":"created","kind":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"created","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"text":"PostCollectionFolders","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO21PostCollectionFoldersO"},{"text":".","kind":"text"},{"text":"Output","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO21PostCollectionFoldersO6OutputO"},{"text":".","kind":"text"},{"text":"Created","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO21PostCollectionFoldersO6OutputO7CreatedV"}]},"doc://DiscogsService/documentation/DiscogsService/Operations/PostCollectionFolders/Output":{"url":"\/documentation\/discogsservice\/operations\/postcollectionfolders\/output","navigatorTitle":[{"text":"Output","kind":"identifier"}],"type":"topic","kind":"symbol","abstract":[],"title":"Operations.PostCollectionFolders.Output","role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostCollectionFolders\/Output","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Output","kind":"identifier"}]},"doc://DiscogsService/documentation/DiscogsService/Operations/PostCollectionFolders/Output/Created-swift.struct":{"url":"\/documentation\/discogsservice\/operations\/postcollectionfolders\/output\/created-swift.struct","navigatorTitle":[{"text":"Created","kind":"identifier"}],"type":"topic","kind":"symbol","abstract":[],"title":"Operations.PostCollectionFolders.Output.Created","role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostCollectionFolders\/Output\/Created-swift.struct","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Created","kind":"identifier"}]},"doc://DiscogsService/documentation/DiscogsService":{"url":"\/documentation\/discogsservice","abstract":[],"kind":"symbol","type":"topic","title":"DiscogsService","role":"collection","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService"}}} |