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

{"schemaVersion":{"major":0,"minor":3,"patch":0},"relationshipsSections":[{"identifiers":["doc:\/\/DiscogsService\/SQ","doc:\/\/DiscogsService\/s5ErrorP","doc:\/\/DiscogsService\/SH","doc:\/\/DiscogsService\/s8SendableP","doc:\/\/DiscogsService\/s16SendableMetatypeP"],"kind":"relationships","title":"Conforms To","type":"conformsTo"}],"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService"]]},"kind":"symbol","topicSections":[{"generated":true,"title":"Enumeration Cases","anchor":"Enumeration-Cases","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/InputValidationError\/inputIsEmpty","doc:\/\/DiscogsService\/documentation\/DiscogsService\/InputValidationError\/inputIsNil","doc:\/\/DiscogsService\/documentation\/DiscogsService\/InputValidationError\/inputNotCamelCase","doc:\/\/DiscogsService\/documentation\/DiscogsService\/InputValidationError\/inputNotConsumerKey","doc:\/\/DiscogsService\/documentation\/DiscogsService\/InputValidationError\/inputNotConsumerSecret","doc:\/\/DiscogsService\/documentation\/DiscogsService\/InputValidationError\/inputNotSemanticVersion","doc:\/\/DiscogsService\/documentation\/DiscogsService\/InputValidationError\/inputNotURL","doc:\/\/DiscogsService\/documentation\/DiscogsService\/InputValidationError\/inputNotUserToken"]},{"anchor":"Default-Implementations","title":"Default Implementations","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/InputValidationError\/Equatable-Implementations","doc:\/\/DiscogsService\/documentation\/DiscogsService\/InputValidationError\/Error-Implementations"],"generated":true}],"metadata":{"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"InputValidationError"}],"roleHeading":"Enumeration","externalID":"s:14DiscogsService20InputValidationErrorO","modules":[{"name":"DiscogsService"}],"symbolKind":"enum","role":"symbol","title":"InputValidationError","navigatorTitle":[{"kind":"identifier","text":"InputValidationError"}]},"abstract":[{"type":"text","text":"A representation of all the possible validation errors that could be thrown while validating an input."}],"primaryContentSections":[{"declarations":[{"platforms":["macOS"],"tokens":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"InputValidationError","kind":"identifier"}],"languages":["swift"]}],"kind":"declarations"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/discogsservice\/inputvalidationerror"]}],"sections":[],"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/InputValidationError","interfaceLanguage":"swift"},"references":{"doc://DiscogsService/documentation/DiscogsService/InputValidationError/inputNotConsumerSecret":{"role":"symbol","url":"\/documentation\/discogsservice\/inputvalidationerror\/inputnotconsumersecret","kind":"symbol","title":"InputValidationError.inputNotConsumerSecret","abstract":[{"type":"text","text":"An input does not comply with the consumer secret requirements."}],"fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"text":"inputNotConsumerSecret","kind":"identifier"}],"type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/InputValidationError\/inputNotConsumerSecret"},"doc://DiscogsService/SH":{"type":"unresolvable","title":"Swift.Hashable","identifier":"doc:\/\/DiscogsService\/SH"},"doc://DiscogsService/documentation/DiscogsService/InputValidationError/inputNotUserToken":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/InputValidationError\/inputNotUserToken","kind":"symbol","role":"symbol","type":"topic","title":"InputValidationError.inputNotUserToken","abstract":[{"text":"An input does not comply with the user token requirements.","type":"text"}],"url":"\/documentation\/discogsservice\/inputvalidationerror\/inputnotusertoken","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"inputNotUserToken","kind":"identifier"}]},"doc://DiscogsService/SQ":{"type":"unresolvable","title":"Swift.Equatable","identifier":"doc:\/\/DiscogsService\/SQ"},"doc://DiscogsService/documentation/DiscogsService/InputValidationError/Equatable-Implementations":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/InputValidationError\/Equatable-Implementations","title":"Equatable Implementations","type":"topic","url":"\/documentation\/discogsservice\/inputvalidationerror\/equatable-implementations","abstract":[],"kind":"article","role":"collectionGroup"},"doc://DiscogsService/documentation/DiscogsService/InputValidationError":{"abstract":[{"type":"text","text":"A representation of all the possible validation errors that could be thrown while validating an input."}],"url":"\/documentation\/discogsservice\/inputvalidationerror","kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/InputValidationError","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"InputValidationError"}],"navigatorTitle":[{"kind":"identifier","text":"InputValidationError"}],"role":"symbol","title":"InputValidationError","type":"topic"},"doc://DiscogsService/documentation/DiscogsService/InputValidationError/inputIsNil":{"kind":"symbol","fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"inputIsNil"}],"title":"InputValidationError.inputIsNil","url":"\/documentation\/discogsservice\/inputvalidationerror\/inputisnil","abstract":[{"text":"An input is nil.","type":"text"}],"type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/InputValidationError\/inputIsNil","role":"symbol"},"doc://DiscogsService/documentation/DiscogsService/InputValidationError/inputNotConsumerKey":{"fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"inputNotConsumerKey","kind":"identifier"}],"role":"symbol","type":"topic","title":"InputValidationError.inputNotConsumerKey","kind":"symbol","url":"\/documentation\/discogsservice\/inputvalidationerror\/inputnotconsumerkey","abstract":[{"type":"text","text":"An input does not comply with the consumer key requirements."}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/InputValidationError\/inputNotConsumerKey"},"doc://DiscogsService/s5ErrorP":{"identifier":"doc:\/\/DiscogsService\/s5ErrorP","type":"unresolvable","title":"Swift.Error"},"doc://DiscogsService/s8SendableP":{"type":"unresolvable","title":"Swift.Sendable","identifier":"doc:\/\/DiscogsService\/s8SendableP"},"doc://DiscogsService/documentation/DiscogsService/InputValidationError/Error-Implementations":{"role":"collectionGroup","type":"topic","kind":"article","title":"Error Implementations","url":"\/documentation\/discogsservice\/inputvalidationerror\/error-implementations","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/InputValidationError\/Error-Implementations","abstract":[]},"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/InputValidationError/inputNotURL":{"url":"\/documentation\/discogsservice\/inputvalidationerror\/inputnoturl","abstract":[{"type":"text","text":"An input is not a URL."}],"title":"InputValidationError.inputNotURL","kind":"symbol","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"inputNotURL","kind":"identifier"}],"type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/InputValidationError\/inputNotURL","role":"symbol"},"doc://DiscogsService/documentation/DiscogsService/InputValidationError/inputNotSemanticVersion":{"role":"symbol","url":"\/documentation\/discogsservice\/inputvalidationerror\/inputnotsemanticversion","kind":"symbol","title":"InputValidationError.inputNotSemanticVersion","abstract":[{"text":"An input is not a semantic version.","type":"text"}],"fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"inputNotSemanticVersion","kind":"identifier"}],"type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/InputValidationError\/inputNotSemanticVersion"},"doc://DiscogsService/documentation/DiscogsService/InputValidationError/inputNotCamelCase":{"fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"inputNotCamelCase","kind":"identifier"}],"kind":"symbol","role":"symbol","type":"topic","url":"\/documentation\/discogsservice\/inputvalidationerror\/inputnotcamelcase","title":"InputValidationError.inputNotCamelCase","abstract":[{"type":"text","text":"An input is not camel-case."}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/InputValidationError\/inputNotCamelCase"},"doc://DiscogsService/documentation/DiscogsService/InputValidationError/inputIsEmpty":{"url":"\/documentation\/discogsservice\/inputvalidationerror\/inputisempty","type":"topic","role":"symbol","fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"inputIsEmpty"}],"abstract":[{"text":"An input is empty.","type":"text"}],"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/InputValidationError\/inputIsEmpty","title":"InputValidationError.inputIsEmpty"},"doc://DiscogsService/s16SendableMetatypeP":{"identifier":"doc:\/\/DiscogsService\/s16SendableMetatypeP","type":"unresolvable","title":"Swift.SendableMetatype"}}}