Files
marvel-service/docs/data/documentation/marvelservice/apiprotocol/getcomicsbystoryid(_:).json
T

1 line
9.4 KiB
JSON

{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/MarvelService\/documentation\/MarvelService\/APIProtocol\/getComicsByStoryId(_:)"},"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"hierarchy":{"paths":[["doc:\/\/MarvelService\/documentation\/MarvelService","doc:\/\/MarvelService\/documentation\/MarvelService\/APIProtocol"]]},"metadata":{"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getComicsByStoryId","kind":"identifier"},{"text":"(","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO"},{"text":".","kind":"text"},{"text":"getComicsByStoryId","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getComicsByStoryIdO"},{"text":".","kind":"text"},{"text":"Input","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getComicsByStoryIdO5InputV"},{"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":"getComicsByStoryId","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getComicsByStoryIdO"},{"text":".","kind":"text"},{"text":"Output","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getComicsByStoryIdO6OutputO"}],"roleHeading":"Instance Method","modules":[{"name":"MarvelService"}],"role":"symbol","title":"getComicsByStoryId(_:)","externalID":"s:13MarvelService11APIProtocolP18getComicsByStoryIdyAA10OperationsOADO6OutputOAG5InputVYaKF","required":true,"symbolKind":"method"},"sections":[],"primaryContentSections":[{"declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getComicsByStoryId","kind":"identifier"},{"text":"(","kind":"text"},{"text":"_","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"input","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations"},{"text":".","kind":"text"},{"text":"getComicsByStoryId","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getComicsByStoryIdO","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicsByStoryId"},{"text":".","kind":"text"},{"kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicsByStoryId\/Input","text":"Input","preciseIdentifier":"s:13MarvelService10OperationsO18getComicsByStoryIdO5InputV"},{"text":") ","kind":"text"},{"kind":"keyword","text":"async"},{"text":" ","kind":"text"},{"kind":"keyword","text":"throws"},{"text":" -> ","kind":"text"},{"kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","text":"Operations","preciseIdentifier":"s:13MarvelService10OperationsO"},{"text":".","kind":"text"},{"kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicsByStoryId","text":"getComicsByStoryId","preciseIdentifier":"s:13MarvelService10OperationsO18getComicsByStoryIdO"},{"text":".","kind":"text"},{"kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicsByStoryId\/Output","text":"Output","preciseIdentifier":"s:13MarvelService10OperationsO18getComicsByStoryIdO6OutputO"}],"languages":["swift"],"platforms":["macOS"]}],"kind":"declarations"},{"content":[{"level":2,"text":"Discussion","anchor":"discussion","type":"heading"},{"inlineContent":[{"text":"Fetches lists of comics in which a specific story appears, with optional filters.","type":"text"}],"type":"paragraph"},{"name":"Remark","content":[{"type":"paragraph","inlineContent":[{"text":"HTTP ","type":"text"},{"code":"GET \/v1\/public\/stories\/{storyId}\/comics","type":"codeVoice"},{"text":".","type":"text"}]}],"type":"aside","style":"note"},{"name":"Remark","content":[{"type":"paragraph","inlineContent":[{"text":"Generated from ","type":"text"},{"code":"#\/paths\/\/v1\/public\/stories\/{storyId}\/comics\/get(getComicsByStoryId)","type":"codeVoice"},{"text":".","type":"text"}]}],"type":"aside","style":"note"}],"kind":"content"}],"abstract":[{"text":"Fetches lists of comics filtered by a story id.","type":"text"}],"variants":[{"paths":["\/documentation\/marvelservice\/apiprotocol\/getcomicsbystoryid(_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://MarvelService/documentation/MarvelService/Operations":{"navigatorTitle":[{"kind":"identifier","text":"Operations"}],"url":"\/documentation\/marvelservice\/operations","kind":"symbol","title":"Operations","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","role":"symbol","type":"topic","abstract":[{"type":"text","text":"API operations, with input and output types, generated from "},{"code":"#\/paths","type":"codeVoice"},{"text":" in the OpenAPI document.","type":"text"}],"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Operations"}]},"doc://MarvelService/documentation/MarvelService/Operations/getComicsByStoryId/Input":{"type":"topic","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicsByStoryId\/Input","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Input","kind":"identifier"}],"url":"\/documentation\/marvelservice\/operations\/getcomicsbystoryid\/input","title":"Operations.getComicsByStoryId.Input","kind":"symbol","role":"symbol","navigatorTitle":[{"text":"Input","kind":"identifier"}],"abstract":[]},"doc://MarvelService/documentation/MarvelService/APIProtocol":{"navigatorTitle":[{"kind":"identifier","text":"APIProtocol"}],"url":"\/documentation\/marvelservice\/apiprotocol","kind":"symbol","title":"APIProtocol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/APIProtocol","role":"symbol","type":"topic","abstract":[{"text":"A type that performs HTTP operations defined by the OpenAPI document.","type":"text"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"APIProtocol"}]},"doc://MarvelService/documentation/MarvelService/APIProtocol/getComicsByStoryId(_:)":{"url":"\/documentation\/marvelservice\/apiprotocol\/getcomicsbystoryid(_:)","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/APIProtocol\/getComicsByStoryId(_:)","type":"topic","kind":"symbol","role":"symbol","title":"getComicsByStoryId(_:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getComicsByStoryId","kind":"identifier"},{"text":"(","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO"},{"text":".","kind":"text"},{"text":"getComicsByStoryId","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getComicsByStoryIdO"},{"text":".","kind":"text"},{"text":"Input","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getComicsByStoryIdO5InputV"},{"text":") ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getComicsByStoryIdO","text":"getComicsByStoryId"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Output","preciseIdentifier":"s:13MarvelService10OperationsO18getComicsByStoryIdO6OutputO"}],"abstract":[{"type":"text","text":"Fetches lists of comics filtered by a story id."}],"required":true},"doc://MarvelService/documentation/MarvelService/Operations/getComicsByStoryId":{"type":"topic","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicsByStoryId","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getComicsByStoryId","kind":"identifier"}],"url":"\/documentation\/marvelservice\/operations\/getcomicsbystoryid","title":"Operations.getComicsByStoryId","kind":"symbol","role":"symbol","navigatorTitle":[{"text":"getComicsByStoryId","kind":"identifier"}],"abstract":[{"type":"text","text":"Fetches lists of comics filtered by a story id."}]},"doc://MarvelService/documentation/MarvelService/Operations/getComicsByStoryId/Output":{"type":"topic","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Output"}],"abstract":[],"navigatorTitle":[{"kind":"identifier","text":"Output"}],"kind":"symbol","role":"symbol","title":"Operations.getComicsByStoryId.Output","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicsByStoryId\/Output","url":"\/documentation\/marvelservice\/operations\/getcomicsbystoryid\/output"},"doc://MarvelService/documentation/MarvelService":{"url":"\/documentation\/marvelservice","kind":"symbol","title":"MarvelService","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService","role":"collection","type":"topic","abstract":[{"text":"A library that allows the developer to interact with the ","type":"text"},{"type":"strong","inlineContent":[{"text":"Marvel Comics API","type":"text"}]},{"text":" backend service.","type":"text"}]}}}