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.3 KiB
JSON
1 line
9.3 KiB
JSON
{"primaryContentSections":[{"declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getSeriesByStoryId","kind":"identifier"},{"text":"(","kind":"text"},{"text":"_","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"input","kind":"internalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO18getSeriesByStoryIdO","text":"getSeriesByStoryId","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeriesByStoryId","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO18getSeriesByStoryIdO5InputV","text":"Input","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeriesByStoryId\/Input","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","preciseIdentifier":"s:13MarvelService10OperationsO"},{"text":".","kind":"text"},{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeriesByStoryId","text":"getSeriesByStoryId","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getSeriesByStoryIdO"},{"text":".","kind":"text"},{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeriesByStoryId\/Output","text":"Output","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getSeriesByStoryIdO6OutputO"}],"platforms":["macOS"],"languages":["swift"]}],"kind":"declarations"},{"kind":"content","content":[{"text":"Discussion","anchor":"discussion","type":"heading","level":2},{"inlineContent":[{"text":"Fetches lists of comic series in which the specified story takes place.","type":"text"}],"type":"paragraph"},{"style":"note","name":"Remark","type":"aside","content":[{"inlineContent":[{"type":"text","text":"HTTP "},{"type":"codeVoice","code":"GET \/v1\/public\/stories\/{storyId}\/series"},{"type":"text","text":"."}],"type":"paragraph"}]},{"style":"note","name":"Remark","type":"aside","content":[{"inlineContent":[{"type":"text","text":"Generated from "},{"type":"codeVoice","code":"#\/paths\/\/v1\/public\/stories\/{storyId}\/series\/get(getSeriesByStoryId)"},{"type":"text","text":"."}],"type":"paragraph"}]}]}],"hierarchy":{"paths":[["doc:\/\/MarvelService\/documentation\/MarvelService","doc:\/\/MarvelService\/documentation\/MarvelService\/APIProtocol"]]},"schemaVersion":{"minor":3,"major":0,"patch":0},"abstract":[{"type":"text","text":"Fetches lists of series filtered by a story id."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/marvelservice\/apiprotocol\/getseriesbystoryid(_:)"]}],"kind":"symbol","identifier":{"interfaceLanguage":"swift","url":"doc:\/\/MarvelService\/documentation\/MarvelService\/APIProtocol\/getSeriesByStoryId(_:)"},"sections":[],"metadata":{"title":"getSeriesByStoryId(_:)","externalID":"s:13MarvelService11APIProtocolP18getSeriesByStoryIdyAA10OperationsOADO6OutputOAG5InputVYaKF","role":"symbol","modules":[{"name":"MarvelService"}],"roleHeading":"Instance Method","symbolKind":"method","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getSeriesByStoryId","kind":"identifier"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO18getSeriesByStoryIdO","text":"getSeriesByStoryId","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO18getSeriesByStoryIdO5InputV","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"},{"text":"getSeriesByStoryId","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getSeriesByStoryIdO"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO18getSeriesByStoryIdO6OutputO","text":"Output","kind":"typeIdentifier"}],"required":true},"references":{"doc://MarvelService/documentation/MarvelService/Operations/getSeriesByStoryId":{"url":"\/documentation\/marvelservice\/operations\/getseriesbystoryid","title":"Operations.getSeriesByStoryId","navigatorTitle":[{"text":"getSeriesByStoryId","kind":"identifier"}],"type":"topic","abstract":[{"text":"Fetches lists of series filtered by a story id.","type":"text"}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeriesByStoryId","kind":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"getSeriesByStoryId"}]},"doc://MarvelService/documentation/MarvelService/Operations/getSeriesByStoryId/Output":{"url":"\/documentation\/marvelservice\/operations\/getseriesbystoryid\/output","title":"Operations.getSeriesByStoryId.Output","navigatorTitle":[{"text":"Output","kind":"identifier"}],"type":"topic","abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeriesByStoryId\/Output","kind":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Output","kind":"identifier"}]},"doc://MarvelService/documentation/MarvelService/APIProtocol/getSeriesByStoryId(_:)":{"title":"getSeriesByStoryId(_:)","abstract":[{"type":"text","text":"Fetches lists of series filtered by a story id."}],"url":"\/documentation\/marvelservice\/apiprotocol\/getseriesbystoryid(_:)","kind":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/APIProtocol\/getSeriesByStoryId(_:)","type":"topic","role":"symbol","required":true,"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getSeriesByStoryId","kind":"identifier"},{"text":"(","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO"},{"text":".","kind":"text"},{"text":"getSeriesByStoryId","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getSeriesByStoryIdO"},{"text":".","kind":"text"},{"text":"Input","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getSeriesByStoryIdO5InputV"},{"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":"getSeriesByStoryId","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getSeriesByStoryIdO"},{"text":".","kind":"text"},{"text":"Output","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getSeriesByStoryIdO6OutputO"}]},"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/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/getSeriesByStoryId/Input":{"title":"Operations.getSeriesByStoryId.Input","abstract":[],"url":"\/documentation\/marvelservice\/operations\/getseriesbystoryid\/input","navigatorTitle":[{"text":"Input","kind":"identifier"}],"kind":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeriesByStoryId\/Input","type":"topic","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Input","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"}}} |