@harnessio/react-cd-ng-swagger-service-client
v1.3.0
Published
Harness React CD NG service client - CD NG APIs integrated with react hooks
Keywords
Readme
React CD NG Service Client
OpenAPI -> OA
TypeScript -> TS
OpenAPI + TypeScript -> OATS
This React API client will store a collection of Harness CD NG Service APIs and Interfaces contracts generated from 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 buildFor NextGen UI adoption : HarnessReactAPIClient should be initialized
Before using API Client, it must be initilaized with required ClientCallbacks.
Example:
new CdNgSwaggerServiceAPIClient({
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:
- Add api id in ALLOWED_OPERATION_IDS in packages/cd-ng-swagger-service/oats.config.ts
- Run yarn generate in cd-ng-manger-service folder
- Test locally using
yarn build and yalc publish - Raise PR and publish cd-ng-manager-service package
