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

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