marvel-service/docs/data/documentation/marvelservice/operations/getcharacters/input/query-swift.struct.json

{"identifier":{"url":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacters\/Input\/Query-swift.struct","interfaceLanguage":"swift"},"schemaVersion":{"patch":0,"major":0,"minor":3},"relationshipsSections":[{"title":"Conforms To","identifiers":["doc:\/\/MarvelService\/SQ","doc:\/\/MarvelService\/SH","doc:\/\/MarvelService\/s8SendableP","doc:\/\/MarvelService\/s16SendableMetatypeP"],"kind":"relationships","type":"conformsTo"}],"topicSections":[{"identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacters\/Input\/Query-swift.struct\/init(name:nameStartsWith:modifiedSince:comics:series:events:stories:orderBy:limit:offset:)"],"title":"Initializers","generated":true,"anchor":"Initializers"},{"generated":true,"anchor":"Instance-Properties","title":"Instance Properties","identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacters\/Input\/Query-swift.struct\/comics","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacters\/Input\/Query-swift.struct\/events","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacters\/Input\/Query-swift.struct\/limit","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacters\/Input\/Query-swift.struct\/modifiedSince","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacters\/Input\/Query-swift.struct\/name","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacters\/Input\/Query-swift.struct\/nameStartsWith","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacters\/Input\/Query-swift.struct\/offset","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacters\/Input\/Query-swift.struct\/orderBy","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacters\/Input\/Query-swift.struct\/series","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacters\/Input\/Query-swift.struct\/stories"]},{"generated":true,"anchor":"Type-Aliases","title":"Type Aliases","identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacters\/Input\/Query-swift.struct\/orderByPayload"]},{"generated":true,"anchor":"Enumerations","title":"Enumerations","identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacters\/Input\/Query-swift.struct\/orderByPayloadPayload"]},{"generated":true,"anchor":"Default-Implementations","title":"Default Implementations","identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacters\/Input\/Query-swift.struct\/Equatable-Implementations"]}],"hierarchy":{"paths":[["doc:\/\/MarvelService\/documentation\/MarvelService","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacters","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacters\/Input"]]},"sections":[],"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Query"}],"platforms":["macOS"],"languages":["swift"]}]},{"content":[{"text":"Overview","anchor":"overview","type":"heading","level":2},{"style":"note","name":"Remark","type":"aside","content":[{"inlineContent":[{"type":"text","text":"Generated from "},{"type":"codeVoice","code":"#\/paths\/v1\/public\/characters\/GET\/query"},{"type":"text","text":"."}],"type":"paragraph"}]}],"kind":"content"}],"metadata":{"symbolKind":"struct","externalID":"s:13MarvelService10OperationsO13getCharactersO5InputV5QueryV","modules":[{"name":"MarvelService"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Query"}],"title":"Operations.getCharacters.Input.Query","role":"symbol","navigatorTitle":[{"text":"Query","kind":"identifier"}],"roleHeading":"Structure"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/marvelservice\/operations\/getcharacters\/input\/query-swift.struct"]}],"references":{"doc://MarvelService/s8SendableP":{"type":"unresolvable","identifier":"doc:\/\/MarvelService\/s8SendableP","title":"Swift.Sendable"},"doc://MarvelService/documentation/MarvelService/Operations/getCharacters/Input/Query-swift.struct/stories":{"type":"topic","url":"\/documentation\/marvelservice\/operations\/getcharacters\/input\/query-swift.struct\/stories","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacters\/Input\/Query-swift.struct\/stories","kind":"symbol","role":"symbol","title":"stories","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"stories"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:Si","kind":"typeIdentifier","text":"Int"},{"kind":"text","text":"]?"}],"abstract":[{"type":"text","text":"Return only characters which appear the specified stories (accepts a comma-separated list of ids)."}]},"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/getCharacters/Input":{"type":"topic","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacters\/Input","url":"\/documentation\/marvelservice\/operations\/getcharacters\/input","kind":"symbol","navigatorTitle":[{"text":"Input","kind":"identifier"}],"role":"symbol","title":"Operations.getCharacters.Input","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Input","kind":"identifier"}],"abstract":[]},"doc://MarvelService/documentation/MarvelService/Operations/getCharacters/Input/Query-swift.struct/events":{"type":"topic","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacters\/Input\/Query-swift.struct\/events","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"events"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:Si","kind":"typeIdentifier","text":"Int"},{"kind":"text","text":"]?"}],"url":"\/documentation\/marvelservice\/operations\/getcharacters\/input\/query-swift.struct\/events","title":"events","kind":"symbol","role":"symbol","abstract":[{"type":"text","text":"Return only characters which appear in the specified events (accepts a comma-separated list of ids)."}]},"doc://MarvelService/documentation/MarvelService/Operations/getCharacters/Input/Query-swift.struct/limit":{"type":"topic","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacters\/Input\/Query-swift.struct\/limit","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"limit"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Si","kind":"typeIdentifier","text":"Int"},{"kind":"text","text":"?"}],"url":"\/documentation\/marvelservice\/operations\/getcharacters\/input\/query-swift.struct\/limit","title":"limit","kind":"symbol","role":"symbol","abstract":[{"type":"text","text":"Limit the result set to the specified number of resources."}]},"doc://MarvelService/documentation/MarvelService/Operations/getCharacters/Input/Query-swift.struct/orderByPayloadPayload":{"type":"topic","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"orderByPayloadPayload"}],"abstract":[],"navigatorTitle":[{"kind":"identifier","text":"orderByPayloadPayload"}],"kind":"symbol","role":"symbol","title":"Operations.getCharacters.Input.Query.orderByPayloadPayload","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacters\/Input\/Query-swift.struct\/orderByPayloadPayload","url":"\/documentation\/marvelservice\/operations\/getcharacters\/input\/query-swift.struct\/orderbypayloadpayload"},"doc://MarvelService/documentation/MarvelService/Operations/getCharacters/Input/Query-swift.struct/name":{"type":"topic","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacters\/Input\/Query-swift.struct\/name","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"name"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?"}],"url":"\/documentation\/marvelservice\/operations\/getcharacters\/input\/query-swift.struct\/name","title":"name","kind":"symbol","role":"symbol","abstract":[{"type":"text","text":"Return only characters matching the specified full character name."}]},"doc://MarvelService/documentation/MarvelService/Operations/getCharacters/Input/Query-swift.struct/offset":{"type":"topic","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"offset"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Si","kind":"typeIdentifier","text":"Int"},{"kind":"text","text":"?"}],"abstract":[{"type":"text","text":"Skip the specified number of resources in the result set."}],"kind":"symbol","role":"symbol","title":"offset","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacters\/Input\/Query-swift.struct\/offset","url":"\/documentation\/marvelservice\/operations\/getcharacters\/input\/query-swift.struct\/offset"},"doc://MarvelService/SH":{"type":"unresolvable","identifier":"doc:\/\/MarvelService\/SH","title":"Swift.Hashable"},"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/Operations/getCharacters/Input/Query-swift.struct/Equatable-Implementations":{"type":"topic","abstract":[],"kind":"article","role":"collectionGroup","title":"Equatable Implementations","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacters\/Input\/Query-swift.struct\/Equatable-Implementations","url":"\/documentation\/marvelservice\/operations\/getcharacters\/input\/query-swift.struct\/equatable-implementations"},"doc://MarvelService/documentation/MarvelService/Operations/getCharacters":{"type":"topic","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"getCharacters"}],"abstract":[{"type":"text","text":"Fetches lists of characters."}],"navigatorTitle":[{"kind":"identifier","text":"getCharacters"}],"kind":"symbol","role":"symbol","title":"Operations.getCharacters","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacters","url":"\/documentation\/marvelservice\/operations\/getcharacters"},"doc://MarvelService/documentation/MarvelService/Operations/getCharacters/Input/Query-swift.struct/nameStartsWith":{"type":"topic","url":"\/documentation\/marvelservice\/operations\/getcharacters\/input\/query-swift.struct\/namestartswith","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacters\/Input\/Query-swift.struct\/nameStartsWith","kind":"symbol","role":"symbol","title":"nameStartsWith","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"nameStartsWith"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"abstract":[{"type":"text","text":"Return characters with names that begin with the specified string."}]},"doc://MarvelService/documentation/MarvelService/Operations/getCharacters/Input/Query-swift.struct":{"type":"topic","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacters\/Input\/Query-swift.struct","url":"\/documentation\/marvelservice\/operations\/getcharacters\/input\/query-swift.struct","kind":"symbol","navigatorTitle":[{"text":"Query","kind":"identifier"}],"role":"symbol","title":"Operations.getCharacters.Input.Query","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Query","kind":"identifier"}],"abstract":[]},"doc://MarvelService/documentation/MarvelService/Operations/getCharacters/Input/Query-swift.struct/series":{"url":"\/documentation\/marvelservice\/operations\/getcharacters\/input\/query-swift.struct\/series","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacters\/Input\/Query-swift.struct\/series","type":"topic","kind":"symbol","role":"symbol","title":"series","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"series","kind":"identifier"},{"text":": [","kind":"text"},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"},{"text":"]?","kind":"text"}],"abstract":[{"type":"text","text":"Return only characters which appear the specified series (accepts a comma-separated list of ids)."}]},"doc://MarvelService/SQ":{"type":"unresolvable","title":"Swift.Equatable","identifier":"doc:\/\/MarvelService\/SQ"},"doc://MarvelService/documentation/MarvelService/Operations/getCharacters/Input/Query-swift.struct/modifiedSince":{"type":"topic","url":"\/documentation\/marvelservice\/operations\/getcharacters\/input\/query-swift.struct\/modifiedsince","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacters\/Input\/Query-swift.struct\/modifiedSince","kind":"symbol","role":"symbol","title":"modifiedSince","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"modifiedSince"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"abstract":[{"text":"Return only characters which have been modified since the specified date.","type":"text"}]},"doc://MarvelService/documentation/MarvelService/Operations/getCharacters/Input/Query-swift.struct/init(name:nameStartsWith:modifiedSince:comics:series:events:stories:orderBy:limit:offset:)":{"type":"topic","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"name"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"nameStartsWith"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"modifiedSince"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"comics"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:Si","text":"Int"},{"kind":"text","text":"]?, "},{"kind":"externalParam","text":"series"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:Si","text":"Int"},{"kind":"text","text":"]?, "},{"kind":"externalParam","text":"events"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:Si","text":"Int"},{"kind":"text","text":"]?, "},{"kind":"externalParam","text":"stories"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:Si","text":"Int"},{"kind":"text","text":"]?, "},{"kind":"externalParam","text":"orderBy"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO13getCharactersO","text":"getCharacters"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO13getCharactersO5InputV","text":"Input"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO13getCharactersO5InputV5QueryV","text":"Query"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO13getCharactersO5InputV5QueryV14orderByPayloada","text":"orderByPayload"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"limit"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Si","text":"Int"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"offset"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Si","text":"Int"},{"kind":"text","text":"?)"}],"abstract":[{"type":"text","text":"Creates a new "},{"code":"Query","type":"codeVoice"},{"type":"text","text":"."}],"kind":"symbol","role":"symbol","title":"init(name:nameStartsWith:modifiedSince:comics:series:events:stories:orderBy:limit:offset:)","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacters\/Input\/Query-swift.struct\/init(name:nameStartsWith:modifiedSince:comics:series:events:stories:orderBy:limit:offset:)","url":"\/documentation\/marvelservice\/operations\/getcharacters\/input\/query-swift.struct\/init(name:namestartswith:modifiedsince:comics:series:events:stories:orderby:limit:offset:)"},"doc://MarvelService/documentation/MarvelService/Operations/getCharacters/Input/Query-swift.struct/comics":{"type":"topic","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"comics"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:Si","kind":"typeIdentifier","text":"Int"},{"kind":"text","text":"]?"}],"abstract":[{"text":"Return only characters which appear in the specified comics (accepts a comma-separated list of ids).","type":"text"}],"kind":"symbol","role":"symbol","title":"comics","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacters\/Input\/Query-swift.struct\/comics","url":"\/documentation\/marvelservice\/operations\/getcharacters\/input\/query-swift.struct\/comics"},"doc://MarvelService/s16SendableMetatypeP":{"identifier":"doc:\/\/MarvelService\/s16SendableMetatypeP","type":"unresolvable","title":"Swift.SendableMetatype"},"doc://MarvelService/documentation/MarvelService/Operations/getCharacters/Input/Query-swift.struct/orderByPayload":{"type":"topic","fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"orderByPayload"}],"abstract":[],"navigatorTitle":[{"kind":"identifier","text":"orderByPayload"}],"kind":"symbol","role":"symbol","title":"Operations.getCharacters.Input.Query.orderByPayload","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacters\/Input\/Query-swift.struct\/orderByPayload","url":"\/documentation\/marvelservice\/operations\/getcharacters\/input\/query-swift.struct\/orderbypayload"},"doc://MarvelService/documentation/MarvelService/Operations/getCharacters/Input/Query-swift.struct/orderBy":{"type":"topic","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacters\/Input\/Query-swift.struct\/orderBy","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"orderBy"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO13getCharactersO","text":"getCharacters"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO13getCharactersO5InputV","kind":"typeIdentifier","text":"Input"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO13getCharactersO5InputV5QueryV","kind":"typeIdentifier","text":"Query"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO13getCharactersO5InputV5QueryV14orderByPayloada","kind":"typeIdentifier","text":"orderByPayload"},{"text":"?","kind":"text"}],"url":"\/documentation\/marvelservice\/operations\/getcharacters\/input\/query-swift.struct\/orderby","title":"orderBy","kind":"symbol","role":"symbol","abstract":[{"type":"text","text":"Order the result set by a field or fields. Add a “-” to the value sort in descending order. Multiple values are given priority in the order in which they are passed."}]}}}