rock-n-code/marvel-service
1
0
Fork 0
Code Pull Requests Releases 2 Activity
Files
d5bd9feb0a8ea3020ee39efa3ba706e029951033
marvel-service/docs/data/documentation/marvelservice/apiprotocol/geteventbyid(_:).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
9.0 KiB
JSON
Raw Blame History

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