@workos/openapi-spec 0.5.0 → 0.7.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +29 -0
- package/dist/open-api-spec.yaml +442 -162
- package/dist/policy.mjs +21 -0
- package/dist/types.d.ts +401 -127
- package/package.json +6 -6
package/README.md
CHANGED
|
@@ -74,6 +74,35 @@ npm run sdk:compat-summary -- --report .oagen/python/compat-report.json --report
|
|
|
74
74
|
npm run sdk:compat-summary -- --report .oagen/python/compat-report.json --output summary.md
|
|
75
75
|
```
|
|
76
76
|
|
|
77
|
+
### SDK changelog metadata
|
|
78
|
+
|
|
79
|
+
The SDK PR workflow writes `.changelog-pending/*.md` fragments from deterministic release entries generated by [`scripts/sdk-release-metadata.mjs`](scripts/sdk-release-metadata.mjs). Entries answer three questions: where the change occurred (`scope`), how severe it is (`feat!`, `feat`, or `fix`), and what changed. Known scopes also include `docs_url`, which the changelog renderer uses to link scope names to WorkOS API reference pages.
|
|
80
|
+
|
|
81
|
+
Each entry includes `scope_sources` and `scope_candidates` so the chosen scope can be audited. Model and enum scope resolution uses parsed IR references when no explicit symbol taxonomy matches; if the symbol taxonomy and IR references disagree, the script emits a warning with both values. Automated runs pass `--strict-scopes`, which fails the workflow if a user-facing entry resolves to the fallback `sdk` scope or lacks `docs_url` metadata.
|
|
82
|
+
|
|
83
|
+
In automation, `.github/workflows/generate-prs.yml` provides the structured `oagen diff`, parsed old/new IR, compat report, and changed SDK files. The script outputs JSON entries; the workflow creates the PR and adds the PR link/number when writing the changelog fragment.
|
|
84
|
+
|
|
85
|
+
For manual repair of existing fragments, pass the `openapi-spec` workflow commit that triggered the SDK PR. The script uses the spec state at that commit and diffs it against the previous spec-changing commit.
|
|
86
|
+
|
|
87
|
+
```bash
|
|
88
|
+
# JSON entries, useful for inspection
|
|
89
|
+
node scripts/sdk-release-metadata.mjs \
|
|
90
|
+
--spec-commit dee95fc \
|
|
91
|
+
--sdk-repo ../backend/workos-dotnet
|
|
92
|
+
|
|
93
|
+
# Full markdown fragment for replacing an existing .changelog-pending file
|
|
94
|
+
node scripts/sdk-release-metadata.mjs \
|
|
95
|
+
--spec-commit dee95fc \
|
|
96
|
+
--sdk-repo ../backend/workos-dotnet \
|
|
97
|
+
--format changelog \
|
|
98
|
+
--pr-number 263 \
|
|
99
|
+
--pr-url https://github.com/workos/workos-dotnet/pull/263
|
|
100
|
+
```
|
|
101
|
+
|
|
102
|
+
`--pr-number` and `--pr-url` only affect manual `--format changelog` output: they render the first fragment line with a PR link. Automated runs do not pass them because the workflow already gets the PR URL from `gh pr create`.
|
|
103
|
+
|
|
104
|
+
Run `node scripts/sdk-release-metadata.mjs --help` for all options.
|
|
105
|
+
|
|
77
106
|
### Local development
|
|
78
107
|
|
|
79
108
|
Install dependencies:
|