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
7.8 KiB
JSON
1 line
7.8 KiB
JSON
{"metadata":{"fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"accept","kind":"externalParam"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:14OpenAPIRuntime23AcceptHeaderContentTypeV","text":"AcceptHeaderContentType","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO13getCharactersO","text":"getCharacters","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO13getCharactersO21AcceptableContentTypeO","text":"AcceptableContentType","kind":"typeIdentifier"},{"text":">])","kind":"text"}],"roleHeading":"Initializer","externalID":"s:13MarvelService10OperationsO13getCharactersO5InputV7HeadersV6acceptAISay14OpenAPIRuntime23AcceptHeaderContentTypeVyAE010AcceptablemN0OGG_tcfc","symbolKind":"init","modules":[{"name":"MarvelService"}],"role":"symbol","title":"init(accept:)"},"schemaVersion":{"patch":0,"major":0,"minor":3},"sections":[],"kind":"symbol","identifier":{"url":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacters\/Input\/Headers-swift.struct\/init(accept:)","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/MarvelService\/documentation\/MarvelService","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacters","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacters\/Input","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacters\/Input\/Headers-swift.struct"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/marvelservice\/operations\/getcharacters\/input\/headers-swift.struct\/init(accept:)"]}],"abstract":[{"type":"text","text":"Creates a new "},{"type":"codeVoice","code":"Headers"},{"type":"text","text":"."}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"text":"init","kind":"keyword"},{"text":"(","kind":"text"},{"text":"accept","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"AcceptHeaderContentType","kind":"typeIdentifier","preciseIdentifier":"s:14OpenAPIRuntime23AcceptHeaderContentTypeV"},{"text":"<","kind":"text"},{"text":"Operations","kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","preciseIdentifier":"s:13MarvelService10OperationsO"},{"text":".","kind":"text"},{"text":"getCharacters","kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacters","preciseIdentifier":"s:13MarvelService10OperationsO13getCharactersO"},{"text":".","kind":"text"},{"text":"AcceptableContentType","kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacters\/AcceptableContentType","preciseIdentifier":"s:13MarvelService10OperationsO13getCharactersO21AcceptableContentTypeO"},{"text":">] = .defaultValues())","kind":"text"}],"platforms":["macOS"]}],"kind":"declarations"},{"parameters":[{"name":"accept","content":[{"type":"paragraph","inlineContent":[{"text":"","type":"text"}]}]}],"kind":"parameters"}],"references":{"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/getCharacters/AcceptableContentType":{"abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacters\/AcceptableContentType","navigatorTitle":[{"kind":"identifier","text":"AcceptableContentType"}],"title":"Operations.getCharacters.AcceptableContentType","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"AcceptableContentType"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/operations\/getcharacters\/acceptablecontenttype"},"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/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":{"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/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/Headers-swift.struct/init(accept:)":{"abstract":[{"type":"text","text":"Creates a new "},{"type":"codeVoice","code":"Headers"},{"type":"text","text":"."}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacters\/Input\/Headers-swift.struct\/init(accept:)","title":"init(accept:)","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"accept","kind":"externalParam"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:14OpenAPIRuntime23AcceptHeaderContentTypeV","text":"AcceptHeaderContentType","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO13getCharactersO","text":"getCharacters","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO13getCharactersO21AcceptableContentTypeO","text":"AcceptableContentType","kind":"typeIdentifier"},{"text":">])","kind":"text"}],"kind":"symbol","url":"\/documentation\/marvelservice\/operations\/getcharacters\/input\/headers-swift.struct\/init(accept:)","type":"topic"}}} |