rock-n-code/marvel-service
1
0
Fork 0
Code Pull Requests Releases 2 Activity
Files
b547126708d98acca52e14c68968b8ceb8f4c77a
marvel-service/docs/data/documentation/marvelservice/client/getseriesbystoryid(_:).json
T
javier d5bd9feb0a First version of the library documentation (#7) 
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>
2025-10-05 18:41:22 +00:00

1 line
9.2 KiB
JSON
Raw Blame History

{"sections":[],"variants":[{"paths":["\/documentation\/marvelservice\/client\/getseriesbystoryid(_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["macOS"],"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"},{"text":"Operations","kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","preciseIdentifier":"s:13MarvelService10OperationsO"},{"text":".","kind":"text"},{"text":"getSeriesByStoryId","kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeriesByStoryId","preciseIdentifier":"s:13MarvelService10OperationsO18getSeriesByStoryIdO"},{"text":".","kind":"text"},{"text":"Input","kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeriesByStoryId\/Input","preciseIdentifier":"s:13MarvelService10OperationsO18getSeriesByStoryIdO5InputV"},{"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"},{"text":"getSeriesByStoryId","kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeriesByStoryId","preciseIdentifier":"s:13MarvelService10OperationsO18getSeriesByStoryIdO"},{"text":".","kind":"text"},{"text":"Output","kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeriesByStoryId\/Output","preciseIdentifier":"s:13MarvelService10OperationsO18getSeriesByStoryIdO6OutputO"}]}]},{"content":[{"type":"heading","level":2,"text":"Discussion","anchor":"discussion"},{"type":"paragraph","inlineContent":[{"text":"Fetches lists of comic series in which the specified story takes place.","type":"text"}]},{"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"}],"style":"note","name":"Remark"}],"kind":"content"}],"schemaVersion":{"minor":3,"major":0,"patch":0},"abstract":[{"type":"text","text":"Fetches lists of series filtered by a story id."}],"hierarchy":{"paths":[["doc:\/\/MarvelService\/documentation\/MarvelService","doc:\/\/MarvelService\/documentation\/MarvelService\/Client"]]},"identifier":{"url":"doc:\/\/MarvelService\/documentation\/MarvelService\/Client\/getSeriesByStoryId(_:)","interfaceLanguage":"swift"},"kind":"symbol","metadata":{"title":"getSeriesByStoryId(_:)","externalID":"s:13MarvelService6ClientV18getSeriesByStoryIdyAA10OperationsOADO6OutputOAG5InputVYaKF","role":"symbol","modules":[{"name":"MarvelService"}],"symbolKind":"method","roleHeading":"Instance Method","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"}]},"references":{"doc://MarvelService/documentation/MarvelService/Client/getSeriesByStoryId(_:)":{"url":"\/documentation\/marvelservice\/client\/getseriesbystoryid(_:)","title":"getSeriesByStoryId(_:)","type":"topic","abstract":[{"type":"text","text":"Fetches lists of series filtered by a story id."}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Client\/getSeriesByStoryId(_:)","kind":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getSeriesByStoryId"},{"kind":"text","text":"("},{"preciseIdentifier":"s:13MarvelService10OperationsO","kind":"typeIdentifier","text":"Operations"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO18getSeriesByStoryIdO","kind":"typeIdentifier","text":"getSeriesByStoryId"},{"text":".","kind":"text"},{"text":"Input","preciseIdentifier":"s:13MarvelService10OperationsO18getSeriesByStoryIdO5InputV","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":"getSeriesByStoryId","preciseIdentifier":"s:13MarvelService10OperationsO18getSeriesByStoryIdO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Output","preciseIdentifier":"s:13MarvelService10OperationsO18getSeriesByStoryIdO6OutputO","kind":"typeIdentifier"}]},"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/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/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/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":{"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/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"}}}
View Git Blame Copy Permalink