javier
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
6.5 KiB
JSON
1 line
6.5 KiB
JSON
{"schemaVersion":{"patch":0,"minor":3,"major":0},"sections":[],"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations"]]},"abstract":[{"type":"text","text":"Get contributions of a user."}],"metadata":{"title":"Operations.GetUserContributions","roleHeading":"Enumeration","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"GetUserContributions","kind":"identifier"}],"role":"symbol","externalID":"s:14DiscogsService10OperationsO20GetUserContributionsO","modules":[{"name":"DiscogsService"}],"navigatorTitle":[{"kind":"identifier","text":"GetUserContributions"}],"symbolKind":"enum"},"variants":[{"paths":["\/documentation\/discogsservice\/operations\/getusercontributions"],"traits":[{"interfaceLanguage":"swift"}]}],"topicSections":[{"title":"Structures","anchor":"Structures","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetUserContributions\/Input"],"generated":true},{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetUserContributions\/id"],"generated":true,"anchor":"Type-Properties","title":"Type Properties"},{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetUserContributions\/AcceptableContentType","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetUserContributions\/Output"],"generated":true,"anchor":"Enumerations","title":"Enumerations"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["macOS"],"tokens":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"GetUserContributions"}],"languages":["swift"]}]},{"kind":"content","content":[{"type":"heading","anchor":"overview","text":"Overview","level":2},{"type":"paragraph","inlineContent":[{"text":"Retrieves all the contributions or additions to releases, labels, and artist done by username.","type":"text"}]},{"inlineContent":[{"type":"text","text":"This endpoints accepts pagination headers."}],"type":"paragraph"},{"style":"note","content":[{"inlineContent":[{"text":"HTTP ","type":"text"},{"code":"GET \/users\/{username}\/contributions","type":"codeVoice"},{"text":".","type":"text"}],"type":"paragraph"}],"name":"Remark","type":"aside"},{"style":"note","content":[{"inlineContent":[{"text":"Generated from ","type":"text"},{"type":"codeVoice","code":"#\/paths\/\/users\/{username}\/contributions\/get(getUserContributions)"},{"text":".","type":"text"}],"type":"paragraph"}],"name":"Remark","type":"aside"}]}],"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetUserContributions","interfaceLanguage":"swift"},"kind":"symbol","references":{"doc://DiscogsService/documentation/DiscogsService/Operations/GetUserContributions/AcceptableContentType":{"url":"\/documentation\/discogsservice\/operations\/getusercontributions\/acceptablecontenttype","navigatorTitle":[{"text":"AcceptableContentType","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetUserContributions\/AcceptableContentType","abstract":[],"kind":"symbol","role":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AcceptableContentType","kind":"identifier"}],"type":"topic","title":"Operations.GetUserContributions.AcceptableContentType"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetUserContributions/Input":{"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Input","kind":"identifier"}],"navigatorTitle":[{"text":"Input","kind":"identifier"}],"abstract":[],"kind":"symbol","type":"topic","url":"\/documentation\/discogsservice\/operations\/getusercontributions\/input","title":"Operations.GetUserContributions.Input","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetUserContributions\/Input","role":"symbol"},"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/GetUserContributions/id":{"role":"symbol","type":"topic","url":"\/documentation\/discogsservice\/operations\/getusercontributions\/id","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetUserContributions\/id","abstract":[],"title":"id","kind":"symbol","fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"id","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}]},"doc://DiscogsService/documentation/DiscogsService/Operations/GetUserContributions":{"abstract":[{"text":"Get contributions of a user.","type":"text"}],"title":"Operations.GetUserContributions","fragments":[{"kind":"keyword","text":"enum"},{"text":" ","kind":"text"},{"text":"GetUserContributions","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetUserContributions","url":"\/documentation\/discogsservice\/operations\/getusercontributions","navigatorTitle":[{"text":"GetUserContributions","kind":"identifier"}],"type":"topic","kind":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetUserContributions/Output":{"navigatorTitle":[{"text":"Output","kind":"identifier"}],"type":"topic","title":"Operations.GetUserContributions.Output","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetUserContributions\/Output","url":"\/documentation\/discogsservice\/operations\/getusercontributions\/output","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Output","kind":"identifier"}],"kind":"symbol","role":"symbol","abstract":[]}}} |