d5bd9feb0a
This PR contains the work done to write the main article of the `DocC` documentation for the library, which introduces the library as well as explains how to install it and use it. Reviewed-on: #7 Co-authored-by: Javier Cicchelli <javier@rock-n-code.com> Co-committed-by: Javier Cicchelli <javier@rock-n-code.com>
1 line
9.8 KiB
JSON
1 line
9.8 KiB
JSON
{"relationshipsSections":[{"type":"conformsTo","title":"Conforms To","identifiers":["doc:\/\/MarvelService\/SQ","doc:\/\/MarvelService\/SH","doc:\/\/MarvelService\/s8SendableP","doc:\/\/MarvelService\/s16SendableMetatypeP"],"kind":"relationships"}],"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/marvelservice\/operations\/getcharacterbyid\/output\/toomanyrequests-swift.struct\/body-swift.enum"]}],"primaryContentSections":[{"declarations":[{"tokens":[{"text":"@frozen","kind":"attribute"},{"text":" ","kind":"text"},{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Body","kind":"identifier"}],"platforms":["macOS"],"languages":["swift"]}],"kind":"declarations"},{"content":[{"level":2,"anchor":"overview","text":"Overview","type":"heading"},{"content":[{"inlineContent":[{"text":"Generated from ","type":"text"},{"code":"#\/paths\/v1\/public\/characters\/{characterId}\/GET\/responses\/429\/content","type":"codeVoice"},{"text":".","type":"text"}],"type":"paragraph"}],"style":"note","name":"Remark","type":"aside"}],"kind":"content"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"topicSections":[{"identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacterById\/Output\/TooManyRequests-swift.struct\/Body-swift.enum\/json(_:)"],"title":"Enumeration Cases","generated":true,"anchor":"Enumeration-Cases"},{"title":"Instance Properties","anchor":"Instance-Properties","identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacterById\/Output\/TooManyRequests-swift.struct\/Body-swift.enum\/json"],"generated":true},{"title":"Default Implementations","anchor":"Default-Implementations","identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacterById\/Output\/TooManyRequests-swift.struct\/Body-swift.enum\/Equatable-Implementations"],"generated":true}],"hierarchy":{"paths":[["doc:\/\/MarvelService\/documentation\/MarvelService","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacterById","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacterById\/Output","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacterById\/Output\/TooManyRequests-swift.struct"]]},"identifier":{"url":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacterById\/Output\/TooManyRequests-swift.struct\/Body-swift.enum","interfaceLanguage":"swift"},"kind":"symbol","metadata":{"symbolKind":"enum","role":"symbol","navigatorTitle":[{"text":"Body","kind":"identifier"}],"externalID":"s:13MarvelService10OperationsO16getCharacterByIdO6OutputO15TooManyRequestsV4BodyO","title":"Operations.getCharacterById.Output.TooManyRequests.Body","roleHeading":"Enumeration","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Body","kind":"identifier"}],"modules":[{"name":"MarvelService"}]},"references":{"doc://MarvelService/documentation/MarvelService/Operations/getCharacterById/Output/TooManyRequests-swift.struct/Body-swift.enum/json":{"url":"\/documentation\/marvelservice\/operations\/getcharacterbyid\/output\/toomanyrequests-swift.struct\/body-swift.enum\/json","title":"json","type":"topic","abstract":[{"text":"The associated value of the enum case if ","type":"text"},{"code":"self","type":"codeVoice"},{"text":" is ","type":"text"},{"code":".json","type":"codeVoice"},{"text":".","type":"text"}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacterById\/Output\/TooManyRequests-swift.struct\/Body-swift.enum\/json","kind":"symbol","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"json"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:13MarvelService10ComponentsO","kind":"typeIdentifier","text":"Components"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10ComponentsO7SchemasO","kind":"typeIdentifier","text":"Schemas"},{"text":".","kind":"text"},{"text":"StandardError","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10ComponentsO7SchemasO13StandardErrorV"}]},"doc://MarvelService/documentation/MarvelService/Operations/getCharacterById/Output":{"abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacterById\/Output","navigatorTitle":[{"text":"Output","kind":"identifier"}],"title":"Operations.getCharacterById.Output","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Output","kind":"identifier"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/operations\/getcharacterbyid\/output"},"doc://MarvelService/documentation/MarvelService/Operations":{"fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Operations","kind":"identifier"}],"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Operations"}],"url":"\/documentation\/marvelservice\/operations","title":"Operations","role":"symbol","abstract":[{"text":"API operations, with input and output types, generated from ","type":"text"},{"type":"codeVoice","code":"#\/paths"},{"type":"text","text":" in the OpenAPI document."}],"type":"topic"},"doc://MarvelService/documentation/MarvelService/Operations/getCharacterById":{"url":"\/documentation\/marvelservice\/operations\/getcharacterbyid","title":"Operations.getCharacterById","navigatorTitle":[{"kind":"identifier","text":"getCharacterById"}],"type":"topic","abstract":[{"text":"Fetches a single character by id.","type":"text"}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacterById","kind":"symbol","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"text":"getCharacterById","kind":"identifier"}]},"doc://MarvelService/documentation/MarvelService":{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService","kind":"symbol","url":"\/documentation\/marvelservice","title":"MarvelService","role":"collection","abstract":[{"text":"A library that allows the developer to interact with the ","type":"text"},{"type":"strong","inlineContent":[{"text":"Marvel Comics API","type":"text"}]},{"type":"text","text":" backend service."}],"type":"topic"},"doc://MarvelService/s8SendableP":{"title":"Swift.Sendable","identifier":"doc:\/\/MarvelService\/s8SendableP","type":"unresolvable"},"doc://MarvelService/SQ":{"type":"unresolvable","identifier":"doc:\/\/MarvelService\/SQ","title":"Swift.Equatable"},"doc://MarvelService/documentation/MarvelService/Operations/getCharacterById/Output/TooManyRequests-swift.struct/Body-swift.enum/json(_:)":{"abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacterById\/Output\/TooManyRequests-swift.struct\/Body-swift.enum\/json(_:)","title":"Operations.getCharacterById.Output.TooManyRequests.Body.json(_:)","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"json","kind":"identifier"},{"text":"(","kind":"text"},{"text":"Components","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10ComponentsO"},{"text":".","kind":"text"},{"text":"Schemas","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10ComponentsO7SchemasO"},{"text":".","kind":"text"},{"text":"StandardError","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10ComponentsO7SchemasO13StandardErrorV"},{"text":")","kind":"text"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/operations\/getcharacterbyid\/output\/toomanyrequests-swift.struct\/body-swift.enum\/json(_:)"},"doc://MarvelService/documentation/MarvelService/Operations/getCharacterById/Output/TooManyRequests-swift.struct":{"title":"Operations.getCharacterById.Output.TooManyRequests","abstract":[],"url":"\/documentation\/marvelservice\/operations\/getcharacterbyid\/output\/toomanyrequests-swift.struct","navigatorTitle":[{"text":"TooManyRequests","kind":"identifier"}],"kind":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacterById\/Output\/TooManyRequests-swift.struct","type":"topic","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"TooManyRequests","kind":"identifier"}]},"doc://MarvelService/s16SendableMetatypeP":{"type":"unresolvable","identifier":"doc:\/\/MarvelService\/s16SendableMetatypeP","title":"Swift.SendableMetatype"},"doc://MarvelService/documentation/MarvelService/Operations/getCharacterById/Output/TooManyRequests-swift.struct/Body-swift.enum/Equatable-Implementations":{"abstract":[],"role":"collectionGroup","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacterById\/Output\/TooManyRequests-swift.struct\/Body-swift.enum\/Equatable-Implementations","title":"Equatable Implementations","kind":"article","type":"topic","url":"\/documentation\/marvelservice\/operations\/getcharacterbyid\/output\/toomanyrequests-swift.struct\/body-swift.enum\/equatable-implementations"},"doc://MarvelService/SH":{"type":"unresolvable","identifier":"doc:\/\/MarvelService\/SH","title":"Swift.Hashable"},"doc://MarvelService/documentation/MarvelService/Operations/getCharacterById/Output/TooManyRequests-swift.struct/Body-swift.enum":{"abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacterById\/Output\/TooManyRequests-swift.struct\/Body-swift.enum","navigatorTitle":[{"text":"Body","kind":"identifier"}],"title":"Operations.getCharacterById.Output.TooManyRequests.Body","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Body","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/marvelservice\/operations\/getcharacterbyid\/output\/toomanyrequests-swift.struct\/body-swift.enum","type":"topic"}}} |