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
6.9 KiB
JSON

{"metadata":{"modules":[{"name":"DiscogsService"}],"role":"symbol","roleHeading":"Initializer","title":"init(mainRelease:mainReleaseUrl:versionsUrl:)","symbolKind":"init","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"mainRelease"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Si","text":"Int"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"mainReleaseUrl"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"versionsUrl"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":"?)"}],"externalID":"s:14DiscogsService10ComponentsO7SchemasO6MasterV13Value2PayloadV11mainRelease0hI3Url08versionsJ0AISiSg_SSSgANtcfc"},"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Master","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Master\/Value2Payload"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["macOS"],"languages":["swift"],"tokens":[{"text":"init","kind":"keyword"},{"text":"(","kind":"text"},{"text":"mainRelease","kind":"externalParam"},{"kind":"text","text":": "},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"},{"text":"? = nil, ","kind":"text"},{"text":"mainReleaseUrl","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"? = nil, ","kind":"text"},{"text":"versionsUrl","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"? = nil)"}]}]},{"kind":"parameters","parameters":[{"name":"mainRelease","content":[{"type":"paragraph","inlineContent":[{"text":"An identifier of the main release for this master.","type":"text"}]}]},{"name":"mainReleaseUrl","content":[{"type":"paragraph","inlineContent":[{"text":"A URL link of the main release for this master.","type":"text"}]}]},{"name":"versionsUrl","content":[{"type":"paragraph","inlineContent":[{"text":"A URL link to the versions of this master.","type":"text"}]}]}]}],"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/discogsservice\/components\/schemas\/master\/value2payload\/init(mainrelease:mainreleaseurl:versionsurl:)"]}],"abstract":[{"text":"Creates a new ","type":"text"},{"code":"Value2Payload","type":"codeVoice"},{"text":".","type":"text"}],"schemaVersion":{"major":0,"patch":0,"minor":3},"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Master\/Value2Payload\/init(mainRelease:mainReleaseUrl:versionsUrl:)"},"references":{"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Master":{"title":"Components.Schemas.Master","type":"topic","url":"\/documentation\/discogsservice\/components\/schemas\/master","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Master"}],"navigatorTitle":[{"kind":"identifier","text":"Master"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Master","kind":"symbol","abstract":[{"type":"text","text":"A type that represents a set of similar releases."}],"role":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Components":{"fragments":[{"kind":"keyword","text":"enum"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Components"}],"type":"topic","navigatorTitle":[{"kind":"identifier","text":"Components"}],"role":"symbol","kind":"symbol","abstract":[{"text":"Types generated from the components section of the OpenAPI document.","type":"text"}],"title":"Components","url":"\/documentation\/discogsservice\/components","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Master/Value2Payload":{"url":"\/documentation\/discogsservice\/components\/schemas\/master\/value2payload","navigatorTitle":[{"kind":"identifier","text":"Value2Payload"}],"role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Master\/Value2Payload","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Value2Payload"}],"abstract":[],"kind":"symbol","type":"topic","title":"Components.Schemas.Master.Value2Payload"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas","kind":"symbol","role":"symbol","type":"topic","title":"Components.Schemas","abstract":[{"type":"text","text":"Types generated from the "},{"code":"#\/components\/schemas","type":"codeVoice"},{"text":" section of the OpenAPI document.","type":"text"}],"url":"\/documentation\/discogsservice\/components\/schemas","navigatorTitle":[{"kind":"identifier","text":"Schemas"}],"fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Schemas"}]},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Master/Value2Payload/init(mainRelease:mainReleaseUrl:versionsUrl:)":{"role":"symbol","url":"\/documentation\/discogsservice\/components\/schemas\/master\/value2payload\/init(mainrelease:mainreleaseurl:versionsurl:)","kind":"symbol","title":"init(mainRelease:mainReleaseUrl:versionsUrl:)","abstract":[{"text":"Creates a new ","type":"text"},{"code":"Value2Payload","type":"codeVoice"},{"text":".","type":"text"}],"fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"mainRelease"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"mainReleaseUrl"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"versionsUrl"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?)"}],"type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Master\/Value2Payload\/init(mainRelease:mainReleaseUrl:versionsUrl:)"},"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."}]}}}