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
13 KiB
JSON
1 line
13 KiB
JSON
{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getSeries","kind":"identifier"},{"text":"(","kind":"text"},{"text":"query","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","preciseIdentifier":"s:13MarvelService10OperationsO","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"getSeries","preciseIdentifier":"s:13MarvelService10OperationsO9getSeriesO","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeries","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Input","preciseIdentifier":"s:13MarvelService10OperationsO9getSeriesO5InputV","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeries\/Input","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Query","preciseIdentifier":"s:13MarvelService10OperationsO9getSeriesO5InputV5QueryV","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeries\/Input\/Query-swift.struct","kind":"typeIdentifier"},{"text":" = .init(), ","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","preciseIdentifier":"s:13MarvelService10OperationsO","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"getSeries","preciseIdentifier":"s:13MarvelService10OperationsO9getSeriesO","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeries","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Input","preciseIdentifier":"s:13MarvelService10OperationsO9getSeriesO5InputV","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeries\/Input","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Headers","preciseIdentifier":"s:13MarvelService10OperationsO9getSeriesO5InputV7HeadersV","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeries\/Input\/Headers-swift.struct","kind":"typeIdentifier"},{"text":" = .init()) ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"text":"Operations","preciseIdentifier":"s:13MarvelService10OperationsO","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"getSeries","preciseIdentifier":"s:13MarvelService10OperationsO9getSeriesO","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeries","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Output","preciseIdentifier":"s:13MarvelService10OperationsO9getSeriesO6OutputO","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeries\/Output","kind":"typeIdentifier"}],"platforms":["macOS"],"languages":["swift"]}]},{"kind":"content","content":[{"anchor":"discussion","text":"Discussion","type":"heading","level":2},{"inlineContent":[{"text":"Fetches lists of comic series with optional filters.","type":"text"}],"type":"paragraph"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"HTTP "},{"type":"codeVoice","code":"GET \/v1\/public\/series"},{"type":"text","text":"."}]}],"style":"note","type":"aside","name":"Remark"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Generated from "},{"type":"codeVoice","code":"#\/paths\/\/v1\/public\/series\/get(getSeries)"},{"type":"text","text":"."}]}],"style":"note","type":"aside","name":"Remark"}]}],"hierarchy":{"paths":[["doc:\/\/MarvelService\/documentation\/MarvelService","doc:\/\/MarvelService\/documentation\/MarvelService\/APIProtocol"]]},"schemaVersion":{"major":0,"minor":3,"patch":0},"abstract":[{"type":"text","text":"Fetches lists of series."}],"variants":[{"paths":["\/documentation\/marvelservice\/apiprotocol\/getseries(query:headers:)"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","metadata":{"modules":[{"name":"MarvelService"}],"roleHeading":"Instance Method","title":"getSeries(query:headers:)","symbolKind":"method","externalID":"s:13MarvelService11APIProtocolPAAE9getSeries5query7headersAA10OperationsOADO6OutputOAI5InputV5QueryV_AM7HeadersVtYaKF","extendedModule":"MarvelService","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getSeries"},{"kind":"text","text":"("},{"kind":"externalParam","text":"query"},{"kind":"text","text":": "},{"preciseIdentifier":"s:13MarvelService10OperationsO","kind":"typeIdentifier","text":"Operations"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO9getSeriesO","kind":"typeIdentifier","text":"getSeries"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO9getSeriesO5InputV","kind":"typeIdentifier","text":"Input"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO9getSeriesO5InputV5QueryV","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:13MarvelService10OperationsO9getSeriesO","kind":"typeIdentifier","text":"getSeries"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO9getSeriesO5InputV","kind":"typeIdentifier","text":"Input"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO9getSeriesO5InputV7HeadersV","kind":"typeIdentifier","text":"Headers"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"preciseIdentifier":"s:13MarvelService10OperationsO","kind":"typeIdentifier","text":"Operations"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO9getSeriesO","kind":"typeIdentifier","text":"getSeries"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO9getSeriesO6OutputO","kind":"typeIdentifier","text":"Output"}]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/MarvelService\/documentation\/MarvelService\/APIProtocol\/getSeries(query:headers:)"},"sections":[],"references":{"doc://MarvelService/documentation/MarvelService/Operations/getSeries/Input/Headers-swift.struct":{"title":"Operations.getSeries.Input.Headers","abstract":[],"url":"\/documentation\/marvelservice\/operations\/getseries\/input\/headers-swift.struct","navigatorTitle":[{"kind":"identifier","text":"Headers"}],"kind":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeries\/Input\/Headers-swift.struct","type":"topic","role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Headers"}]},"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/APIProtocol/getSeries(query:headers:)":{"title":"getSeries(query:headers:)","abstract":[{"type":"text","text":"Fetches lists of series."}],"url":"\/documentation\/marvelservice\/apiprotocol\/getseries(query:headers:)","kind":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/APIProtocol\/getSeries(query:headers:)","type":"topic","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getSeries","kind":"identifier"},{"text":"(","kind":"text"},{"text":"query","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO"},{"text":".","kind":"text"},{"text":"getSeries","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO9getSeriesO"},{"text":".","kind":"text"},{"text":"Input","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO9getSeriesO5InputV"},{"text":".","kind":"text"},{"text":"Query","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO9getSeriesO5InputV5QueryV"},{"text":", ","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO"},{"text":".","kind":"text"},{"text":"getSeries","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO9getSeriesO"},{"text":".","kind":"text"},{"text":"Input","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO9getSeriesO5InputV"},{"text":".","kind":"text"},{"text":"Headers","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO9getSeriesO5InputV7HeadersV"},{"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":"getSeries","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO9getSeriesO"},{"text":".","kind":"text"},{"text":"Output","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO9getSeriesO6OutputO"}]},"doc://MarvelService/documentation/MarvelService/Operations/getSeries/Input/Query-swift.struct":{"abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeries\/Input\/Query-swift.struct","navigatorTitle":[{"kind":"identifier","text":"Query"}],"title":"Operations.getSeries.Input.Query","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Query"}],"kind":"symbol","url":"\/documentation\/marvelservice\/operations\/getseries\/input\/query-swift.struct","type":"topic"},"doc://MarvelService/documentation/MarvelService/Operations/getSeries/Input":{"url":"\/documentation\/marvelservice\/operations\/getseries\/input","title":"Operations.getSeries.Input","navigatorTitle":[{"kind":"identifier","text":"Input"}],"type":"topic","abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeries\/Input","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Input","kind":"identifier"}]},"doc://MarvelService/documentation/MarvelService/Operations/getSeries":{"abstract":[{"text":"Fetches lists of series.","type":"text"}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeries","navigatorTitle":[{"kind":"identifier","text":"getSeries"}],"title":"Operations.getSeries","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"getSeries"}],"kind":"symbol","url":"\/documentation\/marvelservice\/operations\/getseries","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":{"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/getSeries/Output":{"url":"\/documentation\/marvelservice\/operations\/getseries\/output","title":"Operations.getSeries.Output","navigatorTitle":[{"text":"Output","kind":"identifier"}],"type":"topic","abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeries\/Output","kind":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Output","kind":"identifier"}]}}} |