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
14 KiB
JSON
1 line
14 KiB
JSON
{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByCreatorId\/Input"},"hierarchy":{"paths":[["doc:\/\/MarvelService\/documentation\/MarvelService","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByCreatorId"]]},"topicSections":[{"identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByCreatorId\/Input\/Headers-swift.struct","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByCreatorId\/Input\/Path-swift.struct","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByCreatorId\/Input\/Query-swift.struct"],"generated":true,"anchor":"Structures","title":"Structures"},{"identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByCreatorId\/Input\/init(path:query:headers:)"],"generated":true,"anchor":"Initializers","title":"Initializers"},{"identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByCreatorId\/Input\/headers-swift.property","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByCreatorId\/Input\/path-swift.property","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByCreatorId\/Input\/query-swift.property"],"generated":true,"anchor":"Instance-Properties","title":"Instance Properties"},{"identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByCreatorId\/Input\/Equatable-Implementations"],"generated":true,"anchor":"Default-Implementations","title":"Default Implementations"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"metadata":{"title":"Operations.getEventsByCreatorId.Input","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Input"}],"role":"symbol","externalID":"s:13MarvelService10OperationsO20getEventsByCreatorIdO5InputV","roleHeading":"Structure","symbolKind":"struct","modules":[{"name":"MarvelService"}],"navigatorTitle":[{"text":"Input","kind":"identifier"}]},"kind":"symbol","sections":[],"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Input"}],"platforms":["macOS"],"languages":["swift"]}],"kind":"declarations"}],"variants":[{"paths":["\/documentation\/marvelservice\/operations\/geteventsbycreatorid\/input"],"traits":[{"interfaceLanguage":"swift"}]}],"relationshipsSections":[{"type":"conformsTo","identifiers":["doc:\/\/MarvelService\/SQ","doc:\/\/MarvelService\/SH","doc:\/\/MarvelService\/s8SendableP","doc:\/\/MarvelService\/s16SendableMetatypeP"],"title":"Conforms To","kind":"relationships"}],"references":{"doc://MarvelService/documentation/MarvelService/Operations/getEventsByCreatorId/Input/Query-swift.struct":{"abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByCreatorId\/Input\/Query-swift.struct","navigatorTitle":[{"text":"Query","kind":"identifier"}],"title":"Operations.getEventsByCreatorId.Input.Query","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Query","kind":"identifier"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/operations\/geteventsbycreatorid\/input\/query-swift.struct"},"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/getEventsByCreatorId/Input/path-swift.property":{"url":"\/documentation\/marvelservice\/operations\/geteventsbycreatorid\/input\/path-swift.property","title":"path","type":"topic","abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByCreatorId\/Input\/path-swift.property","kind":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"path"},{"text":": ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO20getEventsByCreatorIdO","kind":"typeIdentifier","text":"getEventsByCreatorId"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO20getEventsByCreatorIdO5InputV","kind":"typeIdentifier","text":"Input"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO20getEventsByCreatorIdO5InputV4PathV","text":"Path","kind":"typeIdentifier"}]},"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/getEventsByCreatorId/Input/init(path:query:headers:)":{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByCreatorId\/Input\/init(path:query:headers:)","title":"init(path:query:headers:)","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"path","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO"},{"text":".","kind":"text"},{"text":"getEventsByCreatorId","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO20getEventsByCreatorIdO"},{"text":".","kind":"text"},{"text":"Input","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO20getEventsByCreatorIdO5InputV"},{"text":".","kind":"text"},{"text":"Path","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO20getEventsByCreatorIdO5InputV4PathV"},{"text":", ","kind":"text"},{"text":"query","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO"},{"text":".","kind":"text"},{"text":"getEventsByCreatorId","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO20getEventsByCreatorIdO"},{"text":".","kind":"text"},{"text":"Input","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO20getEventsByCreatorIdO5InputV"},{"text":".","kind":"text"},{"text":"Query","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO20getEventsByCreatorIdO5InputV5QueryV"},{"text":", ","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO"},{"text":".","kind":"text"},{"text":"getEventsByCreatorId","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO20getEventsByCreatorIdO"},{"text":".","kind":"text"},{"text":"Input","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO20getEventsByCreatorIdO5InputV"},{"text":".","kind":"text"},{"text":"Headers","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO20getEventsByCreatorIdO5InputV7HeadersV"},{"text":")","kind":"text"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/operations\/geteventsbycreatorid\/input\/init(path:query:headers:)","role":"symbol","abstract":[{"text":"Creates a new ","type":"text"},{"code":"Input","type":"codeVoice"},{"text":".","type":"text"}]},"doc://MarvelService/s8SendableP":{"type":"unresolvable","identifier":"doc:\/\/MarvelService\/s8SendableP","title":"Swift.Sendable"},"doc://MarvelService/SQ":{"type":"unresolvable","identifier":"doc:\/\/MarvelService\/SQ","title":"Swift.Equatable"},"doc://MarvelService/documentation/MarvelService/Operations/getEventsByCreatorId/Input/query-swift.property":{"title":"query","abstract":[],"url":"\/documentation\/marvelservice\/operations\/geteventsbycreatorid\/input\/query-swift.property","kind":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByCreatorId\/Input\/query-swift.property","type":"topic","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"query"},{"kind":"text","text":": "},{"preciseIdentifier":"s:13MarvelService10OperationsO","kind":"typeIdentifier","text":"Operations"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO20getEventsByCreatorIdO","kind":"typeIdentifier","text":"getEventsByCreatorId"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO20getEventsByCreatorIdO5InputV","kind":"typeIdentifier","text":"Input"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO20getEventsByCreatorIdO5InputV5QueryV","kind":"typeIdentifier","text":"Query"}]},"doc://MarvelService/documentation/MarvelService/Operations/getEventsByCreatorId/Input/Headers-swift.struct":{"url":"\/documentation\/marvelservice\/operations\/geteventsbycreatorid\/input\/headers-swift.struct","title":"Operations.getEventsByCreatorId.Input.Headers","navigatorTitle":[{"kind":"identifier","text":"Headers"}],"type":"topic","abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByCreatorId\/Input\/Headers-swift.struct","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Headers"}]},"doc://MarvelService/documentation/MarvelService/Operations/getEventsByCreatorId/Input":{"abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByCreatorId\/Input","navigatorTitle":[{"text":"Input","kind":"identifier"}],"title":"Operations.getEventsByCreatorId.Input","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Input","kind":"identifier"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/operations\/geteventsbycreatorid\/input"},"doc://MarvelService/s16SendableMetatypeP":{"type":"unresolvable","identifier":"doc:\/\/MarvelService\/s16SendableMetatypeP","title":"Swift.SendableMetatype"},"doc://MarvelService/documentation/MarvelService/Operations/getEventsByCreatorId":{"url":"\/documentation\/marvelservice\/operations\/geteventsbycreatorid","title":"Operations.getEventsByCreatorId","navigatorTitle":[{"kind":"identifier","text":"getEventsByCreatorId"}],"type":"topic","abstract":[{"type":"text","text":"Fetches lists of events filtered by a creator id."}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByCreatorId","kind":"symbol","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"getEventsByCreatorId"}]},"doc://MarvelService/documentation/MarvelService/Operations/getEventsByCreatorId/Input/Equatable-Implementations":{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByCreatorId\/Input\/Equatable-Implementations","title":"Equatable Implementations","kind":"article","type":"topic","url":"\/documentation\/marvelservice\/operations\/geteventsbycreatorid\/input\/equatable-implementations","role":"collectionGroup","abstract":[]},"doc://MarvelService/documentation/MarvelService/Operations/getEventsByCreatorId/Input/headers-swift.property":{"abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByCreatorId\/Input\/headers-swift.property","title":"headers","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"headers"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Operations","preciseIdentifier":"s:13MarvelService10OperationsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"getEventsByCreatorId","preciseIdentifier":"s:13MarvelService10OperationsO20getEventsByCreatorIdO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Input","preciseIdentifier":"s:13MarvelService10OperationsO20getEventsByCreatorIdO5InputV"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Headers","preciseIdentifier":"s:13MarvelService10OperationsO20getEventsByCreatorIdO5InputV7HeadersV"}],"kind":"symbol","url":"\/documentation\/marvelservice\/operations\/geteventsbycreatorid\/input\/headers-swift.property","type":"topic"},"doc://MarvelService/documentation/MarvelService/Operations/getEventsByCreatorId/Input/Path-swift.struct":{"title":"Operations.getEventsByCreatorId.Input.Path","abstract":[],"url":"\/documentation\/marvelservice\/operations\/geteventsbycreatorid\/input\/path-swift.struct","navigatorTitle":[{"kind":"identifier","text":"Path"}],"kind":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByCreatorId\/Input\/Path-swift.struct","type":"topic","role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Path"}]},"doc://MarvelService/SH":{"type":"unresolvable","identifier":"doc:\/\/MarvelService\/SH","title":"Swift.Hashable"}}} |