Files
javier eaee2b84f0 Documentation update (#17)
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>
2026-03-24 01:54:43 +00:00

1 line
11 KiB
JSON

{"metadata":{"modules":[{"name":"DiscogsService"}],"roleHeading":"Initializer","symbolKind":"init","fragments":[{"kind":"identifier","text":"init"},{"text":"(","kind":"text"},{"text":"path","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"GetCollectionItemsByRelease","preciseIdentifier":"s:14DiscogsService10OperationsO27GetCollectionItemsByReleaseO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Input","preciseIdentifier":"s:14DiscogsService10OperationsO27GetCollectionItemsByReleaseO5InputV","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Path","preciseIdentifier":"s:14DiscogsService10OperationsO27GetCollectionItemsByReleaseO5InputV4PathV","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"GetCollectionItemsByRelease","preciseIdentifier":"s:14DiscogsService10OperationsO27GetCollectionItemsByReleaseO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Input","preciseIdentifier":"s:14DiscogsService10OperationsO27GetCollectionItemsByReleaseO5InputV","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Headers","preciseIdentifier":"s:14DiscogsService10OperationsO27GetCollectionItemsByReleaseO5InputV7HeadersV","kind":"typeIdentifier"},{"text":")","kind":"text"}],"role":"symbol","externalID":"s:14DiscogsService10OperationsO27GetCollectionItemsByReleaseO5InputV4path7headersA2G4PathV_AG7HeadersVtcfc","title":"init(path:headers:)"},"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByRelease","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByRelease\/Input"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"path"},{"kind":"text","text":": "},{"preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier","text":"Operations","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations"},{"text":".","kind":"text"},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByRelease","preciseIdentifier":"s:14DiscogsService10OperationsO27GetCollectionItemsByReleaseO","text":"GetCollectionItemsByRelease","kind":"typeIdentifier"},{"text":".","kind":"text"},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByRelease\/Input","preciseIdentifier":"s:14DiscogsService10OperationsO27GetCollectionItemsByReleaseO5InputV","text":"Input","kind":"typeIdentifier"},{"text":".","kind":"text"},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByRelease\/Input\/Path-swift.struct","preciseIdentifier":"s:14DiscogsService10OperationsO27GetCollectionItemsByReleaseO5InputV4PathV","text":"Path","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": ","kind":"text"},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByRelease","preciseIdentifier":"s:14DiscogsService10OperationsO27GetCollectionItemsByReleaseO","text":"GetCollectionItemsByRelease","kind":"typeIdentifier"},{"text":".","kind":"text"},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByRelease\/Input","preciseIdentifier":"s:14DiscogsService10OperationsO27GetCollectionItemsByReleaseO5InputV","text":"Input","kind":"typeIdentifier"},{"text":".","kind":"text"},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByRelease\/Input\/Headers-swift.struct","preciseIdentifier":"s:14DiscogsService10OperationsO27GetCollectionItemsByReleaseO5InputV7HeadersV","text":"Headers","kind":"typeIdentifier"},{"text":" = .init())","kind":"text"}],"platforms":["macOS"],"languages":["swift"]}]},{"parameters":[{"name":"path","content":[{"type":"paragraph","inlineContent":[{"text":"","type":"text"}]}]},{"name":"headers","content":[{"inlineContent":[{"type":"text","text":""}],"type":"paragraph"}]}],"kind":"parameters"}],"kind":"symbol","variants":[{"paths":["\/documentation\/discogsservice\/operations\/getcollectionitemsbyrelease\/input\/init(path:headers:)"],"traits":[{"interfaceLanguage":"swift"}]}],"abstract":[{"text":"Creates a new ","type":"text"},{"code":"Input","type":"codeVoice"},{"text":".","type":"text"}],"schemaVersion":{"patch":0,"major":0,"minor":3},"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByRelease\/Input\/init(path:headers:)"},"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/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"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetCollectionItemsByRelease/Input/init(path:headers:)":{"kind":"symbol","role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByRelease\/Input\/init(path:headers:)","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"path","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"GetCollectionItemsByRelease","preciseIdentifier":"s:14DiscogsService10OperationsO27GetCollectionItemsByReleaseO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Input","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO27GetCollectionItemsByReleaseO5InputV"},{"text":".","kind":"text"},{"text":"Path","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO27GetCollectionItemsByReleaseO5InputV4PathV"},{"text":", ","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"text":"GetCollectionItemsByRelease","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO27GetCollectionItemsByReleaseO"},{"text":".","kind":"text"},{"text":"Input","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO27GetCollectionItemsByReleaseO5InputV"},{"text":".","kind":"text"},{"text":"Headers","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO27GetCollectionItemsByReleaseO5InputV7HeadersV"},{"text":")","kind":"text"}],"abstract":[{"type":"text","text":"Creates a new "},{"code":"Input","type":"codeVoice"},{"text":".","type":"text"}],"title":"init(path:headers:)","url":"\/documentation\/discogsservice\/operations\/getcollectionitemsbyrelease\/input\/init(path:headers:)","type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetCollectionItemsByRelease/Input/Headers-swift.struct":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByRelease\/Input\/Headers-swift.struct","abstract":[],"type":"topic","title":"Operations.GetCollectionItemsByRelease.Input.Headers","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Headers"}],"kind":"symbol","role":"symbol","url":"\/documentation\/discogsservice\/operations\/getcollectionitemsbyrelease\/input\/headers-swift.struct","navigatorTitle":[{"kind":"identifier","text":"Headers"}]},"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":{"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/GetCollectionItemsByRelease/Input/Path-swift.struct":{"role":"symbol","url":"\/documentation\/discogsservice\/operations\/getcollectionitemsbyrelease\/input\/path-swift.struct","kind":"symbol","title":"Operations.GetCollectionItemsByRelease.Input.Path","abstract":[],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Path"}],"type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByRelease\/Input\/Path-swift.struct","navigatorTitle":[{"kind":"identifier","text":"Path"}]}}}