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
8.8 KiB
JSON
1 line
8.8 KiB
JSON
{"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\/MethodNotAllowed-swift.struct"]]},"identifier":{"url":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacterById\/Output\/MethodNotAllowed-swift.struct\/init(body:)","interfaceLanguage":"swift"},"schemaVersion":{"major":0,"minor":3,"patch":0},"metadata":{"title":"init(body:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"body"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Operations","preciseIdentifier":"s:13MarvelService10OperationsO"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO16getCharacterByIdO","text":"getCharacterById","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO16getCharacterByIdO6OutputO","kind":"typeIdentifier","text":"Output"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"MethodNotAllowed","preciseIdentifier":"s:13MarvelService10OperationsO16getCharacterByIdO6OutputO16MethodNotAllowedV"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Body","preciseIdentifier":"s:13MarvelService10OperationsO16getCharacterByIdO6OutputO16MethodNotAllowedV4BodyO"},{"kind":"text","text":")"}],"role":"symbol","roleHeading":"Initializer","externalID":"s:13MarvelService10OperationsO16getCharacterByIdO6OutputO16MethodNotAllowedV4bodyA2I4BodyO_tcfc","symbolKind":"init","modules":[{"name":"MarvelService"}]},"kind":"symbol","sections":[],"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"text":"init","kind":"keyword"},{"kind":"text","text":"("},{"kind":"externalParam","text":"body"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","text":"Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO16getCharacterByIdO","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacterById","text":"getCharacterById","kind":"typeIdentifier"},{"kind":"text","text":"."},{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacterById\/Output","preciseIdentifier":"s:13MarvelService10OperationsO16getCharacterByIdO6OutputO","kind":"typeIdentifier","text":"Output"},{"text":".","kind":"text"},{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacterById\/Output\/MethodNotAllowed-swift.struct","preciseIdentifier":"s:13MarvelService10OperationsO16getCharacterByIdO6OutputO16MethodNotAllowedV","kind":"typeIdentifier","text":"MethodNotAllowed"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO16getCharacterByIdO6OutputO16MethodNotAllowedV4BodyO","text":"Body","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacterById\/Output\/MethodNotAllowed-swift.struct\/Body-swift.enum","kind":"typeIdentifier"},{"kind":"text","text":")"}],"platforms":["macOS"]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"name":"body","content":[{"inlineContent":[{"type":"text","text":"Received HTTP response body"}],"type":"paragraph"}]}]}],"variants":[{"paths":["\/documentation\/marvelservice\/operations\/getcharacterbyid\/output\/methodnotallowed-swift.struct\/init(body:)"],"traits":[{"interfaceLanguage":"swift"}]}],"abstract":[{"type":"text","text":"Creates a new "},{"type":"codeVoice","code":"MethodNotAllowed"},{"type":"text","text":"."}],"references":{"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/Output/MethodNotAllowed-swift.struct/Body-swift.enum":{"abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacterById\/Output\/MethodNotAllowed-swift.struct\/Body-swift.enum","navigatorTitle":[{"kind":"identifier","text":"Body"}],"title":"Operations.getCharacterById.Output.MethodNotAllowed.Body","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Body"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/operations\/getcharacterbyid\/output\/methodnotallowed-swift.struct\/body-swift.enum"},"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/Operations/getCharacterById/Output/MethodNotAllowed-swift.struct":{"url":"\/documentation\/marvelservice\/operations\/getcharacterbyid\/output\/methodnotallowed-swift.struct","title":"Operations.getCharacterById.Output.MethodNotAllowed","navigatorTitle":[{"kind":"identifier","text":"MethodNotAllowed"}],"type":"topic","abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacterById\/Output\/MethodNotAllowed-swift.struct","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"MethodNotAllowed"}]},"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/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/getCharacterById/Output/MethodNotAllowed-swift.struct/init(body:)":{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacterById\/Output\/MethodNotAllowed-swift.struct\/init(body:)","title":"init(body:)","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"body","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","preciseIdentifier":"s:13MarvelService10OperationsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"getCharacterById","preciseIdentifier":"s:13MarvelService10OperationsO16getCharacterByIdO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Output","preciseIdentifier":"s:13MarvelService10OperationsO16getCharacterByIdO6OutputO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"MethodNotAllowed","preciseIdentifier":"s:13MarvelService10OperationsO16getCharacterByIdO6OutputO16MethodNotAllowedV","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Body","preciseIdentifier":"s:13MarvelService10OperationsO16getCharacterByIdO6OutputO16MethodNotAllowedV4BodyO","kind":"typeIdentifier"},{"text":")","kind":"text"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/operations\/getcharacterbyid\/output\/methodnotallowed-swift.struct\/init(body:)","role":"symbol","abstract":[{"type":"text","text":"Creates a new "},{"code":"MethodNotAllowed","type":"codeVoice"},{"type":"text","text":"."}]}}} |