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