Files
marvel-service/docs/data/documentation/marvelservice/apiprotocol/geteventbyid(path:headers:).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
13 KiB
JSON

{"sections":[],"variants":[{"paths":["\/documentation\/marvelservice\/apiprotocol\/geteventbyid(path:headers:)"],"traits":[{"interfaceLanguage":"swift"}]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["macOS"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getEventById","kind":"identifier"},{"text":"(","kind":"text"},{"text":"path","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","text":"Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO12getEventByIdO","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventById","text":"getEventById","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO12getEventByIdO5InputV","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventById\/Input","text":"Input","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO12getEventByIdO5InputV4PathV","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventById\/Input\/Path-swift.struct","text":"Path","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","text":"Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO12getEventByIdO","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventById","text":"getEventById","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO12getEventByIdO5InputV","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventById\/Input","text":"Input","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO12getEventByIdO5InputV7HeadersV","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventById\/Input\/Headers-swift.struct","text":"Headers","kind":"typeIdentifier"},{"text":" = .init()) ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"text":"Operations","preciseIdentifier":"s:13MarvelService10OperationsO","kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations"},{"text":".","kind":"text"},{"text":"getEventById","preciseIdentifier":"s:13MarvelService10OperationsO12getEventByIdO","kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventById"},{"text":".","kind":"text"},{"text":"Output","preciseIdentifier":"s:13MarvelService10OperationsO12getEventByIdO6OutputO","kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventById\/Output"}]}]},{"kind":"content","content":[{"text":"Discussion","anchor":"discussion","level":2,"type":"heading"},{"inlineContent":[{"type":"text","text":"This method fetches a single event resource. It is the canonical URI for any event resource provided by the API."}],"type":"paragraph"},{"name":"Remark","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"HTTP "},{"code":"GET \/v1\/public\/events\/{eventId}","type":"codeVoice"},{"type":"text","text":"."}]}],"style":"note","type":"aside"},{"name":"Remark","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Generated from "},{"code":"#\/paths\/\/v1\/public\/events\/{eventId}\/get(getEventById)","type":"codeVoice"},{"type":"text","text":"."}]}],"style":"note","type":"aside"}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"abstract":[{"type":"text","text":"Fetches a single event by id."}],"hierarchy":{"paths":[["doc:\/\/MarvelService\/documentation\/MarvelService","doc:\/\/MarvelService\/documentation\/MarvelService\/APIProtocol"]]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/MarvelService\/documentation\/MarvelService\/APIProtocol\/getEventById(path:headers:)"},"kind":"symbol","metadata":{"title":"getEventById(path:headers:)","externalID":"s:13MarvelService11APIProtocolPAAE12getEventById4path7headersAA10OperationsOADO6OutputOAI5InputV4PathV_AM7HeadersVtYaKF","role":"symbol","modules":[{"name":"MarvelService"}],"roleHeading":"Instance Method","symbolKind":"method","extendedModule":"MarvelService","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getEventById"},{"kind":"text","text":"("},{"kind":"externalParam","text":"path"},{"kind":"text","text":": "},{"preciseIdentifier":"s:13MarvelService10OperationsO","kind":"typeIdentifier","text":"Operations"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO12getEventByIdO","kind":"typeIdentifier","text":"getEventById"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO12getEventByIdO5InputV","kind":"typeIdentifier","text":"Input"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO12getEventByIdO5InputV4PathV","kind":"typeIdentifier","text":"Path"},{"kind":"text","text":", "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": "},{"preciseIdentifier":"s:13MarvelService10OperationsO","kind":"typeIdentifier","text":"Operations"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO12getEventByIdO","kind":"typeIdentifier","text":"getEventById"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO12getEventByIdO5InputV","kind":"typeIdentifier","text":"Input"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO12getEventByIdO5InputV7HeadersV","kind":"typeIdentifier","text":"Headers"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"preciseIdentifier":"s:13MarvelService10OperationsO","kind":"typeIdentifier","text":"Operations"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO12getEventByIdO","kind":"typeIdentifier","text":"getEventById"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO12getEventByIdO6OutputO","kind":"typeIdentifier","text":"Output"}]},"references":{"doc://MarvelService/documentation/MarvelService/Operations/getEventById/Input":{"abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventById\/Input","navigatorTitle":[{"kind":"identifier","text":"Input"}],"title":"Operations.getEventById.Input","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Input"}],"kind":"symbol","url":"\/documentation\/marvelservice\/operations\/geteventbyid\/input","type":"topic"},"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/getEventById/Input/Headers-swift.struct":{"url":"\/documentation\/marvelservice\/operations\/geteventbyid\/input\/headers-swift.struct","title":"Operations.getEventById.Input.Headers","navigatorTitle":[{"text":"Headers","kind":"identifier"}],"type":"topic","abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventById\/Input\/Headers-swift.struct","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Headers","kind":"identifier"}]},"doc://MarvelService/documentation/MarvelService/Operations/getEventById/Input/Path-swift.struct":{"abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventById\/Input\/Path-swift.struct","navigatorTitle":[{"kind":"identifier","text":"Path"}],"title":"Operations.getEventById.Input.Path","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Path"}],"kind":"symbol","url":"\/documentation\/marvelservice\/operations\/geteventbyid\/input\/path-swift.struct","type":"topic"},"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":{"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/getEventById":{"abstract":[{"type":"text","text":"Fetches a single event by id."}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventById","navigatorTitle":[{"kind":"identifier","text":"getEventById"}],"title":"Operations.getEventById","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"getEventById"}],"kind":"symbol","url":"\/documentation\/marvelservice\/operations\/geteventbyid","type":"topic"},"doc://MarvelService/documentation/MarvelService/APIProtocol/getEventById(path:headers:)":{"title":"getEventById(path:headers:)","abstract":[{"type":"text","text":"Fetches a single event by id."}],"url":"\/documentation\/marvelservice\/apiprotocol\/geteventbyid(path:headers:)","kind":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/APIProtocol\/getEventById(path:headers:)","type":"topic","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"getEventById"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"path"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations","kind":"typeIdentifier"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO12getEventByIdO","text":"getEventById","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO12getEventByIdO5InputV","text":"Input","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Path","preciseIdentifier":"s:13MarvelService10OperationsO12getEventByIdO5InputV4PathV","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"headers","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO12getEventByIdO","text":"getEventById","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Input","preciseIdentifier":"s:13MarvelService10OperationsO12getEventByIdO5InputV","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Headers","preciseIdentifier":"s:13MarvelService10OperationsO12getEventByIdO5InputV7HeadersV","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"text":"Operations","preciseIdentifier":"s:13MarvelService10OperationsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"getEventById","preciseIdentifier":"s:13MarvelService10OperationsO12getEventByIdO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO12getEventByIdO6OutputO","text":"Output","kind":"typeIdentifier"}]},"doc://MarvelService/documentation/MarvelService/Operations/getEventById/Output":{"abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventById\/Output","navigatorTitle":[{"kind":"identifier","text":"Output"}],"title":"Operations.getEventById.Output","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Output"}],"kind":"symbol","url":"\/documentation\/marvelservice\/operations\/geteventbyid\/output","type":"topic"}}}