Files
marvel-service/docs/data/documentation/marvelservice/client/getcreatorsbystoryid(path:query:headers:).json
T

1 line
17 KiB
JSON

{"schemaVersion":{"major":0,"minor":3,"patch":0},"identifier":{"url":"doc:\/\/MarvelService\/documentation\/MarvelService\/Client\/getCreatorsByStoryId(path:query:headers:)","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/MarvelService\/documentation\/MarvelService","doc:\/\/MarvelService\/documentation\/MarvelService\/Client"]]},"sections":[],"kind":"symbol","primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getCreatorsByStoryId"},{"kind":"text","text":"("},{"kind":"externalParam","text":"path"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCreatorsByStoryId","preciseIdentifier":"s:13MarvelService10OperationsO20getCreatorsByStoryIdO","text":"getCreatorsByStoryId"},{"kind":"text","text":"."},{"kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCreatorsByStoryId\/Input","preciseIdentifier":"s:13MarvelService10OperationsO20getCreatorsByStoryIdO5InputV","text":"Input"},{"kind":"text","text":"."},{"kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCreatorsByStoryId\/Input\/Path-swift.struct","preciseIdentifier":"s:13MarvelService10OperationsO20getCreatorsByStoryIdO5InputV4PathV","text":"Path"},{"kind":"text","text":", "},{"kind":"externalParam","text":"query"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCreatorsByStoryId","preciseIdentifier":"s:13MarvelService10OperationsO20getCreatorsByStoryIdO","text":"getCreatorsByStoryId"},{"kind":"text","text":"."},{"kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCreatorsByStoryId\/Input","preciseIdentifier":"s:13MarvelService10OperationsO20getCreatorsByStoryIdO5InputV","text":"Input"},{"kind":"text","text":"."},{"kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCreatorsByStoryId\/Input\/Query-swift.struct","preciseIdentifier":"s:13MarvelService10OperationsO20getCreatorsByStoryIdO5InputV5QueryV","text":"Query"},{"kind":"text","text":" = .init(), "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCreatorsByStoryId","preciseIdentifier":"s:13MarvelService10OperationsO20getCreatorsByStoryIdO","text":"getCreatorsByStoryId"},{"kind":"text","text":"."},{"kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCreatorsByStoryId\/Input","preciseIdentifier":"s:13MarvelService10OperationsO20getCreatorsByStoryIdO5InputV","text":"Input"},{"kind":"text","text":"."},{"kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCreatorsByStoryId\/Input\/Headers-swift.struct","preciseIdentifier":"s:13MarvelService10OperationsO20getCreatorsByStoryIdO5InputV7HeadersV","text":"Headers"},{"kind":"text","text":" = .init()) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCreatorsByStoryId","preciseIdentifier":"s:13MarvelService10OperationsO20getCreatorsByStoryIdO","text":"getCreatorsByStoryId"},{"kind":"text","text":"."},{"kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCreatorsByStoryId\/Output","preciseIdentifier":"s:13MarvelService10OperationsO20getCreatorsByStoryIdO6OutputO","text":"Output"}],"platforms":["macOS"],"languages":["swift"]}],"kind":"declarations"},{"content":[{"type":"heading","level":2,"text":"Discussion","anchor":"discussion"},{"type":"paragraph","inlineContent":[{"type":"text","text":"Fetches lists of comic creators whose work appears in a specific story, with optional filters."}]},{"type":"aside","style":"note","content":[{"inlineContent":[{"type":"text","text":"HTTP "},{"type":"codeVoice","code":"GET \/v1\/public\/stories\/{storyId}\/creators"},{"type":"text","text":"."}],"type":"paragraph"}],"name":"Remark"},{"type":"aside","style":"note","content":[{"inlineContent":[{"type":"text","text":"Generated from "},{"code":"#\/paths\/\/v1\/public\/stories\/{storyId}\/creators\/get(getCreatorsByStoryId)","type":"codeVoice"},{"type":"text","text":"."}],"type":"paragraph"}],"name":"Remark"}],"kind":"content"}],"metadata":{"modules":[{"name":"MarvelService"}],"externalID":"s:13MarvelService11APIProtocolPAAE20getCreatorsByStoryId4path5query7headersAA10OperationsOADO6OutputOAJ5InputV4PathV_AN5QueryVAN7HeadersVtYaKF::SYNTHESIZED::s:13MarvelService6ClientV","symbolKind":"method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getCreatorsByStoryId"},{"kind":"text","text":"("},{"kind":"externalParam","text":"path"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Operations","preciseIdentifier":"s:13MarvelService10OperationsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"getCreatorsByStoryId","preciseIdentifier":"s:13MarvelService10OperationsO20getCreatorsByStoryIdO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Input","preciseIdentifier":"s:13MarvelService10OperationsO20getCreatorsByStoryIdO5InputV"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Path","preciseIdentifier":"s:13MarvelService10OperationsO20getCreatorsByStoryIdO5InputV4PathV"},{"kind":"text","text":", "},{"kind":"externalParam","text":"query"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Operations","preciseIdentifier":"s:13MarvelService10OperationsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"getCreatorsByStoryId","preciseIdentifier":"s:13MarvelService10OperationsO20getCreatorsByStoryIdO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Input","preciseIdentifier":"s:13MarvelService10OperationsO20getCreatorsByStoryIdO5InputV"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Query","preciseIdentifier":"s:13MarvelService10OperationsO20getCreatorsByStoryIdO5InputV5QueryV"},{"kind":"text","text":", "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Operations","preciseIdentifier":"s:13MarvelService10OperationsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"getCreatorsByStoryId","preciseIdentifier":"s:13MarvelService10OperationsO20getCreatorsByStoryIdO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Input","preciseIdentifier":"s:13MarvelService10OperationsO20getCreatorsByStoryIdO5InputV"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Headers","preciseIdentifier":"s:13MarvelService10OperationsO20getCreatorsByStoryIdO5InputV7HeadersV"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","text":"Operations","preciseIdentifier":"s:13MarvelService10OperationsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"getCreatorsByStoryId","preciseIdentifier":"s:13MarvelService10OperationsO20getCreatorsByStoryIdO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Output","preciseIdentifier":"s:13MarvelService10OperationsO20getCreatorsByStoryIdO6OutputO"}],"title":"getCreatorsByStoryId(path:query:headers:)","role":"symbol","roleHeading":"Instance Method","extendedModule":"MarvelService"},"abstract":[{"type":"text","text":"Fetches lists of creators filtered by a story id."}],"variants":[{"paths":["\/documentation\/marvelservice\/client\/getcreatorsbystoryid(path:query:headers:)"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://MarvelService/documentation/MarvelService/Operations/getCreatorsByStoryId/Input/Query-swift.struct":{"type":"topic","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCreatorsByStoryId\/Input\/Query-swift.struct","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Query"}],"url":"\/documentation\/marvelservice\/operations\/getcreatorsbystoryid\/input\/query-swift.struct","title":"Operations.getCreatorsByStoryId.Input.Query","kind":"symbol","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Query"}],"abstract":[]},"doc://MarvelService/documentation/MarvelService/Operations/getCreatorsByStoryId/Input/Headers-swift.struct":{"role":"symbol","navigatorTitle":[{"text":"Headers","kind":"identifier"}],"title":"Operations.getCreatorsByStoryId.Input.Headers","kind":"symbol","abstract":[],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Headers"}],"url":"\/documentation\/marvelservice\/operations\/getcreatorsbystoryid\/input\/headers-swift.struct","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCreatorsByStoryId\/Input\/Headers-swift.struct","type":"topic"},"doc://MarvelService/documentation/MarvelService/Operations/getCreatorsByStoryId":{"navigatorTitle":[{"text":"getCreatorsByStoryId","kind":"identifier"}],"url":"\/documentation\/marvelservice\/operations\/getcreatorsbystoryid","kind":"symbol","title":"Operations.getCreatorsByStoryId","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCreatorsByStoryId","role":"symbol","type":"topic","abstract":[{"type":"text","text":"Fetches lists of creators filtered by a story id."}],"fragments":[{"kind":"keyword","text":"enum"},{"text":" ","kind":"text"},{"text":"getCreatorsByStoryId","kind":"identifier"}]},"doc://MarvelService/documentation/MarvelService/Operations/getCreatorsByStoryId/Output":{"type":"topic","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCreatorsByStoryId\/Output","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Output"}],"url":"\/documentation\/marvelservice\/operations\/getcreatorsbystoryid\/output","title":"Operations.getCreatorsByStoryId.Output","kind":"symbol","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Output"}],"abstract":[]},"doc://MarvelService/documentation/MarvelService/Client":{"type":"topic","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Client","url":"\/documentation\/marvelservice\/client","kind":"symbol","navigatorTitle":[{"text":"Client","kind":"identifier"}],"role":"symbol","title":"Client","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Client","kind":"identifier"}],"abstract":[{"type":"text","text":"The Marvel Comics RESTful API."}]},"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/getCreatorsByStoryId/Input/Path-swift.struct":{"type":"topic","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCreatorsByStoryId\/Input\/Path-swift.struct","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Path","kind":"identifier"}],"url":"\/documentation\/marvelservice\/operations\/getcreatorsbystoryid\/input\/path-swift.struct","title":"Operations.getCreatorsByStoryId.Input.Path","kind":"symbol","role":"symbol","navigatorTitle":[{"text":"Path","kind":"identifier"}],"abstract":[]},"doc://MarvelService/documentation/MarvelService/Operations/getCreatorsByStoryId/Input":{"type":"topic","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCreatorsByStoryId\/Input","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Input","kind":"identifier"}],"url":"\/documentation\/marvelservice\/operations\/getcreatorsbystoryid\/input","title":"Operations.getCreatorsByStoryId.Input","kind":"symbol","role":"symbol","navigatorTitle":[{"text":"Input","kind":"identifier"}],"abstract":[]},"doc://MarvelService/documentation/MarvelService/Client/getCreatorsByStoryId(path:query:headers:)":{"type":"topic","url":"\/documentation\/marvelservice\/client\/getcreatorsbystoryid(path:query:headers:)","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Client\/getCreatorsByStoryId(path:query:headers:)","kind":"symbol","role":"symbol","title":"getCreatorsByStoryId(path:query:headers:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getCreatorsByStoryId"},{"kind":"text","text":"("},{"kind":"externalParam","text":"path"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Operations","preciseIdentifier":"s:13MarvelService10OperationsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"getCreatorsByStoryId","preciseIdentifier":"s:13MarvelService10OperationsO20getCreatorsByStoryIdO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Input","preciseIdentifier":"s:13MarvelService10OperationsO20getCreatorsByStoryIdO5InputV"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Path","preciseIdentifier":"s:13MarvelService10OperationsO20getCreatorsByStoryIdO5InputV4PathV"},{"kind":"text","text":", "},{"kind":"externalParam","text":"query"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Operations","preciseIdentifier":"s:13MarvelService10OperationsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"getCreatorsByStoryId","preciseIdentifier":"s:13MarvelService10OperationsO20getCreatorsByStoryIdO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Input","preciseIdentifier":"s:13MarvelService10OperationsO20getCreatorsByStoryIdO5InputV"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Query","preciseIdentifier":"s:13MarvelService10OperationsO20getCreatorsByStoryIdO5InputV5QueryV"},{"kind":"text","text":", "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Operations","preciseIdentifier":"s:13MarvelService10OperationsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"getCreatorsByStoryId","preciseIdentifier":"s:13MarvelService10OperationsO20getCreatorsByStoryIdO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Input","preciseIdentifier":"s:13MarvelService10OperationsO20getCreatorsByStoryIdO5InputV"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Headers","preciseIdentifier":"s:13MarvelService10OperationsO20getCreatorsByStoryIdO5InputV7HeadersV"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","text":"Operations","preciseIdentifier":"s:13MarvelService10OperationsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"getCreatorsByStoryId","preciseIdentifier":"s:13MarvelService10OperationsO20getCreatorsByStoryIdO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Output","preciseIdentifier":"s:13MarvelService10OperationsO20getCreatorsByStoryIdO6OutputO"}],"abstract":[{"text":"Fetches lists of creators filtered by a story id.","type":"text"}]},"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"}]}}}