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

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