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.5 KiB
JSON
1 line
7.5 KiB
JSON
{"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"created","kind":"identifier"},{"text":"(","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations"},{"text":".","kind":"text"},{"text":"PostCollectionFolders","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO21PostCollectionFoldersO","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostCollectionFolders"},{"text":".","kind":"text"},{"text":"Output","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO21PostCollectionFoldersO6OutputO","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostCollectionFolders\/Output"},{"text":".","kind":"text"},{"text":"Created","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO21PostCollectionFoldersO6OutputO7CreatedV","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostCollectionFolders\/Output\/Created-swift.struct"},{"text":")","kind":"text"}],"platforms":["macOS"]}]},{"kind":"content","content":[{"type":"heading","level":2,"anchor":"discussion","text":"Discussion"},{"type":"aside","content":[{"inlineContent":[{"type":"text","text":"Generated from "},{"code":"#\/paths\/\/users\/{username}\/collection\/folders\/post(postCollectionFolders)\/responses\/201","type":"codeVoice"},{"type":"text","text":"."}],"type":"paragraph"}],"style":"note","name":"Remark"},{"type":"paragraph","inlineContent":[{"text":"HTTP response code: ","type":"text"},{"code":"201 created","type":"codeVoice"},{"text":".","type":"text"}]}]}],"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostCollectionFolders","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostCollectionFolders\/Output"]]},"kind":"symbol","identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostCollectionFolders\/Output\/created(_:)","interfaceLanguage":"swift"},"schemaVersion":{"major":0,"patch":0,"minor":3},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/discogsservice\/operations\/postcollectionfolders\/output\/created(_:)"]}],"sections":[],"abstract":[{"type":"text","text":"Successfully create a new collection folder for a user."}],"metadata":{"symbolKind":"case","modules":[{"name":"DiscogsService"}],"fragments":[{"text":"case","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"},{"text":")","kind":"text"}],"role":"symbol","roleHeading":"Case","title":"Operations.PostCollectionFolders.Output.created(_:)","externalID":"s:14DiscogsService10OperationsO21PostCollectionFoldersO6OutputO7createdyA2G7CreatedVcAGmF"},"references":{"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/Operations/PostCollectionFolders/Output/created(_:)":{"role":"symbol","type":"topic","url":"\/documentation\/discogsservice\/operations\/postcollectionfolders\/output\/created(_:)","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostCollectionFolders\/Output\/created(_:)","abstract":[{"type":"text","text":"Successfully create a new collection folder for a user."}],"title":"Operations.PostCollectionFolders.Output.created(_:)","kind":"symbol","fragments":[{"text":"case","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"},{"text":")","kind":"text"}]},"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":{"url":"\/documentation\/discogsservice","abstract":[],"kind":"symbol","type":"topic","title":"DiscogsService","role":"collection","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService"}}} |