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
8.4 KiB
JSON
1 line
8.4 KiB
JSON
{"metadata":{"symbolKind":"property","modules":[{"name":"DiscogsService"}],"title":"name","externalID":"s:14DiscogsService10OperationsO21PostCollectionFoldersO5InputV5QueryV4nameSSSgvp","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"name","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Components","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO"},{"text":".","kind":"text"},{"text":"Parameters","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO"},{"text":".","kind":"text"},{"text":"Name","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO4Namea"},{"text":"?","kind":"text"}],"roleHeading":"Instance Property","role":"symbol"},"variants":[{"paths":["\/documentation\/discogsservice\/operations\/postcollectionfolders\/input\/query-swift.struct\/name"],"traits":[{"interfaceLanguage":"swift"}]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"name","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Components","preciseIdentifier":"s:14DiscogsService10ComponentsO","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components"},{"text":".","kind":"text"},{"text":"Parameters","preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters"},{"text":".","kind":"text"},{"text":"Name","preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO4Namea","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/Name"},{"text":"?","kind":"text"}],"platforms":["macOS"]}]},{"kind":"content","content":[{"level":2,"text":"Discussion","anchor":"discussion","type":"heading"},{"style":"note","name":"Remark","content":[{"inlineContent":[{"text":"Generated from ","type":"text"},{"code":"#\/paths\/users\/{username}\/collection\/folders\/POST\/query\/name","type":"codeVoice"},{"text":".","type":"text"}],"type":"paragraph"}],"type":"aside"}]}],"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostCollectionFolders","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostCollectionFolders\/Input","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostCollectionFolders\/Input\/Query-swift.struct"]]},"schemaVersion":{"major":0,"patch":0,"minor":3},"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostCollectionFolders\/Input\/Query-swift.struct\/name"},"kind":"symbol","abstract":[{"text":"A name for a new folder.","type":"text"}],"references":{"doc://DiscogsService/documentation/DiscogsService/Operations/PostCollectionFolders/Input":{"navigatorTitle":[{"kind":"identifier","text":"Input"}],"type":"topic","title":"Operations.PostCollectionFolders.Input","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostCollectionFolders\/Input","url":"\/documentation\/discogsservice\/operations\/postcollectionfolders\/input","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Input"}],"kind":"symbol","role":"symbol","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/Operations/PostCollectionFolders/Input/Query-swift.struct/name":{"type":"topic","title":"name","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostCollectionFolders\/Input\/Query-swift.struct\/name","url":"\/documentation\/discogsservice\/operations\/postcollectionfolders\/input\/query-swift.struct\/name","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"name"},{"kind":"text","text":": "},{"text":"Components","preciseIdentifier":"s:14DiscogsService10ComponentsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Parameters","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO"},{"text":".","kind":"text"},{"text":"Name","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO4Namea"},{"text":"?","kind":"text"}],"kind":"symbol","role":"symbol","abstract":[{"text":"A name for a new folder.","type":"text"}]},"doc://DiscogsService/documentation/DiscogsService/Operations/PostCollectionFolders/Input/Query-swift.struct":{"abstract":[],"title":"Operations.PostCollectionFolders.Input.Query","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Query","kind":"identifier"}],"role":"symbol","url":"\/documentation\/discogsservice\/operations\/postcollectionfolders\/input\/query-swift.struct","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostCollectionFolders\/Input\/Query-swift.struct","navigatorTitle":[{"text":"Query","kind":"identifier"}],"type":"topic","kind":"symbol"},"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/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/documentation/DiscogsService/Components/Parameters/Name":{"navigatorTitle":[{"text":"Name","kind":"identifier"}],"type":"topic","title":"Components.Parameters.Name","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/Name","url":"\/documentation\/discogsservice\/components\/parameters\/name","fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Name","kind":"identifier"}],"kind":"symbol","role":"symbol","abstract":[{"text":"A real name of a user.","type":"text"}]},"doc://DiscogsService/documentation/DiscogsService/Components/Parameters":{"navigatorTitle":[{"text":"Parameters","kind":"identifier"}],"type":"topic","title":"Components.Parameters","url":"\/documentation\/discogsservice\/components\/parameters","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Parameters","kind":"identifier"}],"kind":"symbol","role":"symbol","abstract":[{"text":"Types generated from the ","type":"text"},{"code":"#\/components\/parameters","type":"codeVoice"},{"text":" section of the OpenAPI document.","type":"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"}]}}} |