Files
marvel-service/docs/data/documentation/marvelservice/apiprotocol/getseriesbystoryid(path:query:headers:).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
17 KiB
JSON

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