React Vibe Service Client (WIP)
OpenAPI -> OA
TypeScript -> TS
OpenAPI + TypeScript -> OATS
This React API client will store a collection of Harness Vibe Service APIs and Interfaces contracts generated from Open API Spec using OATS CLI internally.
APIs are using hooks from @tanstack/react-query
Note: The
streamVibeOnboardingEventsendpoint (GET .../onboardings/{onboardingId}/events,text/event-stream) is intentionally excluded fromopenapi.yaml.oats-clidoes not currently generate hooks for SSE responses, and the sharedfetcherbuffers the whole response body rather than reading a stream. Use thegetVibeOnboardingpolling endpoint instead until SSE support is added.
Steps To Generate API Client build as dist folder
yarn build
For NextGen UI adoption : VibeServiceAPIClient should be initialized
Before using API Client, it must be initilaized with required ClientCallbacks.
Example:
new VibeServiceAPIClient({
getHeaders: () => {
return { token: SessionToken.getToken(), 'Harness-Account': accountId }
}}
Versioning
Once development phase is completed, this repo will have changes and versioning driven by API spec only.
License
MIT. Copyright(c) Harness Inc