@oppulence/compass-api-go-backend-typescript-sdk
v1.0.0-beta.45d360e
Published
Generated TypeScript SDK for the Compass api-compass-go-backend Ent REST surface.
Maintainers
Readme
@oppulence/compass-api-go-backend-typescript-sdk
Generated TypeScript SDK for the Compass api-compass-go-backend Ent REST surface — version 1.0.0.
Installation
npm install @oppulence/compass-api-go-backend-typescript-sdkUsage
import { Configuration } from "@oppulence/compass-api-go-backend-typescript-sdk";
const configuration = new Configuration({
basePath: "https://backend-go-api-staging.operatorcamp.com",
accessToken: process.env.COMPASS_API_TOKEN,
});Generation
This package is generated; do not edit files in this directory by hand. The pipeline is:
make -C packages/api-compass-go-backend generate-ent-openapirunsgo generate ./entwhich writesent/openapi.json.bun run --filter @canvas/compass-api-go-backend-typescript-sdk-gen sdk:generateruns@openapitools/openapi-generator-cliagainst that spec and writes the SDK here.
To check that the committed SDK is in sync with the spec:
make -C packages/api-compass-go-backend check-ts-sdkScope
Covers the Ent CRUD surface (entoas-generated). Custom action endpoints (e.g. /posts/{id}/publish) require additional swag annotations + a merge step and are not yet included.
