Skip to content

Commit 3baf620

Browse files
authored
feat: OpenAPI Overlay 1.1.0 (#200)
* feat: OpenAPI Overlay 1.1.0 * feat: Add overlay versioning support and enforce compatibility rules * chore: Code formatting * chore: Update website link * chore: Bump dependencies
1 parent ae0b746 commit 3baf620

14 files changed

Lines changed: 1586 additions & 1080 deletions

File tree

CHANGELOG.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
11
## unreleased
22

3-
- feat: improve CLI playground URL handling
3+
- Overlay: add OpenAPI Overlay 1.1.0 support
4+
- Overlay: add `copy` action support with strict `from` validation
5+
- Overlay: enforce strict action validation and type compatibility for update/copy actions
6+
- CLI: improve CLI playground URL handling
7+
- Types: extend overlay typings with `copy`, `from`, and overlay metadata fields
8+
- Docs: update overlay examples and guidance to 1.1.0
49

510
## [1.29.5] - 2026-02-28
611

@@ -433,4 +438,4 @@ Initial commit with features
433438
- Format via CLI
434439
- Format via config files
435440
- Use via as Module
436-
- Support for OpenAPI 3.0
441+
- Support for OpenAPI 3.0

bin/cli.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -421,7 +421,7 @@ async function run(oaFile, options) {
421421
const cliOut = [];
422422
cliLog.unusedActions.forEach(action => {
423423
cliOut.push(
424-
`- Target: ${action.target}\n Type: ${action.update ? 'update' : action.remove ? 'remove' : 'unknown'}`
424+
`- Target: ${action.target}\n Type: ${action.update ? 'update' : action.remove ? 'remove' : action.copy ? 'copy' : 'unknown'}`
425425
);
426426
});
427427

bin/cli.test.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -364,10 +364,10 @@ describe('openapi-format CLI command', () => {
364364
const setting = `${path}/customFilter.yaml`;
365365
const args = [inputFile, `--filterFile ${setting}`, `--playground`];
366366

367-
console.log('playground request args:', args);
367+
// console.log('playground request args:', args);
368368
let result = await testUtils.cli(args, '.');
369-
console.log('playground response stdout:', result.stdout);
370-
console.log('playground response stderr:', result.stderr);
369+
// console.log('playground response stdout:', result.stdout);
370+
// console.log('playground response stderr:', result.stderr);
371371
expect(result.code).toBe(0);
372372
if (process.env.CI) {
373373
expect(result.stderr).toContain('Running in CI/CD environment, no Share URL generated');

0 commit comments

Comments
 (0)