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