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

{"relationshipsSections":[{"type":"conformsTo","title":"Conforms To","kind":"relationships","identifiers":["doc:\/\/DiscogsService\/Se","doc:\/\/DiscogsService\/SE","doc:\/\/DiscogsService\/SQ","doc:\/\/DiscogsService\/SH","doc:\/\/DiscogsService\/s8SendableP","doc:\/\/DiscogsService\/s16SendableMetatypeP"]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Video"}],"platforms":["macOS"]}]},{"content":[{"anchor":"overview","text":"Overview","level":2,"type":"heading"},{"name":"Remark","style":"note","content":[{"type":"paragraph","inlineContent":[{"text":"Generated from ","type":"text"},{"code":"#\/components\/schemas\/Video","type":"codeVoice"},{"text":".","type":"text"}]}],"type":"aside"}],"kind":"content"}],"metadata":{"symbolKind":"struct","role":"symbol","externalID":"s:14DiscogsService10ComponentsO7SchemasO5VideoV","roleHeading":"Structure","modules":[{"name":"DiscogsService"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Video"}],"navigatorTitle":[{"text":"Video","kind":"identifier"}],"title":"Components.Schemas.Video"},"schemaVersion":{"major":0,"minor":3,"patch":0},"topicSections":[{"generated":true,"anchor":"Initializers","title":"Initializers","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Video\/init(from:)","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Video\/init(uri:duration:title:description:embed:)"]},{"generated":true,"anchor":"Instance-Properties","title":"Instance Properties","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Video\/description","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Video\/duration","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Video\/embed","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Video\/title","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Video\/uri"]},{"generated":true,"anchor":"Enumerations","title":"Enumerations","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Video\/CodingKeys"]},{"generated":true,"anchor":"Default-Implementations","title":"Default Implementations","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Video\/Equatable-Implementations"]}],"sections":[],"variants":[{"paths":["\/documentation\/discogsservice\/components\/schemas\/video"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Video","interfaceLanguage":"swift"},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas"]]},"abstract":[{"text":"A type that represents a video.","type":"text"}],"references":{"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Video/CodingKeys":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Video\/CodingKeys","kind":"symbol","role":"symbol","type":"topic","title":"Components.Schemas.Video.CodingKeys","abstract":[],"url":"\/documentation\/discogsservice\/components\/schemas\/video\/codingkeys","navigatorTitle":[{"kind":"identifier","text":"CodingKeys"}],"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"CodingKeys"}]},"doc://DiscogsService/SQ":{"identifier":"doc:\/\/DiscogsService\/SQ","title":"Swift.Equatable","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/Video":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Video","title":"Components.Schemas.Video","url":"\/documentation\/discogsservice\/components\/schemas\/video","type":"topic","abstract":[{"text":"A type that represents a video.","type":"text"}],"kind":"symbol","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Video","kind":"identifier"}],"navigatorTitle":[{"text":"Video","kind":"identifier"}]},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Video/init(uri:duration:title:description:embed:)":{"url":"\/documentation\/discogsservice\/components\/schemas\/video\/init(uri:duration:title:description:embed:)","abstract":[{"type":"text","text":"Creates a new "},{"type":"codeVoice","code":"Video"},{"type":"text","text":"."}],"title":"init(uri:duration:title:description:embed:)","kind":"symbol","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"uri","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"duration","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Int","preciseIdentifier":"s:Si","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"title","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"description","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"embed","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"},{"text":")","kind":"text"}],"type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Video\/init(uri:duration:title:description:embed:)","role":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Video/description":{"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"description"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"type":"topic","role":"symbol","kind":"symbol","abstract":[{"text":"A description of a video.","type":"text"}],"title":"description","url":"\/documentation\/discogsservice\/components\/schemas\/video\/description","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Video\/description"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Video/duration":{"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"duration"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Si","text":"Int"}],"kind":"symbol","role":"symbol","url":"\/documentation\/discogsservice\/components\/schemas\/video\/duration","title":"duration","abstract":[{"text":"A duration of a video in number of seconds.","type":"text"}],"type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Video\/duration"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Video/uri":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Video\/uri","title":"uri","type":"topic","url":"\/documentation\/discogsservice\/components\/schemas\/video\/uri","abstract":[{"text":"A URI representation of a video.","type":"text"}],"kind":"symbol","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"uri","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}]},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Video/Equatable-Implementations":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Video\/Equatable-Implementations","abstract":[],"type":"topic","title":"Equatable Implementations","kind":"article","role":"collectionGroup","url":"\/documentation\/discogsservice\/components\/schemas\/video\/equatable-implementations"},"doc://DiscogsService/SH":{"type":"unresolvable","title":"Swift.Hashable","identifier":"doc:\/\/DiscogsService\/SH"},"doc://DiscogsService/Se":{"type":"unresolvable","identifier":"doc:\/\/DiscogsService\/Se","title":"Swift.Decodable"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Video/title":{"type":"topic","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"title","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"kind":"symbol","abstract":[{"type":"text","text":"A title of a video."}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Video\/title","url":"\/documentation\/discogsservice\/components\/schemas\/video\/title","title":"title"},"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/Video/embed":{"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"embed","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}],"type":"topic","role":"symbol","kind":"symbol","abstract":[{"type":"text","text":"A flag that indicates whether a video is embedded or not."}],"title":"embed","url":"\/documentation\/discogsservice\/components\/schemas\/video\/embed","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Video\/embed"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Video/init(from:)":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Video\/init(from:)","title":"init(from:)","type":"topic","url":"\/documentation\/discogsservice\/components\/schemas\/video\/init(from:)","abstract":[{"type":"text","text":"Creates a new instance by decoding from the given decoder."}],"kind":"symbol","role":"symbol","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"text":": any ","kind":"text"},{"preciseIdentifier":"s:s7DecoderP","text":"Decoder","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"}]},"doc://DiscogsService/s16SendableMetatypeP":{"type":"unresolvable","title":"Swift.SendableMetatype","identifier":"doc:\/\/DiscogsService\/s16SendableMetatypeP"},"doc://DiscogsService/s8SendableP":{"title":"Swift.Sendable","identifier":"doc:\/\/DiscogsService\/s8SendableP","type":"unresolvable"},"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/SE":{"type":"unresolvable","title":"Swift.Encodable","identifier":"doc:\/\/DiscogsService\/SE"}}}