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.4 KiB
JSON
1 line
9.4 KiB
JSON
{"sections":[],"abstract":[{"text":"Fetches lists of comics filtered by a series id.","type":"text"}],"identifier":{"url":"doc:\/\/MarvelService\/documentation\/MarvelService\/APIProtocol\/getComicsBySeriesId(_:)","interfaceLanguage":"swift"},"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["macOS"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getComicsBySeriesId","kind":"identifier"},{"text":"(","kind":"text"},{"text":"_","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"input","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"Operations","preciseIdentifier":"s:13MarvelService10OperationsO","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"getComicsBySeriesId","preciseIdentifier":"s:13MarvelService10OperationsO19getComicsBySeriesIdO","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicsBySeriesId","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Input","preciseIdentifier":"s:13MarvelService10OperationsO19getComicsBySeriesIdO5InputV","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicsBySeriesId\/Input","kind":"typeIdentifier"},{"text":") ","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":"getComicsBySeriesId","preciseIdentifier":"s:13MarvelService10OperationsO19getComicsBySeriesIdO","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicsBySeriesId","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Output","preciseIdentifier":"s:13MarvelService10OperationsO19getComicsBySeriesIdO6OutputO","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicsBySeriesId\/Output","kind":"typeIdentifier"}]}],"kind":"declarations"},{"content":[{"level":2,"anchor":"discussion","text":"Discussion","type":"heading"},{"type":"paragraph","inlineContent":[{"text":"Fetches lists of comics which are published as part of a specific series, with optional filters.","type":"text"}]},{"style":"note","content":[{"type":"paragraph","inlineContent":[{"text":"HTTP ","type":"text"},{"code":"GET \/v1\/public\/series\/{seriesId}\/comics","type":"codeVoice"},{"text":".","type":"text"}]}],"name":"Remark","type":"aside"},{"style":"note","content":[{"type":"paragraph","inlineContent":[{"text":"Generated from ","type":"text"},{"code":"#\/paths\/\/v1\/public\/series\/{seriesId}\/comics\/get(getComicsBySeriesId)","type":"codeVoice"},{"text":".","type":"text"}]}],"name":"Remark","type":"aside"}],"kind":"content"}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/MarvelService\/documentation\/MarvelService","doc:\/\/MarvelService\/documentation\/MarvelService\/APIProtocol"]]},"variants":[{"paths":["\/documentation\/marvelservice\/apiprotocol\/getcomicsbyseriesid(_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"symbolKind":"method","required":true,"role":"symbol","externalID":"s:13MarvelService11APIProtocolP19getComicsBySeriesIdyAA10OperationsOADO6OutputOAG5InputVYaKF","title":"getComicsBySeriesId(_:)","roleHeading":"Instance Method","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getComicsBySeriesId","kind":"identifier"},{"text":"(","kind":"text"},{"text":"Operations","preciseIdentifier":"s:13MarvelService10OperationsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"getComicsBySeriesId","preciseIdentifier":"s:13MarvelService10OperationsO19getComicsBySeriesIdO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Input","preciseIdentifier":"s:13MarvelService10OperationsO19getComicsBySeriesIdO5InputV","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"text":"Operations","preciseIdentifier":"s:13MarvelService10OperationsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"getComicsBySeriesId","preciseIdentifier":"s:13MarvelService10OperationsO19getComicsBySeriesIdO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Output","preciseIdentifier":"s:13MarvelService10OperationsO19getComicsBySeriesIdO6OutputO","kind":"typeIdentifier"}],"modules":[{"name":"MarvelService"}]},"schemaVersion":{"major":0,"minor":3,"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/Operations/getComicsBySeriesId":{"abstract":[{"text":"Fetches lists of comics filtered by a series id.","type":"text"}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicsBySeriesId","navigatorTitle":[{"text":"getComicsBySeriesId","kind":"identifier"}],"title":"Operations.getComicsBySeriesId","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getComicsBySeriesId","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/marvelservice\/operations\/getcomicsbyseriesid","type":"topic"},"doc://MarvelService/documentation/MarvelService/Operations/getComicsBySeriesId/Output":{"abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicsBySeriesId\/Output","navigatorTitle":[{"text":"Output","kind":"identifier"}],"title":"Operations.getComicsBySeriesId.Output","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Output","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/marvelservice\/operations\/getcomicsbyseriesid\/output","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/getComicsBySeriesId/Input":{"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Input"}],"kind":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicsBySeriesId\/Input","navigatorTitle":[{"kind":"identifier","text":"Input"}],"url":"\/documentation\/marvelservice\/operations\/getcomicsbyseriesid\/input","title":"Operations.getComicsBySeriesId.Input","role":"symbol","abstract":[],"type":"topic"},"doc://MarvelService/documentation/MarvelService/APIProtocol/getComicsBySeriesId(_:)":{"title":"getComicsBySeriesId(_:)","abstract":[{"type":"text","text":"Fetches lists of comics filtered by a series id."}],"url":"\/documentation\/marvelservice\/apiprotocol\/getcomicsbyseriesid(_:)","kind":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/APIProtocol\/getComicsBySeriesId(_:)","type":"topic","role":"symbol","required":true,"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getComicsBySeriesId","kind":"identifier"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO19getComicsBySeriesIdO","text":"getComicsBySeriesId","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO19getComicsBySeriesIdO5InputV","text":"Input","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO19getComicsBySeriesIdO","text":"getComicsBySeriesId","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO19getComicsBySeriesIdO6OutputO","text":"Output","kind":"typeIdentifier"}]}}} |