Files
marvel-service/docs/data/documentation/marvelservice/apiprotocol/getcomicbyid(path:headers:).json
T

1 line
13 KiB
JSON

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