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

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