Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 3 additions & 8 deletions .github/workflows/contract-tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,18 +24,13 @@ jobs:
- name: Install dependencies
run: npm ci

# Builds the project, extracts every exported type/interface/class/method
# signature from the compiled .d.ts files, and compares against the
# committed snapshot in temp/skyflow-node.api.md.
# Fails if anything in the public API surface has changed — renamed class,
# renamed method, changed parameter type, removed export, etc.
- name: Verify API surface snapshot
run: npm run contract-snapshot-verify

- name: Upload API surface report on failure
- name: Upload API surface diff on failure
if: failure()
uses: actions/upload-artifact@v4
with:
name: api-surface-report
path: api-report/skyflow-node.api.md
name: api-surface-diff
path: temp/skyflow-node.api.md
retention-days: 7
2 changes: 1 addition & 1 deletion api-extractor.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
"apiReport": {
"enabled": true,
"reportFolder": "<projectFolder>/api-report/",
"reportTempFolder": "<projectFolder>/api-report/",
"reportTempFolder": "<projectFolder>/temp/",
"reportFileName": "<unscopedPackageName>.api.md"
},
"docModel": {
Expand Down
8 changes: 1 addition & 7 deletions api-report/skyflow-node.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ export type BearerTokenOptions = {
ctx?: string | Record<string, any>;
roleIDs?: string[];
logLevel?: LogLevel;
tokenUri?: string;
};

// @public (undocumented)
Expand Down Expand Up @@ -708,7 +707,7 @@ export interface InsertResponseType {
// (undocumented)
[key: string]: unknown;
// (undocumented)
skyflow_id: string;
skyflowId: string;
}

// @public (undocumented)
Expand Down Expand Up @@ -784,8 +783,6 @@ export interface PathCredentials {
path: string;
// (undocumented)
roles?: Array<string>;
// (undocumented)
tokenUri?: string;
}

// @public (undocumented)
Expand Down Expand Up @@ -877,7 +874,6 @@ export type SignedDataTokensOptions = {
timeToLive?: number;
ctx?: string | Record<string, any>;
logLevel?: LogLevel;
tokenUri?: string;
};

// @public (undocumented)
Expand Down Expand Up @@ -964,8 +960,6 @@ export interface StringCredentials {
credentialsString: string;
// (undocumented)
roles?: Array<string>;
// (undocumented)
tokenUri?: string;
}

// @public (undocumented)
Expand Down
Loading