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

1 line
17 KiB
JSON

{"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getStoriesByCharacterId"},{"kind":"text","text":"("},{"kind":"externalParam","text":"path"},{"kind":"text","text":": "},{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","kind":"typeIdentifier","text":"Operations","preciseIdentifier":"s:13MarvelService10OperationsO"},{"kind":"text","text":"."},{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getStoriesByCharacterId","kind":"typeIdentifier","text":"getStoriesByCharacterId","preciseIdentifier":"s:13MarvelService10OperationsO23getStoriesByCharacterIdO"},{"kind":"text","text":"."},{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getStoriesByCharacterId\/Input","kind":"typeIdentifier","text":"Input","preciseIdentifier":"s:13MarvelService10OperationsO23getStoriesByCharacterIdO5InputV"},{"kind":"text","text":"."},{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getStoriesByCharacterId\/Input\/Path-swift.struct","kind":"typeIdentifier","text":"Path","preciseIdentifier":"s:13MarvelService10OperationsO23getStoriesByCharacterIdO5InputV4PathV"},{"kind":"text","text":", "},{"kind":"externalParam","text":"query"},{"kind":"text","text":": "},{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","kind":"typeIdentifier","text":"Operations","preciseIdentifier":"s:13MarvelService10OperationsO"},{"kind":"text","text":"."},{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getStoriesByCharacterId","kind":"typeIdentifier","text":"getStoriesByCharacterId","preciseIdentifier":"s:13MarvelService10OperationsO23getStoriesByCharacterIdO"},{"kind":"text","text":"."},{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getStoriesByCharacterId\/Input","kind":"typeIdentifier","text":"Input","preciseIdentifier":"s:13MarvelService10OperationsO23getStoriesByCharacterIdO5InputV"},{"kind":"text","text":"."},{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getStoriesByCharacterId\/Input\/Query-swift.struct","kind":"typeIdentifier","text":"Query","preciseIdentifier":"s:13MarvelService10OperationsO23getStoriesByCharacterIdO5InputV5QueryV"},{"kind":"text","text":" = .init(), "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": "},{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","kind":"typeIdentifier","text":"Operations","preciseIdentifier":"s:13MarvelService10OperationsO"},{"kind":"text","text":"."},{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getStoriesByCharacterId","kind":"typeIdentifier","text":"getStoriesByCharacterId","preciseIdentifier":"s:13MarvelService10OperationsO23getStoriesByCharacterIdO"},{"kind":"text","text":"."},{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getStoriesByCharacterId\/Input","kind":"typeIdentifier","text":"Input","preciseIdentifier":"s:13MarvelService10OperationsO23getStoriesByCharacterIdO5InputV"},{"kind":"text","text":"."},{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getStoriesByCharacterId\/Input\/Headers-swift.struct","kind":"typeIdentifier","text":"Headers","preciseIdentifier":"s:13MarvelService10OperationsO23getStoriesByCharacterIdO5InputV7HeadersV"},{"kind":"text","text":" = .init()) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","kind":"typeIdentifier","text":"Operations","preciseIdentifier":"s:13MarvelService10OperationsO"},{"kind":"text","text":"."},{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getStoriesByCharacterId","kind":"typeIdentifier","text":"getStoriesByCharacterId","preciseIdentifier":"s:13MarvelService10OperationsO23getStoriesByCharacterIdO"},{"kind":"text","text":"."},{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getStoriesByCharacterId\/Output","kind":"typeIdentifier","text":"Output","preciseIdentifier":"s:13MarvelService10OperationsO23getStoriesByCharacterIdO6OutputO"}],"platforms":["macOS"]}],"kind":"declarations"},{"content":[{"level":2,"type":"heading","text":"Discussion","anchor":"discussion"},{"inlineContent":[{"type":"text","text":"Fetches lists of comic stories featuring a specific character with optional filters."}],"type":"paragraph"},{"style":"note","name":"Remark","type":"aside","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"HTTP "},{"type":"codeVoice","code":"GET \/v1\/public\/characters\/{characterId}\/stories"},{"type":"text","text":"."}]}]},{"style":"note","name":"Remark","type":"aside","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Generated from "},{"type":"codeVoice","code":"#\/paths\/\/v1\/public\/characters\/{characterId}\/stories\/get(getStoriesByCharacterId)"},{"type":"text","text":"."}]}]}],"kind":"content"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/MarvelService\/documentation\/MarvelService\/Client\/getStoriesByCharacterId(path:query:headers:)"},"abstract":[{"type":"text","text":"Fetches lists of stories filtered by a character id."}],"variants":[{"paths":["\/documentation\/marvelservice\/client\/getstoriesbycharacterid(path:query:headers:)"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"hierarchy":{"paths":[["doc:\/\/MarvelService\/documentation\/MarvelService","doc:\/\/MarvelService\/documentation\/MarvelService\/Client"]]},"metadata":{"roleHeading":"Instance Method","externalID":"s:13MarvelService11APIProtocolPAAE23getStoriesByCharacterId4path5query7headersAA10OperationsOADO6OutputOAJ5InputV4PathV_AN5QueryVAN7HeadersVtYaKF::SYNTHESIZED::s:13MarvelService6ClientV","role":"symbol","symbolKind":"method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getStoriesByCharacterId"},{"kind":"text","text":"("},{"kind":"externalParam","text":"path"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO23getStoriesByCharacterIdO","text":"getStoriesByCharacterId"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO23getStoriesByCharacterIdO5InputV","text":"Input"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO23getStoriesByCharacterIdO5InputV4PathV","text":"Path"},{"kind":"text","text":", "},{"kind":"externalParam","text":"query"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO23getStoriesByCharacterIdO","text":"getStoriesByCharacterId"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO23getStoriesByCharacterIdO5InputV","text":"Input"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO23getStoriesByCharacterIdO5InputV5QueryV","text":"Query"},{"kind":"text","text":", "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO23getStoriesByCharacterIdO","text":"getStoriesByCharacterId"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO23getStoriesByCharacterIdO5InputV","text":"Input"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO23getStoriesByCharacterIdO5InputV7HeadersV","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:13MarvelService10OperationsO23getStoriesByCharacterIdO","text":"getStoriesByCharacterId"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO23getStoriesByCharacterIdO6OutputO","text":"Output"}],"extendedModule":"MarvelService","title":"getStoriesByCharacterId(path:query:headers:)","modules":[{"name":"MarvelService"}]},"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"doc://MarvelService/documentation/MarvelService/Operations/getStoriesByCharacterId/Input":{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getStoriesByCharacterId\/Input","kind":"symbol","abstract":[],"type":"topic","title":"Operations.getStoriesByCharacterId.Input","navigatorTitle":[{"kind":"identifier","text":"Input"}],"url":"\/documentation\/marvelservice\/operations\/getstoriesbycharacterid\/input","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Input"}],"role":"symbol"},"doc://MarvelService/documentation/MarvelService/Operations/getStoriesByCharacterId/Input/Query-swift.struct":{"url":"\/documentation\/marvelservice\/operations\/getstoriesbycharacterid\/input\/query-swift.struct","role":"symbol","navigatorTitle":[{"text":"Query","kind":"identifier"}],"type":"topic","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getStoriesByCharacterId\/Input\/Query-swift.struct","title":"Operations.getStoriesByCharacterId.Input.Query","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Query","kind":"identifier"}],"abstract":[],"kind":"symbol"},"doc://MarvelService/documentation/MarvelService/Client":{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Client","kind":"symbol","abstract":[{"type":"text","text":"The Marvel Comics RESTful API."}],"type":"topic","title":"Client","navigatorTitle":[{"kind":"identifier","text":"Client"}],"url":"\/documentation\/marvelservice\/client","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Client"}],"role":"symbol"},"doc://MarvelService/documentation/MarvelService/Operations/getStoriesByCharacterId":{"fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getStoriesByCharacterId","kind":"identifier"}],"role":"symbol","url":"\/documentation\/marvelservice\/operations\/getstoriesbycharacterid","kind":"symbol","type":"topic","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getStoriesByCharacterId","abstract":[{"type":"text","text":"Fetches lists of stories filtered by a character id."}],"title":"Operations.getStoriesByCharacterId","navigatorTitle":[{"text":"getStoriesByCharacterId","kind":"identifier"}]},"doc://MarvelService/documentation/MarvelService/Client/getStoriesByCharacterId(path:query:headers:)":{"type":"topic","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Client\/getStoriesByCharacterId(path:query:headers:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getStoriesByCharacterId"},{"kind":"text","text":"("},{"kind":"externalParam","text":"path"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO23getStoriesByCharacterIdO","text":"getStoriesByCharacterId"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO23getStoriesByCharacterIdO5InputV","text":"Input"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO23getStoriesByCharacterIdO5InputV4PathV","text":"Path"},{"kind":"text","text":", "},{"kind":"externalParam","text":"query"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO23getStoriesByCharacterIdO","text":"getStoriesByCharacterId"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO23getStoriesByCharacterIdO5InputV","text":"Input"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO23getStoriesByCharacterIdO5InputV5QueryV","kind":"typeIdentifier","text":"Query"},{"kind":"text","text":", "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": "},{"preciseIdentifier":"s:13MarvelService10OperationsO","kind":"typeIdentifier","text":"Operations"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO23getStoriesByCharacterIdO","kind":"typeIdentifier","text":"getStoriesByCharacterId"},{"text":".","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO23getStoriesByCharacterIdO5InputV","text":"Input"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO23getStoriesByCharacterIdO5InputV7HeadersV","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"},{"text":".","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO23getStoriesByCharacterIdO","text":"getStoriesByCharacterId"},{"text":".","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO23getStoriesByCharacterIdO6OutputO","text":"Output"}],"role":"symbol","abstract":[{"type":"text","text":"Fetches lists of stories filtered by a character id."}],"url":"\/documentation\/marvelservice\/client\/getstoriesbycharacterid(path:query:headers:)","kind":"symbol","title":"getStoriesByCharacterId(path:query:headers:)"},"doc://MarvelService/documentation/MarvelService/Operations/getStoriesByCharacterId/Output":{"title":"Operations.getStoriesByCharacterId.Output","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getStoriesByCharacterId\/Output","fragments":[{"text":"enum","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Output"}],"navigatorTitle":[{"kind":"identifier","text":"Output"}],"role":"symbol","abstract":[],"url":"\/documentation\/marvelservice\/operations\/getstoriesbycharacterid\/output","kind":"symbol","type":"topic"},"doc://MarvelService/documentation/MarvelService/Operations":{"role":"symbol","abstract":[{"type":"text","text":"API operations, with input and output types, generated from "},{"type":"codeVoice","code":"#\/paths"},{"type":"text","text":" in the OpenAPI document."}],"kind":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Operations"}],"navigatorTitle":[{"text":"Operations","kind":"identifier"}],"type":"topic","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","title":"Operations","url":"\/documentation\/marvelservice\/operations"},"doc://MarvelService/documentation/MarvelService/Operations/getStoriesByCharacterId/Input/Path-swift.struct":{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getStoriesByCharacterId\/Input\/Path-swift.struct","kind":"symbol","abstract":[],"type":"topic","title":"Operations.getStoriesByCharacterId.Input.Path","navigatorTitle":[{"kind":"identifier","text":"Path"}],"url":"\/documentation\/marvelservice\/operations\/getstoriesbycharacterid\/input\/path-swift.struct","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Path"}],"role":"symbol"},"doc://MarvelService/documentation/MarvelService/Operations/getStoriesByCharacterId/Input/Headers-swift.struct":{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getStoriesByCharacterId\/Input\/Headers-swift.struct","kind":"symbol","abstract":[],"type":"topic","title":"Operations.getStoriesByCharacterId.Input.Headers","navigatorTitle":[{"text":"Headers","kind":"identifier"}],"url":"\/documentation\/marvelservice\/operations\/getstoriesbycharacterid\/input\/headers-swift.struct","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Headers","kind":"identifier"}],"role":"symbol"},"doc://MarvelService/documentation/MarvelService":{"kind":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService","role":"collection","abstract":[{"type":"text","text":"A library that allows the developer to interact with the "},{"type":"strong","inlineContent":[{"type":"text","text":"Marvel Comics API"}]},{"type":"text","text":" backend service."}],"url":"\/documentation\/marvelservice","type":"topic","title":"MarvelService"}}}