Files
marvel-service/docs/data/documentation/marvelservice/apiprotocol/getcharactersbycomicid(_:).json
T
javier d5bd9feb0a First version of the library documentation (#7)
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>
2025-10-05 18:41:22 +00:00

1 line
9.6 KiB
JSON

{"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/marvelservice\/apiprotocol\/getcharactersbycomicid(_:)"]}],"primaryContentSections":[{"declarations":[{"platforms":["macOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getCharactersByComicId"},{"kind":"text","text":"("},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"kind":"internalParam","text":"input"},{"kind":"text","text":": "},{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","preciseIdentifier":"s:13MarvelService10OperationsO","kind":"typeIdentifier","text":"Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"getCharactersByComicId","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByComicId","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByComicIdO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Input","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByComicId\/Input","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByComicIdO5InputV"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","text":"Operations","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","preciseIdentifier":"s:13MarvelService10OperationsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"getCharactersByComicId","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByComicId","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByComicIdO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Output","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByComicId\/Output","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByComicIdO6OutputO"}]}],"kind":"declarations"},{"content":[{"text":"Discussion","anchor":"discussion","level":2,"type":"heading"},{"inlineContent":[{"type":"text","text":"Fetches lists of characters which appear in a specific comic with optional filters."}],"type":"paragraph"},{"content":[{"type":"paragraph","inlineContent":[{"text":"HTTP ","type":"text"},{"code":"GET \/v1\/public\/comics\/{comicId}\/characters","type":"codeVoice"},{"text":".","type":"text"}]}],"name":"Remark","style":"note","type":"aside"},{"name":"Remark","type":"aside","style":"note","content":[{"type":"paragraph","inlineContent":[{"text":"Generated from ","type":"text"},{"code":"#\/paths\/\/v1\/public\/comics\/{comicId}\/characters\/get(getCharactersByComicId)","type":"codeVoice"},{"text":".","type":"text"}]}]}],"kind":"content"}],"schemaVersion":{"patch":0,"major":0,"minor":3},"abstract":[{"text":"Fetches lists of characters filtered by a comic id.","type":"text"}],"hierarchy":{"paths":[["doc:\/\/MarvelService\/documentation\/MarvelService","doc:\/\/MarvelService\/documentation\/MarvelService\/APIProtocol"]]},"identifier":{"url":"doc:\/\/MarvelService\/documentation\/MarvelService\/APIProtocol\/getCharactersByComicId(_:)","interfaceLanguage":"swift"},"kind":"symbol","metadata":{"title":"getCharactersByComicId(_:)","externalID":"s:13MarvelService11APIProtocolP22getCharactersByComicIdyAA10OperationsOADO6OutputOAG5InputVYaKF","role":"symbol","modules":[{"name":"MarvelService"}],"roleHeading":"Instance Method","symbolKind":"method","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getCharactersByComicId","kind":"identifier"},{"text":"(","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO"},{"text":".","kind":"text"},{"text":"getCharactersByComicId","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByComicIdO"},{"text":".","kind":"text"},{"text":"Input","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByComicIdO5InputV"},{"text":") ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"kind":"text","text":" -> "},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO"},{"kind":"text","text":"."},{"text":"getCharactersByComicId","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByComicIdO"},{"kind":"text","text":"."},{"text":"Output","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByComicIdO6OutputO"}],"required":true},"references":{"doc://MarvelService/documentation/MarvelService/APIProtocol/getCharactersByComicId(_:)":{"abstract":[{"text":"Fetches lists of characters filtered by a comic id.","type":"text"}],"required":true,"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/APIProtocol\/getCharactersByComicId(_:)","role":"symbol","title":"getCharactersByComicId(_:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getCharactersByComicId","kind":"identifier"},{"text":"(","kind":"text"},{"text":"Operations","preciseIdentifier":"s:13MarvelService10OperationsO","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"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"getCharactersByComicId","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByComicIdO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Output","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByComicIdO6OutputO","kind":"typeIdentifier"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/apiprotocol\/getcharactersbycomicid(_:)"},"doc://MarvelService/documentation/MarvelService/APIProtocol":{"url":"\/documentation\/marvelservice\/apiprotocol","title":"APIProtocol","navigatorTitle":[{"text":"APIProtocol","kind":"identifier"}],"type":"topic","abstract":[{"type":"text","text":"A type that performs HTTP operations defined by the OpenAPI document."}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/APIProtocol","kind":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"APIProtocol","kind":"identifier"}]},"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/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":{"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/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"}]}}}