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
17 KiB
JSON
1 line
17 KiB
JSON
{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/MarvelService\/documentation\/MarvelService\/Client\/getCharactersByComicId(path:query:headers:)"},"hierarchy":{"paths":[["doc:\/\/MarvelService\/documentation\/MarvelService","doc:\/\/MarvelService\/documentation\/MarvelService\/Client"]]},"schemaVersion":{"minor":3,"major":0,"patch":0},"metadata":{"extendedModule":"MarvelService","title":"getCharactersByComicId(path:query:headers:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getCharactersByComicId","kind":"identifier"},{"text":"(","kind":"text"},{"text":"path","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByComicIdO","text":"getCharactersByComicId","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByComicIdO5InputV","text":"Input","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByComicIdO5InputV4PathV","text":"Path","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"query","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByComicIdO","text":"getCharactersByComicId","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByComicIdO5InputV","text":"Input","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByComicIdO5InputV5QueryV","text":"Query","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByComicIdO","text":"getCharactersByComicId","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByComicIdO5InputV","text":"Input","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByComicIdO5InputV7HeadersV","text":"Headers","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByComicIdO","text":"getCharactersByComicId","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByComicIdO6OutputO","text":"Output","kind":"typeIdentifier"}],"externalID":"s:13MarvelService11APIProtocolPAAE22getCharactersByComicId4path5query7headersAA10OperationsOADO6OutputOAJ5InputV4PathV_AN5QueryVAN7HeadersVtYaKF::SYNTHESIZED::s:13MarvelService6ClientV","roleHeading":"Instance Method","role":"symbol","symbolKind":"method","modules":[{"name":"MarvelService"}]},"kind":"symbol","sections":[],"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getCharactersByComicId","kind":"identifier"},{"text":"(","kind":"text"},{"text":"path","kind":"externalParam"},{"text":": ","kind":"text"},{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByComicId","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByComicIdO","text":"getCharactersByComicId","kind":"typeIdentifier"},{"text":".","kind":"text"},{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByComicId\/Input","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByComicIdO5InputV","text":"Input","kind":"typeIdentifier"},{"text":".","kind":"text"},{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByComicId\/Input\/Path-swift.struct","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByComicIdO5InputV4PathV","text":"Path","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"query","kind":"externalParam"},{"text":": ","kind":"text"},{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByComicId","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByComicIdO","text":"getCharactersByComicId","kind":"typeIdentifier"},{"text":".","kind":"text"},{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByComicId\/Input","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByComicIdO5InputV","text":"Input","kind":"typeIdentifier"},{"text":".","kind":"text"},{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByComicId\/Input\/Query-swift.struct","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByComicIdO5InputV5QueryV","text":"Query","kind":"typeIdentifier"},{"text":" = .init(), ","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": ","kind":"text"},{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByComicId","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByComicIdO","text":"getCharactersByComicId","kind":"typeIdentifier"},{"text":".","kind":"text"},{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByComicId\/Input","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByComicIdO5InputV","text":"Input","kind":"typeIdentifier"},{"text":".","kind":"text"},{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByComicId\/Input\/Headers-swift.struct","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByComicIdO5InputV7HeadersV","text":"Headers","kind":"typeIdentifier"},{"text":" = .init()) ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByComicId","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByComicIdO","text":"getCharactersByComicId","kind":"typeIdentifier"},{"text":".","kind":"text"},{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByComicId\/Output","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByComicIdO6OutputO","text":"Output","kind":"typeIdentifier"}],"platforms":["macOS"]}],"kind":"declarations"},{"content":[{"anchor":"discussion","text":"Discussion","level":2,"type":"heading"},{"inlineContent":[{"type":"text","text":"Fetches lists of characters which appear in a specific comic with optional filters."}],"type":"paragraph"},{"name":"Remark","content":[{"type":"paragraph","inlineContent":[{"text":"HTTP ","type":"text"},{"code":"GET \/v1\/public\/comics\/{comicId}\/characters","type":"codeVoice"},{"text":".","type":"text"}]}],"style":"note","type":"aside"},{"name":"Remark","content":[{"type":"paragraph","inlineContent":[{"text":"Generated from ","type":"text"},{"code":"#\/paths\/\/v1\/public\/comics\/{comicId}\/characters\/get(getCharactersByComicId)","type":"codeVoice"},{"text":".","type":"text"}]}],"style":"note","type":"aside"}],"kind":"content"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/marvelservice\/client\/getcharactersbycomicid(path:query:headers:)"]}],"abstract":[{"type":"text","text":"Fetches lists of characters filtered by a comic id."}],"references":{"doc://MarvelService/documentation/MarvelService/Operations/getCharactersByComicId/Output":{"title":"Operations.getCharactersByComicId.Output","abstract":[],"url":"\/documentation\/marvelservice\/operations\/getcharactersbycomicid\/output","navigatorTitle":[{"text":"Output","kind":"identifier"}],"kind":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByComicId\/Output","type":"topic","role":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Output","kind":"identifier"}]},"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/getCharactersByComicId/Input/Path-swift.struct":{"title":"Operations.getCharactersByComicId.Input.Path","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByComicId\/Input\/Path-swift.struct","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Path"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/operations\/getcharactersbycomicid\/input\/path-swift.struct","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Path"}],"abstract":[]},"doc://MarvelService/documentation/MarvelService/Operations/getCharactersByComicId/Input":{"title":"Operations.getCharactersByComicId.Input","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByComicId\/Input","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Input"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/operations\/getcharactersbycomicid\/input","role":"symbol","navigatorTitle":[{"text":"Input","kind":"identifier"}],"abstract":[]},"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/Client":{"abstract":[{"text":"The Marvel Comics RESTful API.","type":"text"}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Client","navigatorTitle":[{"kind":"identifier","text":"Client"}],"title":"Client","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Client"}],"kind":"symbol","url":"\/documentation\/marvelservice\/client","type":"topic"},"doc://MarvelService/documentation/MarvelService/Operations/getCharactersByComicId":{"url":"\/documentation\/marvelservice\/operations\/getcharactersbycomicid","title":"Operations.getCharactersByComicId","navigatorTitle":[{"text":"getCharactersByComicId","kind":"identifier"}],"type":"topic","abstract":[{"text":"Fetches lists of characters filtered by a comic id.","type":"text"}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByComicId","kind":"symbol","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"getCharactersByComicId"}]},"doc://MarvelService/documentation/MarvelService/Operations/getCharactersByComicId/Input/Query-swift.struct":{"abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByComicId\/Input\/Query-swift.struct","navigatorTitle":[{"kind":"identifier","text":"Query"}],"title":"Operations.getCharactersByComicId.Input.Query","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Query"}],"kind":"symbol","url":"\/documentation\/marvelservice\/operations\/getcharactersbycomicid\/input\/query-swift.struct","type":"topic"},"doc://MarvelService/documentation/MarvelService/Operations/getCharactersByComicId/Input/Headers-swift.struct":{"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Headers","kind":"identifier"}],"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByComicId\/Input\/Headers-swift.struct","kind":"symbol","navigatorTitle":[{"text":"Headers","kind":"identifier"}],"url":"\/documentation\/marvelservice\/operations\/getcharactersbycomicid\/input\/headers-swift.struct","title":"Operations.getCharactersByComicId.Input.Headers","role":"symbol","abstract":[],"type":"topic"},"doc://MarvelService/documentation/MarvelService/Client/getCharactersByComicId(path:query:headers:)":{"url":"\/documentation\/marvelservice\/client\/getcharactersbycomicid(path:query:headers:)","kind":"symbol","abstract":[{"type":"text","text":"Fetches lists of characters filtered by a comic id."}],"title":"getCharactersByComicId(path:query:headers:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getCharactersByComicId","kind":"identifier"},{"text":"(","kind":"text"},{"text":"path","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByComicIdO","text":"getCharactersByComicId","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByComicIdO5InputV","text":"Input","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByComicIdO5InputV4PathV","text":"Path","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"query","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByComicIdO","text":"getCharactersByComicId","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByComicIdO5InputV","text":"Input","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByComicIdO5InputV5QueryV","text":"Query","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByComicIdO","text":"getCharactersByComicId","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByComicIdO5InputV","text":"Input","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByComicIdO5InputV7HeadersV","text":"Headers","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByComicIdO","text":"getCharactersByComicId","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByComicIdO6OutputO","text":"Output","kind":"typeIdentifier"}],"type":"topic","role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Client\/getCharactersByComicId(path:query:headers:)"}}} |