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

{"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseVersion"]]},"primaryContentSections":[{"declarations":[{"platforms":["macOS"],"languages":["swift"],"tokens":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"StatsPayload","kind":"identifier"}]}],"kind":"declarations"},{"content":[{"type":"heading","text":"Overview","anchor":"overview","level":2},{"content":[{"inlineContent":[{"type":"text","text":"Generated from "},{"code":"#\/components\/schemas\/ReleaseVersion\/stats","type":"codeVoice"},{"type":"text","text":"."}],"type":"paragraph"}],"type":"aside","name":"Remark","style":"note"}],"kind":"content"}],"relationshipsSections":[{"type":"conformsTo","title":"Conforms To","identifiers":["doc:\/\/DiscogsService\/Se","doc:\/\/DiscogsService\/SE","doc:\/\/DiscogsService\/SQ","doc:\/\/DiscogsService\/SH","doc:\/\/DiscogsService\/s8SendableP","doc:\/\/DiscogsService\/s16SendableMetatypeP"],"kind":"relationships"}],"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseVersion\/StatsPayload","interfaceLanguage":"swift"},"schemaVersion":{"minor":3,"major":0,"patch":0},"kind":"symbol","sections":[],"abstract":[{"text":"A type contains statistics about a release version.","type":"text"}],"variants":[{"paths":["\/documentation\/discogsservice\/components\/schemas\/releaseversion\/statspayload"],"traits":[{"interfaceLanguage":"swift"}]}],"topicSections":[{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseVersion\/StatsPayload\/CommunityPayload"],"title":"Structures","generated":true,"anchor":"Structures"},{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseVersion\/StatsPayload\/init(community:)","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseVersion\/StatsPayload\/init(from:)"],"title":"Initializers","generated":true,"anchor":"Initializers"},{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseVersion\/StatsPayload\/community"],"title":"Instance Properties","generated":true,"anchor":"Instance-Properties"},{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseVersion\/StatsPayload\/CodingKeys"],"title":"Enumerations","generated":true,"anchor":"Enumerations"},{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseVersion\/StatsPayload\/Equatable-Implementations"],"title":"Default Implementations","generated":true,"anchor":"Default-Implementations"}],"metadata":{"title":"Components.Schemas.ReleaseVersion.StatsPayload","symbolKind":"struct","roleHeading":"Structure","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"StatsPayload"}],"navigatorTitle":[{"text":"StatsPayload","kind":"identifier"}],"modules":[{"name":"DiscogsService"}],"role":"symbol","externalID":"s:14DiscogsService10ComponentsO7SchemasO14ReleaseVersionV12StatsPayloadV"},"references":{"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ReleaseVersion/StatsPayload/Equatable-Implementations":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseVersion\/StatsPayload\/Equatable-Implementations","title":"Equatable Implementations","type":"topic","url":"\/documentation\/discogsservice\/components\/schemas\/releaseversion\/statspayload\/equatable-implementations","abstract":[],"kind":"article","role":"collectionGroup"},"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/ReleaseVersion/StatsPayload/init(community:)":{"abstract":[{"text":"Creates a new ","type":"text"},{"type":"codeVoice","code":"StatsPayload"},{"text":".","type":"text"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseVersion\/StatsPayload\/init(community:)","role":"symbol","fragments":[{"kind":"identifier","text":"init"},{"text":"(","kind":"text"},{"text":"community","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Components","preciseIdentifier":"s:14DiscogsService10ComponentsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Schemas","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO"},{"text":".","kind":"text"},{"text":"ReleaseVersion","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO14ReleaseVersionV"},{"text":".","kind":"text"},{"text":"StatsPayload","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO14ReleaseVersionV12StatsPayloadV"},{"text":".","kind":"text"},{"text":"CommunityPayload","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO14ReleaseVersionV12StatsPayloadV09CommunityH0V"},{"text":"?)","kind":"text"}],"title":"init(community:)","kind":"symbol","url":"\/documentation\/discogsservice\/components\/schemas\/releaseversion\/statspayload\/init(community:)","type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ReleaseVersion/StatsPayload/CommunityPayload":{"abstract":[{"type":"text","text":"A type that represents the relationship between users and a release version."}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseVersion\/StatsPayload\/CommunityPayload","role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CommunityPayload"}],"navigatorTitle":[{"text":"CommunityPayload","kind":"identifier"}],"title":"Components.Schemas.ReleaseVersion.StatsPayload.CommunityPayload","type":"topic","kind":"symbol","url":"\/documentation\/discogsservice\/components\/schemas\/releaseversion\/statspayload\/communitypayload"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ReleaseVersion/StatsPayload/community":{"role":"symbol","url":"\/documentation\/discogsservice\/components\/schemas\/releaseversion\/statspayload\/community","kind":"symbol","title":"community","abstract":[{"type":"text","text":"A type that represents the relationship between users and a release version."}],"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"community"},{"kind":"text","text":": "},{"text":"Components","preciseIdentifier":"s:14DiscogsService10ComponentsO","kind":"typeIdentifier"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO","kind":"typeIdentifier","text":"Schemas"},{"text":".","kind":"text"},{"text":"ReleaseVersion","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO14ReleaseVersionV"},{"text":".","kind":"text"},{"text":"StatsPayload","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO14ReleaseVersionV12StatsPayloadV"},{"text":".","kind":"text"},{"text":"CommunityPayload","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO14ReleaseVersionV12StatsPayloadV09CommunityH0V"},{"text":"?","kind":"text"}],"type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseVersion\/StatsPayload\/community"},"doc://DiscogsService/SQ":{"identifier":"doc:\/\/DiscogsService\/SQ","type":"unresolvable","title":"Swift.Equatable"},"doc://DiscogsService/s8SendableP":{"identifier":"doc:\/\/DiscogsService\/s8SendableP","type":"unresolvable","title":"Swift.Sendable"},"doc://DiscogsService/Se":{"identifier":"doc:\/\/DiscogsService\/Se","type":"unresolvable","title":"Swift.Decodable"},"doc://DiscogsService/s16SendableMetatypeP":{"identifier":"doc:\/\/DiscogsService\/s16SendableMetatypeP","type":"unresolvable","title":"Swift.SendableMetatype"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ReleaseVersion/StatsPayload/init(from:)":{"url":"\/documentation\/discogsservice\/components\/schemas\/releaseversion\/statspayload\/init(from:)","kind":"symbol","role":"symbol","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"text":": any ","kind":"text"},{"text":"Decoder","preciseIdentifier":"s:s7DecoderP","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseVersion\/StatsPayload\/init(from:)","abstract":[{"type":"text","text":"Creates a new instance by decoding from the given decoder."}],"type":"topic","title":"init(from:)"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ReleaseVersion":{"type":"topic","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"ReleaseVersion","kind":"identifier"}],"navigatorTitle":[{"text":"ReleaseVersion","kind":"identifier"}],"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseVersion","abstract":[{"text":"A type that represents a version of a release.","type":"text"}],"title":"Components.Schemas.ReleaseVersion","url":"\/documentation\/discogsservice\/components\/schemas\/releaseversion"},"doc://DiscogsService/SE":{"identifier":"doc:\/\/DiscogsService\/SE","title":"Swift.Encodable","type":"unresolvable"},"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/ReleaseVersion/StatsPayload":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseVersion\/StatsPayload","title":"Components.Schemas.ReleaseVersion.StatsPayload","url":"\/documentation\/discogsservice\/components\/schemas\/releaseversion\/statspayload","type":"topic","abstract":[{"type":"text","text":"A type contains statistics about a release version."}],"kind":"symbol","role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"StatsPayload"}],"navigatorTitle":[{"kind":"identifier","text":"StatsPayload"}]},"doc://DiscogsService/SH":{"identifier":"doc:\/\/DiscogsService\/SH","type":"unresolvable","title":"Swift.Hashable"},"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/Components/Schemas/ReleaseVersion/StatsPayload/CodingKeys":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseVersion\/StatsPayload\/CodingKeys","title":"Components.Schemas.ReleaseVersion.StatsPayload.CodingKeys","url":"\/documentation\/discogsservice\/components\/schemas\/releaseversion\/statspayload\/codingkeys","type":"topic","abstract":[],"kind":"symbol","role":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CodingKeys","kind":"identifier"}],"navigatorTitle":[{"text":"CodingKeys","kind":"identifier"}]}}}