1 line
13 KiB
JSON
1 line
13 KiB
JSON
{"identifier":{"url":"doc:\/\/MarvelService\/documentation\/MarvelService\/Client\/getStoryById(path:headers:)","interfaceLanguage":"swift"},"schemaVersion":{"minor":3,"patch":0,"major":0},"hierarchy":{"paths":[["doc:\/\/MarvelService\/documentation\/MarvelService","doc:\/\/MarvelService\/documentation\/MarvelService\/Client"]]},"sections":[],"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getStoryById"},{"kind":"text","text":"("},{"kind":"externalParam","text":"path"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Operations","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","preciseIdentifier":"s:13MarvelService10OperationsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"getStoryById","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getStoryById","preciseIdentifier":"s:13MarvelService10OperationsO12getStoryByIdO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Input","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getStoryById\/Input","preciseIdentifier":"s:13MarvelService10OperationsO12getStoryByIdO5InputV"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Path","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getStoryById\/Input\/Path-swift.struct","preciseIdentifier":"s:13MarvelService10OperationsO12getStoryByIdO5InputV4PathV"},{"kind":"text","text":", "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Operations","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","preciseIdentifier":"s:13MarvelService10OperationsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"getStoryById","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getStoryById","preciseIdentifier":"s:13MarvelService10OperationsO12getStoryByIdO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Input","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getStoryById\/Input","preciseIdentifier":"s:13MarvelService10OperationsO12getStoryByIdO5InputV"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Headers","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getStoryById\/Input\/Headers-swift.struct","preciseIdentifier":"s:13MarvelService10OperationsO12getStoryByIdO5InputV7HeadersV"},{"kind":"text","text":" = .init()) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","text":"Operations","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","preciseIdentifier":"s:13MarvelService10OperationsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"getStoryById","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getStoryById","preciseIdentifier":"s:13MarvelService10OperationsO12getStoryByIdO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Output","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getStoryById\/Output","preciseIdentifier":"s:13MarvelService10OperationsO12getStoryByIdO6OutputO"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"content","content":[{"level":2,"anchor":"discussion","type":"heading","text":"Discussion"},{"inlineContent":[{"type":"text","text":"This method fetches a single comic story resource. It is the canonical URI for any comic story resource provided by the API."}],"type":"paragraph"},{"style":"note","type":"aside","name":"Remark","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"HTTP "},{"type":"codeVoice","code":"GET \/v1\/public\/stories\/{storyId}"},{"type":"text","text":"."}]}]},{"style":"note","type":"aside","name":"Remark","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Generated from "},{"type":"codeVoice","code":"#\/paths\/\/v1\/public\/stories\/{storyId}\/get(getStoryById)"},{"type":"text","text":"."}]}]}]}],"metadata":{"modules":[{"name":"MarvelService"}],"externalID":"s:13MarvelService11APIProtocolPAAE12getStoryById4path7headersAA10OperationsOADO6OutputOAI5InputV4PathV_AM7HeadersVtYaKF::SYNTHESIZED::s:13MarvelService6ClientV","symbolKind":"method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getStoryById"},{"kind":"text","text":"("},{"kind":"externalParam","text":"path"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Operations","preciseIdentifier":"s:13MarvelService10OperationsO"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO12getStoryByIdO","kind":"typeIdentifier","text":"getStoryById"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO12getStoryByIdO5InputV","kind":"typeIdentifier","text":"Input"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO12getStoryByIdO5InputV4PathV","kind":"typeIdentifier","text":"Path"},{"kind":"text","text":", "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": "},{"preciseIdentifier":"s:13MarvelService10OperationsO","kind":"typeIdentifier","text":"Operations"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO12getStoryByIdO","kind":"typeIdentifier","text":"getStoryById"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO12getStoryByIdO5InputV","kind":"typeIdentifier","text":"Input"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO12getStoryByIdO5InputV7HeadersV","kind":"typeIdentifier","text":"Headers"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"preciseIdentifier":"s:13MarvelService10OperationsO","kind":"typeIdentifier","text":"Operations"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO12getStoryByIdO","kind":"typeIdentifier","text":"getStoryById"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO12getStoryByIdO6OutputO","kind":"typeIdentifier","text":"Output"}],"title":"getStoryById(path:headers:)","role":"symbol","roleHeading":"Instance Method","extendedModule":"MarvelService"},"abstract":[{"type":"text","text":"Fetches a single comic story by id."}],"variants":[{"paths":["\/documentation\/marvelservice\/client\/getstorybyid(path:headers:)"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://MarvelService/documentation/MarvelService/Operations/getStoryById/Input/Headers-swift.struct":{"type":"topic","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Headers"}],"abstract":[],"navigatorTitle":[{"kind":"identifier","text":"Headers"}],"kind":"symbol","role":"symbol","title":"Operations.getStoryById.Input.Headers","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getStoryById\/Input\/Headers-swift.struct","url":"\/documentation\/marvelservice\/operations\/getstorybyid\/input\/headers-swift.struct"},"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/Client/getStoryById(path:headers:)":{"url":"\/documentation\/marvelservice\/client\/getstorybyid(path:headers:)","kind":"symbol","title":"getStoryById(path:headers:)","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Client\/getStoryById(path:headers:)","role":"symbol","type":"topic","abstract":[{"type":"text","text":"Fetches a single comic story by id."}],"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"getStoryById","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"path"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO12getStoryByIdO","text":"getStoryById"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO12getStoryByIdO5InputV","text":"Input"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO12getStoryByIdO5InputV4PathV","text":"Path"},{"kind":"text","text":", "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations"},{"text":".","kind":"text"},{"text":"getStoryById","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO12getStoryByIdO"},{"text":".","kind":"text"},{"text":"Input","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO12getStoryByIdO5InputV"},{"kind":"text","text":"."},{"text":"Headers","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO12getStoryByIdO5InputV7HeadersV"},{"kind":"text","text":") "},{"text":"async","kind":"keyword"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO12getStoryByIdO","text":"getStoryById"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO12getStoryByIdO6OutputO","text":"Output"}]},"doc://MarvelService/documentation/MarvelService/Operations/getStoryById/Input/Path-swift.struct":{"navigatorTitle":[{"text":"Path","kind":"identifier"}],"url":"\/documentation\/marvelservice\/operations\/getstorybyid\/input\/path-swift.struct","kind":"symbol","title":"Operations.getStoryById.Input.Path","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getStoryById\/Input\/Path-swift.struct","role":"symbol","type":"topic","abstract":[],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Path","kind":"identifier"}]},"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/getStoryById/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.getStoryById.Output","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getStoryById\/Output","url":"\/documentation\/marvelservice\/operations\/getstorybyid\/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"}]},"doc://MarvelService/documentation/MarvelService/Operations/getStoryById":{"navigatorTitle":[{"kind":"identifier","text":"getStoryById"}],"url":"\/documentation\/marvelservice\/operations\/getstorybyid","kind":"symbol","title":"Operations.getStoryById","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getStoryById","role":"symbol","type":"topic","abstract":[{"text":"Fetches a single comic story by id.","type":"text"}],"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"getStoryById"}]},"doc://MarvelService/documentation/MarvelService/Operations/getStoryById/Input":{"type":"topic","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Input"}],"abstract":[],"navigatorTitle":[{"kind":"identifier","text":"Input"}],"kind":"symbol","role":"symbol","title":"Operations.getStoryById.Input","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getStoryById\/Input","url":"\/documentation\/marvelservice\/operations\/getstorybyid\/input"}}} |