Files
marvel-service/docs/data/documentation/marvelservice/operations/getcharacters/input/init(query:headers:).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.9 KiB
JSON

{"sections":[],"abstract":[{"text":"Creates a new ","type":"text"},{"code":"Input","type":"codeVoice"},{"text":".","type":"text"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacters\/Input\/init(query:headers:)"},"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"query"},{"kind":"text","text":": "},{"preciseIdentifier":"s:13MarvelService10OperationsO","kind":"typeIdentifier","text":"Operations","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO13getCharactersO","kind":"typeIdentifier","text":"getCharacters","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacters"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO13getCharactersO5InputV","kind":"typeIdentifier","text":"Input","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacters\/Input"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO13getCharactersO5InputV5QueryV","kind":"typeIdentifier","text":"Query","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacters\/Input\/Query-swift.struct"},{"kind":"text","text":" = .init(), "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": "},{"preciseIdentifier":"s:13MarvelService10OperationsO","kind":"typeIdentifier","text":"Operations","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO13getCharactersO","kind":"typeIdentifier","text":"getCharacters","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacters"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO13getCharactersO5InputV","kind":"typeIdentifier","text":"Input","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacters\/Input"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO13getCharactersO5InputV7HeadersV","kind":"typeIdentifier","text":"Headers","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacters\/Input\/Headers-swift.struct"},{"kind":"text","text":" = .init())"}],"languages":["swift"],"platforms":["macOS"]}],"kind":"declarations"},{"parameters":[{"content":[{"type":"paragraph","inlineContent":[{"text":"","type":"text"}]}],"name":"query"},{"content":[{"inlineContent":[{"text":"","type":"text"}],"type":"paragraph"}],"name":"headers"}],"kind":"parameters"}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/MarvelService\/documentation\/MarvelService","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacters","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacters\/Input"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/marvelservice\/operations\/getcharacters\/input\/init(query:headers:)"]}],"metadata":{"symbolKind":"init","role":"symbol","externalID":"s:13MarvelService10OperationsO13getCharactersO5InputV5query7headersA2G5QueryV_AG7HeadersVtcfc","roleHeading":"Initializer","title":"init(query:headers:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"query"},{"kind":"text","text":": "},{"preciseIdentifier":"s:13MarvelService10OperationsO","kind":"typeIdentifier","text":"Operations"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO13getCharactersO","kind":"typeIdentifier","text":"getCharacters"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO13getCharactersO5InputV","kind":"typeIdentifier","text":"Input"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO13getCharactersO5InputV5QueryV","kind":"typeIdentifier","text":"Query"},{"kind":"text","text":", "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": "},{"preciseIdentifier":"s:13MarvelService10OperationsO","kind":"typeIdentifier","text":"Operations"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO13getCharactersO","kind":"typeIdentifier","text":"getCharacters"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO13getCharactersO5InputV","kind":"typeIdentifier","text":"Input"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO13getCharactersO5InputV7HeadersV","kind":"typeIdentifier","text":"Headers"},{"kind":"text","text":")"}],"modules":[{"name":"MarvelService"}]},"schemaVersion":{"major":0,"patch":0,"minor":3},"references":{"doc://MarvelService/documentation/MarvelService/Operations/getCharacters/Input/Headers-swift.struct":{"title":"Operations.getCharacters.Input.Headers","abstract":[],"url":"\/documentation\/marvelservice\/operations\/getcharacters\/input\/headers-swift.struct","navigatorTitle":[{"text":"Headers","kind":"identifier"}],"kind":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacters\/Input\/Headers-swift.struct","type":"topic","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Headers","kind":"identifier"}]},"doc://MarvelService/documentation/MarvelService/Operations/getCharacters/Input":{"url":"\/documentation\/marvelservice\/operations\/getcharacters\/input","title":"Operations.getCharacters.Input","navigatorTitle":[{"text":"Input","kind":"identifier"}],"type":"topic","abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacters\/Input","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Input","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/getCharacters":{"url":"\/documentation\/marvelservice\/operations\/getcharacters","title":"Operations.getCharacters","navigatorTitle":[{"text":"getCharacters","kind":"identifier"}],"type":"topic","abstract":[{"type":"text","text":"Fetches lists of characters."}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacters","kind":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getCharacters","kind":"identifier"}]},"doc://MarvelService/documentation/MarvelService/Operations/getCharacters/Input/init(query:headers:)":{"abstract":[{"text":"Creates a new ","type":"text"},{"type":"codeVoice","code":"Input"},{"text":".","type":"text"}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacters\/Input\/init(query:headers:)","title":"init(query:headers:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"query"},{"kind":"text","text":": "},{"preciseIdentifier":"s:13MarvelService10OperationsO","kind":"typeIdentifier","text":"Operations"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO13getCharactersO","kind":"typeIdentifier","text":"getCharacters"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO13getCharactersO5InputV","kind":"typeIdentifier","text":"Input"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO13getCharactersO5InputV5QueryV","kind":"typeIdentifier","text":"Query"},{"kind":"text","text":", "},{"text":"headers","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"getCharacters","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO13getCharactersO"},{"text":".","kind":"text"},{"text":"Input","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO13getCharactersO5InputV"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO13getCharactersO5InputV7HeadersV","text":"Headers","kind":"typeIdentifier"},{"text":")","kind":"text"}],"kind":"symbol","url":"\/documentation\/marvelservice\/operations\/getcharacters\/input\/init(query:headers:)","type":"topic"},"doc://MarvelService/documentation/MarvelService/Operations/getCharacters/Input/Query-swift.struct":{"url":"\/documentation\/marvelservice\/operations\/getcharacters\/input\/query-swift.struct","title":"Operations.getCharacters.Input.Query","navigatorTitle":[{"text":"Query","kind":"identifier"}],"type":"topic","abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacters\/Input\/Query-swift.struct","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Query","kind":"identifier"}]},"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"}}}