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