1 line
17 KiB
JSON
1 line
17 KiB
JSON
{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/MarvelService\/documentation\/MarvelService\/Client\/getCharactersByEventId(path:query:headers:)"},"schemaVersion":{"major":0,"minor":3,"patch":0},"hierarchy":{"paths":[["doc:\/\/MarvelService\/documentation\/MarvelService","doc:\/\/MarvelService\/documentation\/MarvelService\/Client"]]},"sections":[],"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["macOS"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getCharactersByEventId","kind":"identifier"},{"text":"(","kind":"text"},{"text":"path","kind":"externalParam"},{"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\/getCharactersByEventId","text":"getCharactersByEventId","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByEventIdO"},{"text":".","kind":"text"},{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByEventId\/Input","text":"Input","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByEventIdO5InputV"},{"text":".","kind":"text"},{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByEventId\/Input\/Path-swift.struct","text":"Path","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByEventIdO5InputV4PathV"},{"text":", ","kind":"text"},{"text":"query","kind":"externalParam"},{"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\/getCharactersByEventId","text":"getCharactersByEventId","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByEventIdO"},{"text":".","kind":"text"},{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByEventId\/Input","text":"Input","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByEventIdO5InputV"},{"text":".","kind":"text"},{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByEventId\/Input\/Query-swift.struct","text":"Query","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByEventIdO5InputV5QueryV"},{"text":" = .init(), ","kind":"text"},{"text":"headers","kind":"externalParam"},{"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\/getCharactersByEventId","text":"getCharactersByEventId","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByEventIdO"},{"text":".","kind":"text"},{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByEventId\/Input","text":"Input","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByEventIdO5InputV"},{"text":".","kind":"text"},{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByEventId\/Input\/Headers-swift.struct","text":"Headers","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByEventIdO5InputV7HeadersV"},{"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\/getCharactersByEventId","text":"getCharactersByEventId","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByEventIdO"},{"text":".","kind":"text"},{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByEventId\/Output","text":"Output","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByEventIdO6OutputO"}]}]},{"kind":"content","content":[{"type":"heading","level":2,"anchor":"discussion","text":"Discussion"},{"type":"paragraph","inlineContent":[{"text":"Fetches lists of characters which appear in a specific event, with optional filters.","type":"text"}]},{"type":"aside","style":"note","name":"Remark","content":[{"inlineContent":[{"type":"text","text":"HTTP "},{"type":"codeVoice","code":"GET \/v1\/public\/events\/{eventId}\/characters"},{"type":"text","text":"."}],"type":"paragraph"}]},{"type":"aside","style":"note","name":"Remark","content":[{"inlineContent":[{"type":"text","text":"Generated from "},{"type":"codeVoice","code":"#\/paths\/\/v1\/public\/events\/{eventId}\/characters\/get(getCharactersByEventId)"},{"type":"text","text":"."}],"type":"paragraph"}]}]}],"metadata":{"modules":[{"name":"MarvelService"}],"externalID":"s:13MarvelService11APIProtocolPAAE22getCharactersByEventId4path5query7headersAA10OperationsOADO6OutputOAJ5InputV4PathV_AN5QueryVAN7HeadersVtYaKF::SYNTHESIZED::s:13MarvelService6ClientV","symbolKind":"method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"getCharactersByEventId","kind":"identifier"},{"text":"(","kind":"text"},{"text":"path","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO"},{"text":".","kind":"text"},{"text":"getCharactersByEventId","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByEventIdO"},{"text":".","kind":"text"},{"text":"Input","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByEventIdO5InputV"},{"text":".","kind":"text"},{"text":"Path","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByEventIdO5InputV4PathV"},{"text":", ","kind":"text"},{"text":"query","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO"},{"text":".","kind":"text"},{"text":"getCharactersByEventId","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByEventIdO"},{"text":".","kind":"text"},{"text":"Input","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByEventIdO5InputV"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByEventIdO5InputV5QueryV","text":"Query"},{"kind":"text","text":", "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations"},{"text":".","kind":"text"},{"text":"getCharactersByEventId","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByEventIdO"},{"text":".","kind":"text"},{"text":"Input","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByEventIdO5InputV"},{"text":".","kind":"text"},{"text":"Headers","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByEventIdO5InputV7HeadersV"},{"text":") ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations"},{"kind":"text","text":"."},{"text":"getCharactersByEventId","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByEventIdO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByEventIdO6OutputO","text":"Output"}],"title":"getCharactersByEventId(path:query:headers:)","role":"symbol","roleHeading":"Instance Method","extendedModule":"MarvelService"},"abstract":[{"type":"text","text":"Fetches lists of characters filtered by an event id."}],"variants":[{"paths":["\/documentation\/marvelservice\/client\/getcharactersbyeventid(path:query:headers:)"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://MarvelService/documentation/MarvelService/Operations/getCharactersByEventId":{"type":"topic","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByEventId","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getCharactersByEventId","kind":"identifier"}],"url":"\/documentation\/marvelservice\/operations\/getcharactersbyeventid","title":"Operations.getCharactersByEventId","kind":"symbol","role":"symbol","navigatorTitle":[{"text":"getCharactersByEventId","kind":"identifier"}],"abstract":[{"text":"Fetches lists of characters filtered by an event id.","type":"text"}]},"doc://MarvelService/documentation/MarvelService/Operations/getCharactersByEventId/Input/Path-swift.struct":{"type":"topic","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByEventId\/Input\/Path-swift.struct","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"Path","kind":"identifier"}],"url":"\/documentation\/marvelservice\/operations\/getcharactersbyeventid\/input\/path-swift.struct","title":"Operations.getCharactersByEventId.Input.Path","kind":"symbol","role":"symbol","navigatorTitle":[{"text":"Path","kind":"identifier"}],"abstract":[]},"doc://MarvelService/documentation/MarvelService/Operations/getCharactersByEventId/Input/Headers-swift.struct":{"type":"topic","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByEventId\/Input\/Headers-swift.struct","url":"\/documentation\/marvelservice\/operations\/getcharactersbyeventid\/input\/headers-swift.struct","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Headers"}],"role":"symbol","title":"Operations.getCharactersByEventId.Input.Headers","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Headers"}],"abstract":[]},"doc://MarvelService/documentation/MarvelService/Operations/getCharactersByEventId/Input/Query-swift.struct":{"type":"topic","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByEventId\/Input\/Query-swift.struct","url":"\/documentation\/marvelservice\/operations\/getcharactersbyeventid\/input\/query-swift.struct","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Query"}],"role":"symbol","title":"Operations.getCharactersByEventId.Input.Query","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Query"}],"abstract":[]},"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/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/Operations/getCharactersByEventId/Input":{"type":"topic","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByEventId\/Input","url":"\/documentation\/marvelservice\/operations\/getcharactersbyeventid\/input","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Input"}],"role":"symbol","title":"Operations.getCharactersByEventId.Input","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Input"}],"abstract":[]},"doc://MarvelService/documentation/MarvelService/Operations/getCharactersByEventId/Output":{"role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Output"}],"title":"Operations.getCharactersByEventId.Output","kind":"symbol","abstract":[],"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Output"}],"url":"\/documentation\/marvelservice\/operations\/getcharactersbyeventid\/output","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByEventId\/Output","type":"topic"},"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/Client/getCharactersByEventId(path:query:headers:)":{"url":"\/documentation\/marvelservice\/client\/getcharactersbyeventid(path:query:headers:)","type":"topic","abstract":[{"text":"Fetches lists of characters filtered by an event id.","type":"text"}],"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getCharactersByEventId"},{"kind":"text","text":"("},{"kind":"externalParam","text":"path"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Operations","preciseIdentifier":"s:13MarvelService10OperationsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"getCharactersByEventId","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByEventIdO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Input","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByEventIdO5InputV"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Path","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByEventIdO5InputV4PathV"},{"kind":"text","text":", "},{"kind":"externalParam","text":"query"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Operations","preciseIdentifier":"s:13MarvelService10OperationsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"getCharactersByEventId","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByEventIdO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Input","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByEventIdO5InputV"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Query","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByEventIdO5InputV5QueryV"},{"kind":"text","text":", "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Operations","preciseIdentifier":"s:13MarvelService10OperationsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"getCharactersByEventId","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByEventIdO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Input","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByEventIdO5InputV"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Headers","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByEventIdO5InputV7HeadersV"},{"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":"getCharactersByEventId","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByEventIdO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Output","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByEventIdO6OutputO"}],"title":"getCharactersByEventId(path:query:headers:)","kind":"symbol","role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Client\/getCharactersByEventId(path:query:headers:)"}}} |