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
9.6 KiB
JSON
1 line
9.6 KiB
JSON
{"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/marvelservice\/apiprotocol\/getcomicsbycharacterid(_:)"]}],"primaryContentSections":[{"declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getComicsByCharacterId","kind":"identifier"},{"text":"(","kind":"text"},{"text":"_","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"input","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"Operations","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO"},{"text":".","kind":"text"},{"text":"getComicsByCharacterId","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicsByCharacterId","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO22getComicsByCharacterIdO"},{"text":".","kind":"text"},{"text":"Input","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicsByCharacterId\/Input","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO22getComicsByCharacterIdO5InputV"},{"text":") ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"text":"Operations","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO"},{"text":".","kind":"text"},{"text":"getComicsByCharacterId","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicsByCharacterId","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO22getComicsByCharacterIdO"},{"text":".","kind":"text"},{"text":"Output","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicsByCharacterId\/Output","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO22getComicsByCharacterIdO6OutputO"}],"languages":["swift"],"platforms":["macOS"]}],"kind":"declarations"},{"content":[{"type":"heading","level":2,"text":"Discussion","anchor":"discussion"},{"type":"paragraph","inlineContent":[{"type":"text","text":"Fetches lists of comics containing a specific character, with optional filters."}]},{"name":"Remark","type":"aside","style":"note","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"HTTP "},{"type":"codeVoice","code":"GET \/v1\/public\/characters\/{characterId}\/comics"},{"type":"text","text":"."}]}]},{"name":"Remark","type":"aside","style":"note","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Generated from "},{"type":"codeVoice","code":"#\/paths\/\/v1\/public\/characters\/{characterId}\/comics\/get(getComicsByCharacterId)"},{"type":"text","text":"."}]}]}],"kind":"content"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"abstract":[{"type":"text","text":"Fetches lists of comics filtered by a character id."}],"hierarchy":{"paths":[["doc:\/\/MarvelService\/documentation\/MarvelService","doc:\/\/MarvelService\/documentation\/MarvelService\/APIProtocol"]]},"identifier":{"url":"doc:\/\/MarvelService\/documentation\/MarvelService\/APIProtocol\/getComicsByCharacterId(_:)","interfaceLanguage":"swift"},"kind":"symbol","metadata":{"title":"getComicsByCharacterId(_:)","externalID":"s:13MarvelService11APIProtocolP22getComicsByCharacterIdyAA10OperationsOADO6OutputOAG5InputVYaKF","role":"symbol","roleHeading":"Instance Method","modules":[{"name":"MarvelService"}],"symbolKind":"method","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getComicsByCharacterId","kind":"identifier"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO22getComicsByCharacterIdO","text":"getComicsByCharacterId","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO22getComicsByCharacterIdO5InputV","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"},{"preciseIdentifier":"s:13MarvelService10OperationsO22getComicsByCharacterIdO","text":"getComicsByCharacterId","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO22getComicsByCharacterIdO6OutputO","text":"Output","kind":"typeIdentifier"}],"required":true},"references":{"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/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/APIProtocol/getComicsByCharacterId(_:)":{"abstract":[{"text":"Fetches lists of comics filtered by a character id.","type":"text"}],"required":true,"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/APIProtocol\/getComicsByCharacterId(_:)","role":"symbol","title":"getComicsByCharacterId(_:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getComicsByCharacterId","kind":"identifier"},{"text":"(","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO"},{"text":".","kind":"text"},{"text":"getComicsByCharacterId","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO22getComicsByCharacterIdO"},{"text":".","kind":"text"},{"text":"Input","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO22getComicsByCharacterIdO5InputV"},{"text":") ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO"},{"text":".","kind":"text"},{"text":"getComicsByCharacterId","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO22getComicsByCharacterIdO"},{"text":".","kind":"text"},{"text":"Output","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO22getComicsByCharacterIdO6OutputO"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/apiprotocol\/getcomicsbycharacterid(_:)"},"doc://MarvelService/documentation/MarvelService/Operations/getComicsByCharacterId/Input":{"url":"\/documentation\/marvelservice\/operations\/getcomicsbycharacterid\/input","title":"Operations.getComicsByCharacterId.Input","navigatorTitle":[{"kind":"identifier","text":"Input"}],"type":"topic","abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicsByCharacterId\/Input","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Input"}]},"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/getComicsByCharacterId/Output":{"title":"Operations.getComicsByCharacterId.Output","abstract":[],"url":"\/documentation\/marvelservice\/operations\/getcomicsbycharacterid\/output","navigatorTitle":[{"kind":"identifier","text":"Output"}],"kind":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicsByCharacterId\/Output","type":"topic","role":"symbol","fragments":[{"kind":"keyword","text":"enum"},{"text":" ","kind":"text"},{"text":"Output","kind":"identifier"}]},"doc://MarvelService/documentation/MarvelService/Operations/getComicsByCharacterId":{"navigatorTitle":[{"text":"getComicsByCharacterId","kind":"identifier"}],"url":"\/documentation\/marvelservice\/operations\/getcomicsbycharacterid","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicsByCharacterId","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"text":"getComicsByCharacterId","kind":"identifier"}],"role":"symbol","type":"topic","title":"Operations.getComicsByCharacterId","abstract":[{"text":"Fetches lists of comics filtered by a character id.","type":"text"}],"kind":"symbol"}}} |