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

1 line
9.1 KiB
JSON
Raw Normal View History

{"variants":[{"paths":["\/documentation\/marvelservice\/apiprotocol\/getstorybyid(_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"hierarchy":{"paths":[["doc:\/\/MarvelService\/documentation\/MarvelService","doc:\/\/MarvelService\/documentation\/MarvelService\/APIProtocol"]]},"abstract":[{"type":"text","text":"Fetches a single comic story by id."}],"kind":"symbol","metadata":{"modules":[{"name":"MarvelService"}],"externalID":"s:13MarvelService11APIProtocolP12getStoryByIdyAA10OperationsOADO6OutputOAG5InputVYaKF","symbolKind":"method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getStoryById"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO12getStoryByIdO","kind":"typeIdentifier","text":"getStoryById"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO12getStoryByIdO5InputV","text":"Input","kind":"typeIdentifier"},{"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":"."},{"text":"Output","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO12getStoryByIdO6OutputO"}],"title":"getStoryById(_:)","required":true,"role":"symbol","roleHeading":"Instance Method"},"sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getStoryById"},{"kind":"text","text":"("},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"kind":"internalParam","text":"input"},{"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":"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":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO12getStoryByIdO","kind":"typeIdentifier","text":"getStoryById","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getStoryById"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO12getStoryByIdO6OutputO","kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getStoryById\/Output","text":"Output"}],"platforms":["macOS"]}]},{"kind":"content","content":[{"level":2,"type":"heading","text":"Discussion","anchor":"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","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"HTTP "},{"type":"codeVoice","code":"GET \/v1\/public\/stories\/{storyId}"},{"type":"text","text":