eaee2b84f0
This PR contains the work done to update the overall documentation of the package. Reviewed-on: #17 Co-authored-by: Javier Cicchelli <javier@rock-n-code.com> Co-committed-by: Javier Cicchelli <javier@rock-n-code.com>
1 line
7.4 KiB
JSON
1 line
7.4 KiB
JSON
{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"PostChangeRatingOfRelease"}],"platforms":["macOS"],"languages":["swift"]}]},{"kind":"content","content":[{"anchor":"overview","type":"heading","level":2,"text":"Overview"},{"type":"paragraph","inlineContent":[{"text":"Changes the rating on a release and\/or move the instance to another folder.","type":"text"}]},{"type":"paragraph","inlineContent":[{"type":"text","text":"This endpoint potentially takes 2 "},{"type":"codeVoice","code":"folder_id"},{"type":"text","text":" parameters: 1) in the URL (which is the folder you are requesting, and is required), and 2) in the request body (representing the folder you want to move the instance to, which is optional)"}]},{"type":"paragraph","inlineContent":[{"type":"text","text":"This endpoint requires authentication as the collection owner."}]},{"type":"aside","name":"Remark","style":"note","content":[{"inlineContent":[{"text":"HTTP ","type":"text"},{"code":"POST \/users\/{username}\/collection\/folders\/{folder_id}\/releases\/{release_id}\/instances\/{instance_id}","type":"codeVoice"},{"text":".","type":"text"}],"type":"paragraph"}]},{"type":"aside","name":"Remark","style":"note","content":[{"inlineContent":[{"type":"text","text":"Generated from "},{"type":"codeVoice","code":"#\/paths\/\/users\/{username}\/collection\/folders\/{folder_id}\/releases\/{release_id}\/instances\/{instance_id}\/post(postChangeRatingOfRelease)"},{"type":"text","text":"."}],"type":"paragraph"}]}]}],"metadata":{"symbolKind":"enum","modules":[{"name":"DiscogsService"}],"role":"symbol","roleHeading":"Enumeration","externalID":"s:14DiscogsService10OperationsO25PostChangeRatingOfReleaseO","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"PostChangeRatingOfRelease"}],"navigatorTitle":[{"text":"PostChangeRatingOfRelease","kind":"identifier"}],"title":"Operations.PostChangeRatingOfRelease"},"schemaVersion":{"major":0,"patch":0,"minor":3},"topicSections":[{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostChangeRatingOfRelease\/Input"],"title":"Structures","generated":true,"anchor":"Structures"},{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostChangeRatingOfRelease\/id"],"title":"Type Properties","generated":true,"anchor":"Type-Properties"},{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostChangeRatingOfRelease\/AcceptableContentType","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostChangeRatingOfRelease\/Output"],"title":"Enumerations","generated":true,"anchor":"Enumerations"}],"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/discogsservice\/operations\/postchangeratingofrelease"]}],"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostChangeRatingOfRelease","interfaceLanguage":"swift"},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations"]]},"abstract":[{"text":"Update a rating for a specified release instance in a specified collection folder of a user.","type":"text"}],"references":{"doc://DiscogsService/documentation/DiscogsService/Operations":{"url":"\/documentation\/discogsservice\/operations","abstract":[{"text":"API operations, with input and output types, generated from ","type":"text"},{"code":"#\/paths","type":"codeVoice"},{"type":"text","text":" in the OpenAPI document."}],"navigatorTitle":[{"text":"Operations","kind":"identifier"}],"role":"symbol","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"text":"Operations","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","kind":"symbol","type":"topic","title":"Operations"},"doc://DiscogsService/documentation/DiscogsService/Operations/PostChangeRatingOfRelease/AcceptableContentType":{"abstract":[],"url":"\/documentation\/discogsservice\/operations\/postchangeratingofrelease\/acceptablecontenttype","kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostChangeRatingOfRelease\/AcceptableContentType","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AcceptableContentType","kind":"identifier"}],"navigatorTitle":[{"text":"AcceptableContentType","kind":"identifier"}],"role":"symbol","title":"Operations.PostChangeRatingOfRelease.AcceptableContentType","type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Operations/PostChangeRatingOfRelease/Output":{"role":"symbol","url":"\/documentation\/discogsservice\/operations\/postchangeratingofrelease\/output","kind":"symbol","title":"Operations.PostChangeRatingOfRelease.Output","abstract":[],"fragments":[{"kind":"keyword","text":"enum"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Output"}],"type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostChangeRatingOfRelease\/Output","navigatorTitle":[{"text":"Output","kind":"identifier"}]},"doc://DiscogsService/documentation/DiscogsService/Operations/PostChangeRatingOfRelease/id":{"url":"\/documentation\/discogsservice\/operations\/postchangeratingofrelease\/id","type":"topic","role":"symbol","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"id","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostChangeRatingOfRelease\/id","kind":"symbol","abstract":[],"title":"id"},"doc://DiscogsService/documentation/DiscogsService":{"role":"collection","type":"topic","title":"DiscogsService","kind":"symbol","url":"\/documentation\/discogsservice","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService","abstract":[{"type":"text","text":"A Swift client library for the Discogs API, built on top of Swift OpenAPI."}]},"doc://DiscogsService/documentation/DiscogsService/Operations/PostChangeRatingOfRelease":{"kind":"symbol","navigatorTitle":[{"text":"PostChangeRatingOfRelease","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostChangeRatingOfRelease","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PostChangeRatingOfRelease","kind":"identifier"}],"abstract":[{"text":"Update a rating for a specified release instance in a specified collection folder of a user.","type":"text"}],"title":"Operations.PostChangeRatingOfRelease","url":"\/documentation\/discogsservice\/operations\/postchangeratingofrelease","type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Operations/PostChangeRatingOfRelease/Input":{"title":"Operations.PostChangeRatingOfRelease.Input","navigatorTitle":[{"text":"Input","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostChangeRatingOfRelease\/Input","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Input","kind":"identifier"}],"kind":"symbol","abstract":[],"type":"topic","url":"\/documentation\/discogsservice\/operations\/postchangeratingofrelease\/input"}}} |