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
11 KiB
JSON
1 line
11 KiB
JSON
{"hierarchy":{"paths":[["doc:\/\/MarvelService\/documentation\/MarvelService","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacterById"]]},"identifier":{"url":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacterById\/Input","interfaceLanguage":"swift"},"topicSections":[{"anchor":"Structures","title":"Structures","identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacterById\/Input\/Headers-swift.struct","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacterById\/Input\/Path-swift.struct"],"generated":true},{"anchor":"Initializers","title":"Initializers","identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacterById\/Input\/init(path:headers:)"],"generated":true},{"anchor":"Instance-Properties","title":"Instance Properties","identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacterById\/Input\/headers-swift.property","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacterById\/Input\/path-swift.property"],"generated":true},{"anchor":"Default-Implementations","title":"Default Implementations","identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacterById\/Input\/Equatable-Implementations"],"generated":true}],"metadata":{"title":"Operations.getCharacterById.Input","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Input"}],"externalID":"s:13MarvelService10OperationsO16getCharacterByIdO5InputV","roleHeading":"Structure","role":"symbol","symbolKind":"struct","modules":[{"name":"MarvelService"}],"navigatorTitle":[{"text":"Input","kind":"identifier"}]},"schemaVersion":{"patch":0,"major":0,"minor":3},"kind":"symbol","sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["macOS"],"tokens":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Input"}]}]}],"variants":[{"paths":["\/documentation\/marvelservice\/operations\/getcharacterbyid\/input"],"traits":[{"interfaceLanguage":"swift"}]}],"relationshipsSections":[{"identifiers":["doc:\/\/MarvelService\/SQ","doc:\/\/MarvelService\/SH","doc:\/\/MarvelService\/s8SendableP","doc:\/\/MarvelService\/s16SendableMetatypeP"],"type":"conformsTo","kind":"relationships","title":"Conforms To"}],"references":{"doc://MarvelService/documentation/MarvelService/Operations/getCharacterById/Input":{"title":"Operations.getCharacterById.Input","abstract":[],"url":"\/documentation\/marvelservice\/operations\/getcharacterbyid\/input","navigatorTitle":[{"text":"Input","kind":"identifier"}],"kind":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacterById\/Input","type":"topic","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Input"}]},"doc://MarvelService/documentation/MarvelService/Operations/getCharacterById/Input/init(path:headers:)":{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacterById\/Input\/init(path:headers:)","title":"init(path:headers:)","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"path","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO16getCharacterByIdO","text":"getCharacterById","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO16getCharacterByIdO5InputV","text":"Input","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO16getCharacterByIdO5InputV4PathV","text":"Path","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO16getCharacterByIdO","text":"getCharacterById","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO16getCharacterByIdO5InputV","text":"Input","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO16getCharacterByIdO5InputV7HeadersV","text":"Headers","kind":"typeIdentifier"},{"text":")","kind":"text"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/operations\/getcharacterbyid\/input\/init(path:headers:)","role":"symbol","abstract":[{"text":"Creates a new ","type":"text"},{"code":"Input","type":"codeVoice"},{"text":".","type":"text"}]},"doc://MarvelService/documentation/MarvelService/Operations/getCharacterById/Input/path-swift.property":{"url":"\/documentation\/marvelservice\/operations\/getcharacterbyid\/input\/path-swift.property","title":"path","type":"topic","abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacterById\/Input\/path-swift.property","kind":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"path","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO16getCharacterByIdO","kind":"typeIdentifier","text":"getCharacterById"},{"kind":"text","text":"."},{"text":"Input","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO16getCharacterByIdO5InputV"},{"text":".","kind":"text"},{"text":"Path","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO16getCharacterByIdO5InputV4PathV"}]},"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":{"type":"unresolvable","identifier":"doc:\/\/MarvelService\/s8SendableP","title":"Swift.Sendable"},"doc://MarvelService/SQ":{"type":"unresolvable","identifier":"doc:\/\/MarvelService\/SQ","title":"Swift.Equatable"},"doc://MarvelService/s16SendableMetatypeP":{"type":"unresolvable","identifier":"doc:\/\/MarvelService\/s16SendableMetatypeP","title":"Swift.SendableMetatype"},"doc://MarvelService/documentation/MarvelService/Operations/getCharacterById/Input/Equatable-Implementations":{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacterById\/Input\/Equatable-Implementations","title":"Equatable Implementations","kind":"article","type":"topic","url":"\/documentation\/marvelservice\/operations\/getcharacterbyid\/input\/equatable-implementations","role":"collectionGroup","abstract":[]},"doc://MarvelService/documentation/MarvelService/Operations/getCharacterById/Input/Path-swift.struct":{"abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacterById\/Input\/Path-swift.struct","navigatorTitle":[{"text":"Path","kind":"identifier"}],"title":"Operations.getCharacterById.Input.Path","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Path","kind":"identifier"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/operations\/getcharacterbyid\/input\/path-swift.struct"},"doc://MarvelService/documentation/MarvelService/Operations/getCharacterById/Input/Headers-swift.struct":{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacterById\/Input\/Headers-swift.struct","title":"Operations.getCharacterById.Input.Headers","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"Headers","kind":"identifier"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/operations\/getcharacterbyid\/input\/headers-swift.struct","role":"symbol","navigatorTitle":[{"text":"Headers","kind":"identifier"}],"abstract":[]},"doc://MarvelService/SH":{"type":"unresolvable","identifier":"doc:\/\/MarvelService\/SH","title":"Swift.Hashable"},"doc://MarvelService/documentation/MarvelService/Operations/getCharacterById/Input/headers-swift.property":{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacterById\/Input\/headers-swift.property","title":"headers","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"headers","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO16getCharacterByIdO","text":"getCharacterById","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO16getCharacterByIdO5InputV","text":"Input","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO16getCharacterByIdO5InputV7HeadersV","text":"Headers","kind":"typeIdentifier"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/operations\/getcharacterbyid\/input\/headers-swift.property","role":"symbol","abstract":[]}}} |