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.5 KiB
JSON
1 line
8.5 KiB
JSON
{"metadata":{"symbolKind":"init","title":"init(rating:)","modules":[{"name":"DiscogsService"}],"externalID":"s:14DiscogsService10OperationsO22PutReleaseRatingByUserO5InputV5QueryV6ratingAISiSg_tcfc","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"rating","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Components","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO"},{"text":".","kind":"text"},{"text":"Parameters","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO"},{"text":".","kind":"text"},{"text":"Rating","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO6Ratinga"},{"text":"?)","kind":"text"}],"roleHeading":"Initializer","role":"symbol"},"variants":[{"paths":["\/documentation\/discogsservice\/operations\/putreleaseratingbyuser\/input\/query-swift.struct\/init(rating:)"],"traits":[{"interfaceLanguage":"swift"}]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"init","kind":"keyword"},{"text":"(","kind":"text"},{"text":"rating","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Components","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components"},{"text":".","kind":"text"},{"text":"Parameters","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters"},{"text":".","kind":"text"},{"text":"Rating","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO6Ratinga","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/Rating"},{"text":"? = nil)","kind":"text"}],"platforms":["macOS"],"languages":["swift"]}]},{"kind":"parameters","parameters":[{"content":[{"inlineContent":[{"text":"A number (between 1 and 5) for a rating of a release.","type":"text"}],"type":"paragraph"}],"name":"rating"}]}],"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PutReleaseRatingByUser","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PutReleaseRatingByUser\/Input","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PutReleaseRatingByUser\/Input\/Query-swift.struct"]]},"schemaVersion":{"minor":3,"major":0,"patch":0},"sections":[],"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PutReleaseRatingByUser\/Input\/Query-swift.struct\/init(rating:)","interfaceLanguage":"swift"},"kind":"symbol","abstract":[{"type":"text","text":"Creates a new "},{"code":"Query","type":"codeVoice"},{"type":"text","text":"."}],"references":{"doc://DiscogsService/documentation/DiscogsService/Operations/PutReleaseRatingByUser/Input":{"abstract":[],"title":"Operations.PutReleaseRatingByUser.Input","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Input"}],"role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PutReleaseRatingByUser\/Input","url":"\/documentation\/discogsservice\/operations\/putreleaseratingbyuser\/input","navigatorTitle":[{"kind":"identifier","text":"Input"}],"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"},"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/PutReleaseRatingByUser/Input/Query-swift.struct":{"title":"Operations.PutReleaseRatingByUser.Input.Query","abstract":[],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PutReleaseRatingByUser\/Input\/Query-swift.struct","navigatorTitle":[{"kind":"identifier","text":"Query"}],"role":"symbol","type":"topic","url":"\/documentation\/discogsservice\/operations\/putreleaseratingbyuser\/input\/query-swift.struct","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Query"}],"kind":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Operations/PutReleaseRatingByUser":{"navigatorTitle":[{"kind":"identifier","text":"PutReleaseRatingByUser"}],"type":"topic","title":"Operations.PutReleaseRatingByUser","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PutReleaseRatingByUser","url":"\/documentation\/discogsservice\/operations\/putreleaseratingbyuser","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PutReleaseRatingByUser","kind":"identifier"}],"kind":"symbol","role":"symbol","abstract":[{"text":"Update information about a rating of release by a user.","type":"text"}]},"doc://DiscogsService/documentation/DiscogsService/Operations/PutReleaseRatingByUser/Input/Query-swift.struct/init(rating:)":{"role":"symbol","type":"topic","abstract":[{"type":"text","text":"Creates a new "},{"code":"Query","type":"codeVoice"},{"type":"text","text":"."}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PutReleaseRatingByUser\/Input\/Query-swift.struct\/init(rating:)","url":"\/documentation\/discogsservice\/operations\/putreleaseratingbyuser\/input\/query-swift.struct\/init(rating:)","title":"init(rating:)","kind":"symbol","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"rating"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO","text":"Components"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO","text":"Parameters"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO6Ratinga","text":"Rating"},{"kind":"text","text":"?)"}]},"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/Rating":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/Rating","kind":"symbol","fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Rating","kind":"identifier"}],"url":"\/documentation\/discogsservice\/components\/parameters\/rating","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Rating"}],"title":"Components.Parameters.Rating","type":"topic","abstract":[{"type":"text","text":"A number (between 1 and 5) for a rating of a release."}]},"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"}}} |