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.3 KiB
JSON
1 line
7.3 KiB
JSON
{"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations"]]},"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"GetCollectionItemsByRelease","kind":"identifier"}],"platforms":["macOS"]}],"kind":"declarations"},{"kind":"content","content":[{"text":"Overview","level":2,"anchor":"overview","type":"heading"},{"inlineContent":[{"type":"text","text":"Views those collection folder of a user which contain a specified release. This will also show information about each release instance."}],"type":"paragraph"},{"style":"important","content":[{"inlineContent":[{"text":"A given ","type":"text"},{"type":"codeVoice","code":"release_id"},{"text":" must not be ","type":"text"},{"type":"codeVoice","code":"0"},{"text":".","type":"text"}],"type":"paragraph"}],"name":"Important","type":"aside"},{"inlineContent":[{"type":"text","text":"This endpoint requires authentication as the collection owner only in case the collection is private."}],"type":"paragraph"},{"style":"note","content":[{"type":"paragraph","inlineContent":[{"text":"HTTP ","type":"text"},{"code":"GET \/users\/{username}\/collection\/releases\/{release_id}","type":"codeVoice"},{"text":".","type":"text"}]}],"name":"Remark","type":"aside"},{"style":"note","content":[{"type":"paragraph","inlineContent":[{"text":"Generated from ","type":"text"},{"code":"#\/paths\/\/users\/{username}\/collection\/releases\/{release_id}\/get(getCollectionItemsByRelease)","type":"codeVoice"},{"text":".","type":"text"}]}],"name":"Remark","type":"aside"}]}],"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByRelease","interfaceLanguage":"swift"},"schemaVersion":{"minor":3,"major":0,"patch":0},"sections":[],"kind":"symbol","abstract":[{"text":"Get collection items of a user that contains a given release.","type":"text"}],"variants":[{"paths":["\/documentation\/discogsservice\/operations\/getcollectionitemsbyrelease"],"traits":[{"interfaceLanguage":"swift"}]}],"topicSections":[{"generated":true,"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByRelease\/Input"],"anchor":"Structures","title":"Structures"},{"generated":true,"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByRelease\/id"],"anchor":"Type-Properties","title":"Type Properties"},{"generated":true,"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByRelease\/AcceptableContentType","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByRelease\/Output"],"anchor":"Enumerations","title":"Enumerations"}],"metadata":{"title":"Operations.GetCollectionItemsByRelease","symbolKind":"enum","roleHeading":"Enumeration","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"GetCollectionItemsByRelease","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"GetCollectionItemsByRelease"}],"modules":[{"name":"DiscogsService"}],"role":"symbol","externalID":"s:14DiscogsService10OperationsO27GetCollectionItemsByReleaseO"},"references":{"doc://DiscogsService/documentation/DiscogsService/Operations/GetCollectionItemsByRelease/id":{"url":"\/documentation\/discogsservice\/operations\/getcollectionitemsbyrelease\/id","role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByRelease\/id","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"id"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"abstract":[],"kind":"symbol","type":"topic","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":{"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/GetCollectionItemsByRelease/AcceptableContentType":{"url":"\/documentation\/discogsservice\/operations\/getcollectionitemsbyrelease\/acceptablecontenttype","navigatorTitle":[{"kind":"identifier","text":"AcceptableContentType"}],"abstract":[],"title":"Operations.GetCollectionItemsByRelease.AcceptableContentType","kind":"symbol","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"AcceptableContentType"}],"type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByRelease\/AcceptableContentType","role":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetCollectionItemsByRelease":{"role":"symbol","url":"\/documentation\/discogsservice\/operations\/getcollectionitemsbyrelease","kind":"symbol","title":"Operations.GetCollectionItemsByRelease","abstract":[{"text":"Get collection items of a user that contains a given release.","type":"text"}],"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"GetCollectionItemsByRelease"}],"type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByRelease","navigatorTitle":[{"kind":"identifier","text":"GetCollectionItemsByRelease"}]},"doc://DiscogsService/documentation/DiscogsService/Operations/GetCollectionItemsByRelease/Output":{"title":"Operations.GetCollectionItemsByRelease.Output","type":"topic","url":"\/documentation\/discogsservice\/operations\/getcollectionitemsbyrelease\/output","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Output"}],"navigatorTitle":[{"kind":"identifier","text":"Output"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByRelease\/Output","kind":"symbol","abstract":[],"role":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetCollectionItemsByRelease/Input":{"type":"topic","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Input"}],"navigatorTitle":[{"kind":"identifier","text":"Input"}],"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByRelease\/Input","abstract":[],"url":"\/documentation\/discogsservice\/operations\/getcollectionitemsbyrelease\/input","title":"Operations.GetCollectionItemsByRelease.Input"}}} |