Files
marvel-service/docs/data/documentation/marvelservice/operations/getcharactersbyeventid/input/query-swift.struct.json
T
javier d5bd9feb0a First version of the library documentation (#7)
This PR contains the work done to write the main article of the `DocC` documentation for the library, which introduces the library as well as explains how to install it and use it.

Reviewed-on: #7
Co-authored-by: Javier Cicchelli <javier@rock-n-code.com>
Co-committed-by: Javier Cicchelli <javier@rock-n-code.com>
2025-10-05 18:41:22 +00:00

1 line
20 KiB
JSON

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