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":[],"variants":[{"paths":["\/documentation\/marvelservice\/client\/getcreatorsbyseriesid(_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["macOS"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"getCreatorsBySeriesId"},{"kind":"text","text":"("},{"kind":"externalParam","text":"_"},{"text":" ","kind":"text"},{"kind":"internalParam","text":"input"},{"text":": ","kind":"text"},{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","preciseIdentifier":"s:13MarvelService10OperationsO","kind":"typeIdentifier","text":"Operations"},{"text":".","kind":"text"},{"text":"getCreatorsBySeriesId","preciseIdentifier":"s:13MarvelService10OperationsO21getCreatorsBySeriesIdO","kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCreatorsBySeriesId"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO21getCreatorsBySeriesIdO5InputV","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCreatorsBySeriesId\/Input","text":"Input","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","text":"Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO21getCreatorsBySeriesIdO","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCreatorsBySeriesId","text":"getCreatorsBySeriesId","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO21getCreatorsBySeriesIdO6OutputO","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCreatorsBySeriesId\/Output","text":"Output","kind":"typeIdentifier"}]}]},{"kind":"content","content":[{"text":"Discussion","anchor":"discussion","level":2,"type":"heading"},{"inlineContent":[{"type":"text","text":"Fetches lists of comic creators whose work appears in a specific series, with optional filters."}],"type":"paragraph"},{"name":"Remark","content":[{"inlineContent":[{"type":"text","text":"HTTP "},{"type":"codeVoice","code":"GET \/v1\/public\/series\/{seriesId}\/creators"},{"type":"text","text":"."}],"type":"paragraph"}],"style":"note","type":"aside"},{"name":"Remark","content":[{"inlineContent":[{"type":"text","text":"Generated from "},{"type":"codeVoice","code":"#\/paths\/\/v1\/public\/series\/{seriesId}\/creators\/get(getCreatorsBySeriesId)"},{"type":"text","text":"."}],"type":"paragraph"}],"style":"note","type":"aside"}]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"abstract":[{"text":"Fetches lists of creators filtered by a series id.","type":"text"}],"hierarchy":{"paths":[["doc:\/\/MarvelService\/documentation\/MarvelService","doc:\/\/MarvelService\/documentation\/MarvelService\/Client"]]},"identifier":{"url":"doc:\/\/MarvelService\/documentation\/MarvelService\/Client\/getCreatorsBySeriesId(_:)","interfaceLanguage":"swift"},"kind":"symbol","metadata":{"symbolKind":"method","role":"symbol","externalID":"s:13MarvelService6ClientV21getCreatorsBySeriesIdyAA10OperationsOADO6OutputOAG5InputVYaKF","title":"getCreatorsBySeriesId(_:)","roleHeading":"Instance Method","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getCreatorsBySeriesId","kind":"identifier"},{"text":"(","kind":"text"},{"text":"Operations","preciseIdentifier":"s:13MarvelService10OperationsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"getCreatorsBySeriesId","preciseIdentifier":"s:13MarvelService10OperationsO21getCreatorsBySeriesIdO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Input","preciseIdentifier":"s:13MarvelService10OperationsO21getCreatorsBySeriesIdO5InputV","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":"getCreatorsBySeriesId","preciseIdentifier":"s:13MarvelService10OperationsO21getCreatorsBySeriesIdO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Output","preciseIdentifier":"s:13MarvelService10OperationsO21getCreatorsBySeriesIdO6OutputO","kind":"typeIdentifier"}],"modules":[{"name":"MarvelService"}]},"references":{"doc://MarvelService/documentation/MarvelService/Client/getCreatorsBySeriesId(_:)":{"url":"\/documentation\/marvelservice\/client\/getcreatorsbyseriesid(_:)","title":"getCreatorsBySeriesId(_:)","type":"topic","abstract":[{"type":"text","text":"Fetches lists of creators filtered by a series id."}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Client\/getCreatorsBySeriesId(_:)","kind":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getCreatorsBySeriesId"},{"kind":"text","text":"("},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations"},{"kind":"text","text":"."},{"text":"getCreatorsBySeriesId","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO21getCreatorsBySeriesIdO"},{"text":".","kind":"text"},{"text":"Input","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO21getCreatorsBySeriesIdO5InputV"},{"text":") ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"kind":"text","text":" -> "},{"preciseIdentifier":"s:13MarvelService10OperationsO","kind":"typeIdentifier","text":"Operations"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO21getCreatorsBySeriesIdO","kind":"typeIdentifier","text":"getCreatorsBySeriesId"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO21getCreatorsBySeriesIdO6OutputO","kind":"typeIdentifier","text":"Output"}]},"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/getCreatorsBySeriesId/Output":{"title":"Operations.getCreatorsBySeriesId.Output","abstract":[],"url":"\/documentation\/marvelservice\/operations\/getcreatorsbyseriesid\/output","navigatorTitle":[{"text":"Output","kind":"identifier"}],"kind":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCreatorsBySeriesId\/Output","type":"topic","role":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Output","kind":"identifier"}]},"doc://MarvelService/documentation/MarvelService/Operations/getCreatorsBySeriesId":{"url":"\/documentation\/marvelservice\/operations\/getcreatorsbyseriesid","title":"Operations.getCreatorsBySeriesId","navigatorTitle":[{"text":"getCreatorsBySeriesId","kind":"identifier"}],"type":"topic","abstract":[{"text":"Fetches lists of creators filtered by a series id.","type":"text"}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCreatorsBySeriesId","kind":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getCreatorsBySeriesId","kind":"identifier"}]},"doc://MarvelService/documentation/MarvelService/Client":{"abstract":[{"text":"The Marvel Comics RESTful API.","type":"text"}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Client","navigatorTitle":[{"kind":"identifier","text":"Client"}],"title":"Client","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Client"}],"kind":"symbol","url":"\/documentation\/marvelservice\/client","type":"topic"},"doc://MarvelService/documentation/MarvelService/Operations/getCreatorsBySeriesId/Input":{"abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCreatorsBySeriesId\/Input","navigatorTitle":[{"kind":"identifier","text":"Input"}],"title":"Operations.getCreatorsBySeriesId.Input","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Input"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/operations\/getcreatorsbyseriesid\/input"}}} |