fc84db4881
This PR contains the work done to update the license to *Apache v2.0* and also, to update any file header and/or mention as necessary. Reviewed-on: #9 Co-authored-by: Javier Cicchelli <javier@rock-n-code.com> Co-committed-by: Javier Cicchelli <javier@rock-n-code.com>
1 line
9.6 KiB
JSON
1 line
9.6 KiB
JSON
{"schemaVersion":{"major":0,"minor":3,"patch":0},"metadata":{"role":"symbol","symbolKind":"method","modules":[{"name":"MarvelService"}],"title":"getCharactersByComicId(_:)","externalID":"s:13MarvelService11APIProtocolP22getCharactersByComicIdyAA10OperationsOADO6OutputOAG5InputVYaKF","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"getCharactersByComicId","kind":"identifier"},{"text":"(","kind":"text"},{"text":"Operations","preciseIdentifier":"s:13MarvelService10OperationsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"getCharactersByComicId","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByComicIdO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Input","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByComicIdO5InputV","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations"},{"kind":"text","text":"."},{"text":"getCharactersByComicId","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByComicIdO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Output","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByComicIdO6OutputO","kind":"typeIdentifier"}],"required":true,"roleHeading":"Instance Method"},"kind":"symbol","abstract":[{"type":"text","text":"Fetches lists of characters filtered by a comic id."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"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":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","text":"Operations","preciseIdentifier":"s:13MarvelService10OperationsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByComicId","text":"getCharactersByComicId","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByComicIdO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByComicId\/Input","text":"Input","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByComicIdO5InputV"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByComicIdO","text":"getCharactersByComicId","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByComicId"},{"kind":"text","text":"."},{"kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByComicId\/Output","text":"Output","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByComicIdO6OutputO"}],"platforms":["macOS"]}]},{"content":[{"text":"Discussion","type":"heading","level":2,"anchor":"discussion"},{"inlineContent":[{"type":"text","text":"Fetches lists of characters which appear in a specific comic with optional filters."}],"type":"paragraph"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"HTTP "},{"code":"GET \/v1\/public\/comics\/{comicId}\/characters","type":"codeVoice"},{"type":"text","text":"."}]}],"style":"note","type":"aside","name":"Remark"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Generated from "},{"type":"codeVoice","code":"#\/paths\/\/v1\/public\/comics\/{comicId}\/characters\/get(getCharactersByComicId)"},{"type":"text","text":"."}]}],"name":"Remark","type":"aside","style":"note"}],"kind":"content"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/MarvelService\/documentation\/MarvelService\/APIProtocol\/getCharactersByComicId(_:)"},"variants":[{"paths":["\/documentation\/marvelservice\/apiprotocol\/getcharactersbycomicid(_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"hierarchy":{"paths":[["doc:\/\/MarvelService\/documentation\/MarvelService","doc:\/\/MarvelService\/documentation\/MarvelService\/APIProtocol"]]},"references":{"doc://MarvelService/documentation/MarvelService/APIProtocol/getCharactersByComicId(_:)":{"type":"topic","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/APIProtocol\/getCharactersByComicId(_:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getCharactersByComicId"},{"kind":"text","text":"("},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByComicIdO","text":"getCharactersByComicId"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByComicIdO5InputV","text":"Input"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByComicIdO","text":"getCharactersByComicId","kind":"typeIdentifier"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Output","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByComicIdO6OutputO"}],"url":"\/documentation\/marvelservice\/apiprotocol\/getcharactersbycomicid(_:)","title":"getCharactersByComicId(_:)","kind":"symbol","required":true,"role":"symbol","abstract":[{"type":"text","text":"Fetches lists of characters filtered by a comic id."}]},"doc://MarvelService/documentation/MarvelService/Operations/getCharactersByComicId":{"navigatorTitle":[{"text":"getCharactersByComicId","kind":"identifier"}],"url":"\/documentation\/marvelservice\/operations\/getcharactersbycomicid","kind":"symbol","title":"Operations.getCharactersByComicId","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByComicId","role":"symbol","type":"topic","abstract":[{"type":"text","text":"Fetches lists of characters filtered by a comic id."}],"fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getCharactersByComicId","kind":"identifier"}]},"doc://MarvelService/documentation/MarvelService/Operations/getCharactersByComicId/Output":{"navigatorTitle":[{"text":"Output","kind":"identifier"}],"url":"\/documentation\/marvelservice\/operations\/getcharactersbycomicid\/output","kind":"symbol","title":"Operations.getCharactersByComicId.Output","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByComicId\/Output","role":"symbol","type":"topic","abstract":[],"fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Output","kind":"identifier"}]},"doc://MarvelService/documentation/MarvelService/Operations":{"navigatorTitle":[{"kind":"identifier","text":"Operations"}],"url":"\/documentation\/marvelservice\/operations","kind":"symbol","title":"Operations","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","role":"symbol","type":"topic","abstract":[{"type":"text","text":"API operations, with input and output types, generated from "},{"code":"#\/paths","type":"codeVoice"},{"text":" in the OpenAPI document.","type":"text"}],"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Operations"}]},"doc://MarvelService/documentation/MarvelService/APIProtocol":{"navigatorTitle":[{"kind":"identifier","text":"APIProtocol"}],"url":"\/documentation\/marvelservice\/apiprotocol","kind":"symbol","title":"APIProtocol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/APIProtocol","role":"symbol","type":"topic","abstract":[{"text":"A type that performs HTTP operations defined by the OpenAPI document.","type":"text"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"APIProtocol"}]},"doc://MarvelService/documentation/MarvelService/Operations/getCharactersByComicId/Input":{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByComicId\/Input","type":"topic","url":"\/documentation\/marvelservice\/operations\/getcharactersbycomicid\/input","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Input"}],"role":"symbol","title":"Operations.getCharactersByComicId.Input","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Input"}],"abstract":[]},"doc://MarvelService/documentation/MarvelService":{"url":"\/documentation\/marvelservice","kind":"symbol","title":"MarvelService","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService","role":"collection","type":"topic","abstract":[{"text":"A library that allows the developer to interact with the ","type":"text"},{"type":"strong","inlineContent":[{"text":"Marvel Comics API","type":"text"}]},{"text":" backend service.","type":"text"}]}}} |