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
13 KiB
JSON
1 line
13 KiB
JSON
{"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/marvelservice\/apiprotocol\/getevents(query:headers:)"]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["macOS"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getEvents"},{"text":"(","kind":"text"},{"text":"query","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:13MarvelService10OperationsO","kind":"typeIdentifier","text":"Operations","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"getEvents","preciseIdentifier":"s:13MarvelService10OperationsO9getEventsO","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEvents"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Input","preciseIdentifier":"s:13MarvelService10OperationsO9getEventsO5InputV","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEvents\/Input"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO9getEventsO5InputV5QueryV","kind":"typeIdentifier","text":"Query","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEvents\/Input\/Query-swift.struct"},{"kind":"text","text":" = .init(), "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": "},{"preciseIdentifier":"s:13MarvelService10OperationsO","kind":"typeIdentifier","text":"Operations","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO9getEventsO","kind":"typeIdentifier","text":"getEvents","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEvents"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO9getEventsO5InputV","kind":"typeIdentifier","text":"Input","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEvents\/Input"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO9getEventsO5InputV7HeadersV","kind":"typeIdentifier","text":"Headers","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEvents\/Input\/Headers-swift.struct"},{"text":" = .init()) ","kind":"text"},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"text":" -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations"},{"text":".","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO9getEventsO","text":"getEvents","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEvents"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO9getEventsO6OutputO","kind":"typeIdentifier","text":"Output","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEvents\/Output"}],"languages":["swift"]}]},{"content":[{"level":2,"anchor":"discussion","type":"heading","text":"Discussion"},{"type":"paragraph","inlineContent":[{"type":"text","text":"Fetches lists of events with optional filters."}]},{"style":"note","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"HTTP "},{"type":"codeVoice","code":"GET \/v1\/public\/events"},{"type":"text","text":"."}]}],"name":"Remark","type":"aside"},{"type":"aside","content":[{"type":"paragraph","inlineContent":[{"text":"Generated from ","type":"text"},{"code":"#\/paths\/\/v1\/public\/events\/get(getEvents)","type":"codeVoice"},{"text":".","type":"text"}]}],"style":"note","name":"Remark"}],"kind":"content"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"abstract":[{"type":"text","text":"Fetches lists of events."}],"hierarchy":{"paths":[["doc:\/\/MarvelService\/documentation\/MarvelService","doc:\/\/MarvelService\/documentation\/MarvelService\/APIProtocol"]]},"identifier":{"url":"doc:\/\/MarvelService\/documentation\/MarvelService\/APIProtocol\/getEvents(query:headers:)","interfaceLanguage":"swift"},"kind":"symbol","metadata":{"title":"getEvents(query:headers:)","externalID":"s:13MarvelService11APIProtocolPAAE9getEvents5query7headersAA10OperationsOADO6OutputOAI5InputV5QueryV_AM7HeadersVtYaKF","role":"symbol","roleHeading":"Instance Method","modules":[{"name":"MarvelService"}],"symbolKind":"method","extendedModule":"MarvelService","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getEvents"},{"kind":"text","text":"("},{"kind":"externalParam","text":"query"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Operations","preciseIdentifier":"s:13MarvelService10OperationsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"getEvents","preciseIdentifier":"s:13MarvelService10OperationsO9getEventsO"},{"text":".","kind":"text"},{"text":"Input","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO9getEventsO5InputV"},{"text":".","kind":"text"},{"text":"Query","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO9getEventsO5InputV5QueryV"},{"kind":"text","text":", "},{"text":"headers","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO"},{"text":".","kind":"text"},{"kind":"typeIdentifier","text":"getEvents","preciseIdentifier":"s:13MarvelService10OperationsO9getEventsO"},{"text":".","kind":"text"},{"kind":"typeIdentifier","text":"Input","preciseIdentifier":"s:13MarvelService10OperationsO9getEventsO5InputV"},{"text":".","kind":"text"},{"kind":"typeIdentifier","text":"Headers","preciseIdentifier":"s:13MarvelService10OperationsO9getEventsO5InputV7HeadersV"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO"},{"text":".","kind":"text"},{"text":"getEvents","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO9getEventsO"},{"text":".","kind":"text"},{"kind":"typeIdentifier","text":"Output","preciseIdentifier":"s:13MarvelService10OperationsO9getEventsO6OutputO"}]},"references":{"doc://MarvelService/documentation/MarvelService/Operations/getEvents":{"url":"\/documentation\/marvelservice\/operations\/getevents","title":"Operations.getEvents","navigatorTitle":[{"kind":"identifier","text":"getEvents"}],"type":"topic","abstract":[{"type":"text","text":"Fetches lists of events."}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEvents","kind":"symbol","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"getEvents"}]},"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":{"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/getEvents/Input/Headers-swift.struct":{"url":"\/documentation\/marvelservice\/operations\/getevents\/input\/headers-swift.struct","title":"Operations.getEvents.Input.Headers","navigatorTitle":[{"kind":"identifier","text":"Headers"}],"type":"topic","abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEvents\/Input\/Headers-swift.struct","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Headers","kind":"identifier"}]},"doc://MarvelService/documentation/MarvelService/APIProtocol":{"url":"\/documentation\/marvelservice\/apiprotocol","title":"APIProtocol","navigatorTitle":[{"text":"APIProtocol","kind":"identifier"}],"type":"topic","abstract":[{"type":"text","text":"A type that performs HTTP operations defined by the OpenAPI document."}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/APIProtocol","kind":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"APIProtocol","kind":"identifier"}]},"doc://MarvelService/documentation/MarvelService/Operations/getEvents/Output":{"url":"\/documentation\/marvelservice\/operations\/getevents\/output","title":"Operations.getEvents.Output","navigatorTitle":[{"kind":"identifier","text":"Output"}],"type":"topic","abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEvents\/Output","kind":"symbol","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Output"}]},"doc://MarvelService/documentation/MarvelService/Operations/getEvents/Input":{"url":"\/documentation\/marvelservice\/operations\/getevents\/input","title":"Operations.getEvents.Input","navigatorTitle":[{"kind":"identifier","text":"Input"}],"type":"topic","abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEvents\/Input","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Input"}]},"doc://MarvelService/documentation/MarvelService/Operations/getEvents/Input/Query-swift.struct":{"url":"\/documentation\/marvelservice\/operations\/getevents\/input\/query-swift.struct","title":"Operations.getEvents.Input.Query","navigatorTitle":[{"kind":"identifier","text":"Query"}],"type":"topic","abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEvents\/Input\/Query-swift.struct","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Query"}]},"doc://MarvelService/documentation/MarvelService/APIProtocol/getEvents(query:headers:)":{"abstract":[{"type":"text","text":"Fetches lists of events."}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/APIProtocol\/getEvents(query:headers:)","title":"getEvents(query:headers:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getEvents","kind":"identifier"},{"text":"(","kind":"text"},{"text":"query","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO9getEventsO","text":"getEvents","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO9getEventsO5InputV","text":"Input","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO9getEventsO5InputV5QueryV","text":"Query","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO9getEventsO","text":"getEvents","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO9getEventsO5InputV","text":"Input","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO9getEventsO5InputV7HeadersV","text":"Headers","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO9getEventsO","text":"getEvents","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO9getEventsO6OutputO","text":"Output","kind":"typeIdentifier"}],"kind":"symbol","url":"\/documentation\/marvelservice\/apiprotocol\/getevents(query:headers:)","type":"topic"}}} |