React Notification Swagger Service Client

OpenAPI -> OA

TypeScript -> TS

OpenAPI + TypeScript -> OATS

This React API client stores a collection of Harness Notification Swagger Service APIs and Interfaces contracts generated from the Open API Spec using OATS CLI internally. APIs are using hooks from @tanstack/react-query

Steps To Generate API Client build as dist folder

yarn build

For NextGen UI adoption : HarnessReactAPIClient should be initialized

Before using API Client, it must be initialized with required ClientCallbacks.

Example:

 new NotificationSwaggerServiceAPIClient({
    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

Steps to add APIs in this folder

1. Add the operation ID in ALLOWED_OPERATION_IDS in packages/notification-swagger-service/oats.config.ts
2. Run yarn generate in the notification-swagger-service folder
3. Test locally using yarn build && yalc publish
4. Raise a PR and publish the notification-swagger-service package