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

1 line
17 KiB
JSON

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