Files
marvel-service/docs/data/documentation/marvelservice/operations/getcharactersbyseriesid/input/query-swift.struct.json
T

1 line
20 KiB
JSON

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