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