1 line
17 KiB
JSON
1 line
17 KiB
JSON
{"schemaVersion":{"minor":3,"patch":0,"major":0},"identifier":{"url":"doc:\/\/MarvelService\/documentation\/MarvelService\/APIProtocol\/getComicsByStoryId(path:query:headers:)","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/MarvelService\/documentation\/MarvelService","doc:\/\/MarvelService\/documentation\/MarvelService\/APIProtocol"]]},"sections":[],"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getComicsByStoryId","kind":"identifier"},{"text":"(","kind":"text"},{"text":"path","kind":"externalParam"},{"text":": ","kind":"text"},{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","text":"Operations","preciseIdentifier":"s:13MarvelService10OperationsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicsByStoryId","text":"getComicsByStoryId","preciseIdentifier":"s:13MarvelService10OperationsO18getComicsByStoryIdO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicsByStoryId\/Input","text":"Input","preciseIdentifier":"s:13MarvelService10OperationsO18getComicsByStoryIdO5InputV","kind":"typeIdentifier"},{"text":".","kind":"text"},{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicsByStoryId\/Input\/Path-swift.struct","text":"Path","preciseIdentifier":"s:13MarvelService10OperationsO18getComicsByStoryIdO5InputV4PathV","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"query","kind":"externalParam"},{"text":": ","kind":"text"},{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","text":"Operations","preciseIdentifier":"s:13MarvelService10OperationsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicsByStoryId","text":"getComicsByStoryId","preciseIdentifier":"s:13MarvelService10OperationsO18getComicsByStoryIdO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicsByStoryId\/Input","text":"Input","preciseIdentifier":"s:13MarvelService10OperationsO18getComicsByStoryIdO5InputV","kind":"typeIdentifier"},{"text":".","kind":"text"},{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicsByStoryId\/Input\/Query-swift.struct","text":"Query","preciseIdentifier":"s:13MarvelService10OperationsO18getComicsByStoryIdO5InputV5QueryV","kind":"typeIdentifier"},{"text":" = .init(), ","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": ","kind":"text"},{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","text":"Operations","preciseIdentifier":"s:13MarvelService10OperationsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicsByStoryId","text":"getComicsByStoryId","preciseIdentifier":"s:13MarvelService10OperationsO18getComicsByStoryIdO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicsByStoryId\/Input","text":"Input","preciseIdentifier":"s:13MarvelService10OperationsO18getComicsByStoryIdO5InputV","kind":"typeIdentifier"},{"text":".","kind":"text"},{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicsByStoryId\/Input\/Headers-swift.struct","text":"Headers","preciseIdentifier":"s:13MarvelService10OperationsO18getComicsByStoryIdO5InputV7HeadersV","kind":"typeIdentifier"},{"text":" = .init()) ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","text":"Operations","preciseIdentifier":"s:13MarvelService10OperationsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicsByStoryId","text":"getComicsByStoryId","preciseIdentifier":"s:13MarvelService10OperationsO18getComicsByStoryIdO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicsByStoryId\/Output","text":"Output","preciseIdentifier":"s:13MarvelService10OperationsO18getComicsByStoryIdO6OutputO","kind":"typeIdentifier"}],"platforms":["macOS"],"languages":["swift"]}]},{"kind":"content","content":[{"text":"Discussion","anchor":"discussion","level":2,"type":"heading"},{"inlineContent":[{"text":"Fetches lists of comics in which a specific story appears, with optional filters.","type":"text"}],"type":"paragraph"},{"content":[{"inlineContent":[{"type":"text","text":"HTTP "},{"type":"codeVoice","code":"GET \/v1\/public\/stories\/{storyId}\/comics"},{"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}\/comics\/get(getComicsByStoryId)"},{"type":"text","text":"."}],"type":"paragraph"}],"style":"note","name":"Remark","type":"aside"}]}],"metadata":{"modules":[{"name":"MarvelService"}],"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"getComicsByStoryId"},{"kind":"text","text":"("},{"kind":"externalParam","text":"path"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getComicsByStoryIdO","text":"getComicsByStoryId"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getComicsByStoryIdO5InputV","text":"Input"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getComicsByStoryIdO5InputV4PathV","text":"Path"},{"kind":"text","text":", "},{"kind":"externalParam","text":"query"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getComicsByStoryIdO","text":"getComicsByStoryId"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Input","preciseIdentifier":"s:13MarvelService10OperationsO18getComicsByStoryIdO5InputV"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO18getComicsByStoryIdO5InputV5QueryV","text":"Query","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"headers","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getComicsByStoryIdO","text":"getComicsByStoryId"},{"text":".","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getComicsByStoryIdO5InputV","text":"Input"},{"text":".","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getComicsByStoryIdO5InputV7HeadersV","text":"Headers"},{"text":") ","kind":"text"},{"kind":"keyword","text":"async"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","text":"Operations","preciseIdentifier":"s:13MarvelService10OperationsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getComicsByStoryIdO","text":"getComicsByStoryId"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Output","preciseIdentifier":"s:13MarvelService10OperationsO18getComicsByStoryIdO6OutputO"}],"externalID":"s:13MarvelService11APIProtocolPAAE18getComicsByStoryId4path5query7headersAA10OperationsOADO6OutputOAJ5InputV4PathV_AN5QueryVAN7HeadersVtYaKF","extendedModule":"MarvelService","roleHeading":"Instance Method","role":"symbol","symbolKind":"method","title":"getComicsByStoryId(path:query:headers:)"},"abstract":[{"text":"Fetches lists of comics filtered by a story id.","type":"text"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/marvelservice\/apiprotocol\/getcomicsbystoryid(path:query:headers:)"]}],"references":{"doc://MarvelService/documentation/MarvelService/APIProtocol/getComicsByStoryId(path:query:headers:)":{"type":"topic","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/APIProtocol\/getComicsByStoryId(path:query:headers:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getComicsByStoryId","kind":"identifier"},{"text":"(","kind":"text"},{"text":"path","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","preciseIdentifier":"s:13MarvelService10OperationsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"getComicsByStoryId","preciseIdentifier":"s:13MarvelService10OperationsO18getComicsByStoryIdO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO18getComicsByStoryIdO5InputV","text":"Input","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO18getComicsByStoryIdO5InputV4PathV","text":"Path","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"query"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations"},{"kind":"text","text":"."},{"text":"getComicsByStoryId","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getComicsByStoryIdO"},{"text":".","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getComicsByStoryIdO5InputV","text":"Input"},{"text":".","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getComicsByStoryIdO5InputV5QueryV","text":"Query"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"headers"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations"},{"text":".","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getComicsByStoryIdO","text":"getComicsByStoryId"},{"text":".","kind":"text"},{"text":"Input","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getComicsByStoryIdO5InputV"},{"text":".","kind":"text"},{"text":"Headers","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getComicsByStoryIdO5InputV7HeadersV"},{"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"},{"preciseIdentifier":"s:13MarvelService10OperationsO18getComicsByStoryIdO","text":"getComicsByStoryId","kind":"typeIdentifier"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getComicsByStoryIdO6OutputO","text":"Output"}],"url":"\/documentation\/marvelservice\/apiprotocol\/getcomicsbystoryid(path:query:headers:)","title":"getComicsByStoryId(path:query:headers:)","kind":"symbol","role":"symbol","abstract":[{"type":"text","text":"Fetches lists of comics filtered by a story id."}]},"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":{"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"}]},"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/Operations/getComicsByStoryId/Input/Query-swift.struct":{"type":"topic","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicsByStoryId\/Input\/Query-swift.struct","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Query","kind":"identifier"}],"url":"\/documentation\/marvelservice\/operations\/getcomicsbystoryid\/input\/query-swift.struct","title":"Operations.getComicsByStoryId.Input.Query","kind":"symbol","role":"symbol","navigatorTitle":[{"text":"Query","kind":"identifier"}],"abstract":[]},"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/Operations/getComicsByStoryId/Input/Path-swift.struct":{"role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Path"}],"title":"Operations.getComicsByStoryId.Input.Path","kind":"symbol","abstract":[],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Path"}],"url":"\/documentation\/marvelservice\/operations\/getcomicsbystoryid\/input\/path-swift.struct","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicsByStoryId\/Input\/Path-swift.struct","type":"topic"},"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/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/Operations/getComicsByStoryId/Input/Headers-swift.struct":{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicsByStoryId\/Input\/Headers-swift.struct","type":"topic","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Headers","kind":"identifier"}],"url":"\/documentation\/marvelservice\/operations\/getcomicsbystoryid\/input\/headers-swift.struct","title":"Operations.getComicsByStoryId.Input.Headers","kind":"symbol","role":"symbol","navigatorTitle":[{"text":"Headers","kind":"identifier"}],"abstract":[]}}} |