diff --git a/generator/konfig-dash/.changeset/selfish-ads-rest.md b/generator/konfig-dash/.changeset/selfish-ads-rest.md deleted file mode 100644 index ca11acda4..000000000 --- a/generator/konfig-dash/.changeset/selfish-ads-rest.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -'konfig-openapi-spec': minor -'konfig-cli': minor -'konfig-lib': minor ---- - -add readmeHeaderSnippet configuration diff --git a/generator/konfig-dash/packages/konfig-cli/CHANGELOG.md b/generator/konfig-dash/packages/konfig-cli/CHANGELOG.md index be1e94c7d..dc9e1172f 100644 --- a/generator/konfig-dash/packages/konfig-cli/CHANGELOG.md +++ b/generator/konfig-dash/packages/konfig-cli/CHANGELOG.md @@ -1,5 +1,18 @@ # konfig-cli +## 1.29.0 + +### Minor Changes + +- [#343](https://github.com/konfig-dev/konfig/pull/343) [`c88285d0`](https://github.com/konfig-dev/konfig/commit/c88285d03321f2d1fedffdfa6164bc22cba92f2b) Thanks [@dphuang2](https://github.com/dphuang2)! - add readmeHeaderSnippet configuration + +### Patch Changes + +- Updated dependencies [[`c88285d0`](https://github.com/konfig-dev/konfig/commit/c88285d03321f2d1fedffdfa6164bc22cba92f2b)]: + - konfig-openapi-spec@1.7.0 + - konfig-lib@1.28.0 + - konfig-postman-to-openapi@3.0.142 + ## 1.28.0 ### Minor Changes diff --git a/generator/konfig-dash/packages/konfig-cli/README.md b/generator/konfig-dash/packages/konfig-cli/README.md index 15432c9e8..92dcecd26 100644 --- a/generator/konfig-dash/packages/konfig-cli/README.md +++ b/generator/konfig-dash/packages/konfig-cli/README.md @@ -16,7 +16,7 @@ $ npm install -g konfig-cli $ konfig COMMAND running command... $ konfig (--version) -konfig-cli/1.28.0 linux-x64 node-v16.20.2 +konfig-cli/1.29.0 linux-x64 node-v16.20.2 $ konfig --help [COMMAND] USAGE $ konfig COMMAND @@ -78,7 +78,7 @@ EXAMPLES $ konfig bump ``` -_See code: [dist/commands/bump.ts](https://github.com/konfig-dev/konfig-cli/blob/v1.28.0/dist/commands/bump.ts)_ +_See code: [dist/commands/bump.ts](https://github.com/konfig-dev/konfig-cli/blob/v1.29.0/dist/commands/bump.ts)_ ## `konfig changeset` @@ -106,7 +106,7 @@ EXAMPLES $ konfig changeset -g python ``` -_See code: [dist/commands/changeset.ts](https://github.com/konfig-dev/konfig-cli/blob/v1.28.0/dist/commands/changeset.ts)_ +_See code: [dist/commands/changeset.ts](https://github.com/konfig-dev/konfig-cli/blob/v1.29.0/dist/commands/changeset.ts)_ ## `konfig detect-breaking-change` @@ -127,7 +127,7 @@ EXAMPLES $ konfig detect-breaking-change ``` -_See code: [dist/commands/detect-breaking-change.ts](https://github.com/konfig-dev/konfig-cli/blob/v1.28.0/dist/commands/detect-breaking-change.ts)_ +_See code: [dist/commands/detect-breaking-change.ts](https://github.com/konfig-dev/konfig-cli/blob/v1.29.0/dist/commands/detect-breaking-change.ts)_ ## `konfig diff` @@ -144,7 +144,7 @@ EXAMPLES $ konfig diff ``` -_See code: [dist/commands/diff.ts](https://github.com/konfig-dev/konfig-cli/blob/v1.28.0/dist/commands/diff.ts)_ +_See code: [dist/commands/diff.ts](https://github.com/konfig-dev/konfig-cli/blob/v1.29.0/dist/commands/diff.ts)_ ## `konfig fix` @@ -173,7 +173,7 @@ EXAMPLES $ konfig fix ``` -_See code: [dist/commands/fix.ts](https://github.com/konfig-dev/konfig-cli/blob/v1.28.0/dist/commands/fix.ts)_ +_See code: [dist/commands/fix.ts](https://github.com/konfig-dev/konfig-cli/blob/v1.29.0/dist/commands/fix.ts)_ ## `konfig generate` @@ -222,7 +222,7 @@ EXAMPLES $ konfig generate ``` -_See code: [dist/commands/generate.ts](https://github.com/konfig-dev/konfig-cli/blob/v1.28.0/dist/commands/generate.ts)_ +_See code: [dist/commands/generate.ts](https://github.com/konfig-dev/konfig-cli/blob/v1.29.0/dist/commands/generate.ts)_ ## `konfig help [COMMAND]` @@ -262,7 +262,7 @@ EXAMPLES $ konfig ignore ``` -_See code: [dist/commands/ignore.ts](https://github.com/konfig-dev/konfig-cli/blob/v1.28.0/dist/commands/ignore.ts)_ +_See code: [dist/commands/ignore.ts](https://github.com/konfig-dev/konfig-cli/blob/v1.29.0/dist/commands/ignore.ts)_ ## `konfig init` @@ -285,7 +285,7 @@ EXAMPLES $ konfig init ``` -_See code: [dist/commands/init.ts](https://github.com/konfig-dev/konfig-cli/blob/v1.28.0/dist/commands/init.ts)_ +_See code: [dist/commands/init.ts](https://github.com/konfig-dev/konfig-cli/blob/v1.29.0/dist/commands/init.ts)_ ## `konfig lint` @@ -302,7 +302,7 @@ EXAMPLES $ konfig lint ``` -_See code: [dist/commands/lint.ts](https://github.com/konfig-dev/konfig-cli/blob/v1.28.0/dist/commands/lint.ts)_ +_See code: [dist/commands/lint.ts](https://github.com/konfig-dev/konfig-cli/blob/v1.29.0/dist/commands/lint.ts)_ ## `konfig lint-python` @@ -330,7 +330,7 @@ EXAMPLES $ konfig lint-python -f -p test/simple_test.py ``` -_See code: [dist/commands/lint-python.ts](https://github.com/konfig-dev/konfig-cli/blob/v1.28.0/dist/commands/lint-python.ts)_ +_See code: [dist/commands/lint-python.ts](https://github.com/konfig-dev/konfig-cli/blob/v1.29.0/dist/commands/lint-python.ts)_ ## `konfig list-sdk-submodules` @@ -347,7 +347,7 @@ EXAMPLES $ konfig list-sdk-submodules ``` -_See code: [dist/commands/list-sdk-submodules.ts](https://github.com/konfig-dev/konfig-cli/blob/v1.28.0/dist/commands/list-sdk-submodules.ts)_ +_See code: [dist/commands/list-sdk-submodules.ts](https://github.com/konfig-dev/konfig-cli/blob/v1.29.0/dist/commands/list-sdk-submodules.ts)_ ## `konfig login` @@ -364,7 +364,7 @@ EXAMPLES $ konfig login ``` -_See code: [dist/commands/login.ts](https://github.com/konfig-dev/konfig-cli/blob/v1.28.0/dist/commands/login.ts)_ +_See code: [dist/commands/login.ts](https://github.com/konfig-dev/konfig-cli/blob/v1.29.0/dist/commands/login.ts)_ ## `konfig logout` @@ -381,7 +381,7 @@ EXAMPLES $ konfig logout ``` -_See code: [dist/commands/logout.ts](https://github.com/konfig-dev/konfig-cli/blob/v1.28.0/dist/commands/logout.ts)_ +_See code: [dist/commands/logout.ts](https://github.com/konfig-dev/konfig-cli/blob/v1.29.0/dist/commands/logout.ts)_ ## `konfig mock` @@ -398,7 +398,7 @@ EXAMPLES $ konfig mock ``` -_See code: [dist/commands/mock.ts](https://github.com/konfig-dev/konfig-cli/blob/v1.28.0/dist/commands/mock.ts)_ +_See code: [dist/commands/mock.ts](https://github.com/konfig-dev/konfig-cli/blob/v1.29.0/dist/commands/mock.ts)_ ## `konfig p2o` @@ -419,7 +419,7 @@ EXAMPLES $ konfig p2o ``` -_See code: [dist/commands/p2o.ts](https://github.com/konfig-dev/konfig-cli/blob/v1.28.0/dist/commands/p2o.ts)_ +_See code: [dist/commands/p2o.ts](https://github.com/konfig-dev/konfig-cli/blob/v1.29.0/dist/commands/p2o.ts)_ ## `konfig pr-create` @@ -444,7 +444,7 @@ EXAMPLES $ konfig pr-create ``` -_See code: [dist/commands/pr-create.ts](https://github.com/konfig-dev/konfig-cli/blob/v1.28.0/dist/commands/pr-create.ts)_ +_See code: [dist/commands/pr-create.ts](https://github.com/konfig-dev/konfig-cli/blob/v1.29.0/dist/commands/pr-create.ts)_ ## `konfig pr-merge` @@ -467,7 +467,7 @@ EXAMPLES $ konfig pr-merge ``` -_See code: [dist/commands/pr-merge.ts](https://github.com/konfig-dev/konfig-cli/blob/v1.28.0/dist/commands/pr-merge.ts)_ +_See code: [dist/commands/pr-merge.ts](https://github.com/konfig-dev/konfig-cli/blob/v1.29.0/dist/commands/pr-merge.ts)_ ## `konfig publish` @@ -498,7 +498,7 @@ EXAMPLES $ konfig publish ``` -_See code: [dist/commands/publish.ts](https://github.com/konfig-dev/konfig-cli/blob/v1.28.0/dist/commands/publish.ts)_ +_See code: [dist/commands/publish.ts](https://github.com/konfig-dev/konfig-cli/blob/v1.29.0/dist/commands/publish.ts)_ ## `konfig published` @@ -518,7 +518,7 @@ EXAMPLES $ konfig published ``` -_See code: [dist/commands/published.ts](https://github.com/konfig-dev/konfig-cli/blob/v1.28.0/dist/commands/published.ts)_ +_See code: [dist/commands/published.ts](https://github.com/konfig-dev/konfig-cli/blob/v1.29.0/dist/commands/published.ts)_ ## `konfig pull` @@ -539,7 +539,7 @@ EXAMPLES $ konfig pull ``` -_See code: [dist/commands/pull.ts](https://github.com/konfig-dev/konfig-cli/blob/v1.28.0/dist/commands/pull.ts)_ +_See code: [dist/commands/pull.ts](https://github.com/konfig-dev/konfig-cli/blob/v1.29.0/dist/commands/pull.ts)_ ## `konfig push` @@ -563,7 +563,7 @@ EXAMPLES $ konfig push ``` -_See code: [dist/commands/push.ts](https://github.com/konfig-dev/konfig-cli/blob/v1.28.0/dist/commands/push.ts)_ +_See code: [dist/commands/push.ts](https://github.com/konfig-dev/konfig-cli/blob/v1.29.0/dist/commands/push.ts)_ ## `konfig revalidate-demos [FILE]` @@ -585,7 +585,7 @@ EXAMPLES $ konfig revalidate-demos ``` -_See code: [dist/commands/revalidate-demos.ts](https://github.com/konfig-dev/konfig-cli/blob/v1.28.0/dist/commands/revalidate-demos.ts)_ +_See code: [dist/commands/revalidate-demos.ts](https://github.com/konfig-dev/konfig-cli/blob/v1.29.0/dist/commands/revalidate-demos.ts)_ ## `konfig revalidate-portal [FILE]` @@ -607,7 +607,7 @@ EXAMPLES $ konfig revalidate-portal ``` -_See code: [dist/commands/revalidate-portal.ts](https://github.com/konfig-dev/konfig-cli/blob/v1.28.0/dist/commands/revalidate-portal.ts)_ +_See code: [dist/commands/revalidate-portal.ts](https://github.com/konfig-dev/konfig-cli/blob/v1.29.0/dist/commands/revalidate-portal.ts)_ ## `konfig slack-msg [FILE]` @@ -628,7 +628,7 @@ EXAMPLES $ konfig slack-msg ``` -_See code: [dist/commands/slack-msg.ts](https://github.com/konfig-dev/konfig-cli/blob/v1.28.0/dist/commands/slack-msg.ts)_ +_See code: [dist/commands/slack-msg.ts](https://github.com/konfig-dev/konfig-cli/blob/v1.29.0/dist/commands/slack-msg.ts)_ ## `konfig test` @@ -651,7 +651,7 @@ EXAMPLES $ konfig test ``` -_See code: [dist/commands/test.ts](https://github.com/konfig-dev/konfig-cli/blob/v1.28.0/dist/commands/test.ts)_ +_See code: [dist/commands/test.ts](https://github.com/konfig-dev/konfig-cli/blob/v1.29.0/dist/commands/test.ts)_ ## `konfig version` @@ -668,5 +668,5 @@ EXAMPLES $ konfig version ``` -_See code: [dist/commands/version.ts](https://github.com/konfig-dev/konfig-cli/blob/v1.28.0/dist/commands/version.ts)_ +_See code: [dist/commands/version.ts](https://github.com/konfig-dev/konfig-cli/blob/v1.29.0/dist/commands/version.ts)_ diff --git a/generator/konfig-dash/packages/konfig-cli/package.json b/generator/konfig-dash/packages/konfig-cli/package.json index 35907dbf7..a40e7faed 100644 --- a/generator/konfig-dash/packages/konfig-cli/package.json +++ b/generator/konfig-dash/packages/konfig-cli/package.json @@ -1,6 +1,6 @@ { "name": "konfig-cli", - "version": "1.28.0", + "version": "1.29.0", "description": "CLI for Generating SDKs with Konfig", "author": "dphuang2 @dphuang2", "bin": { diff --git a/generator/konfig-dash/packages/konfig-lib/CHANGELOG.md b/generator/konfig-dash/packages/konfig-lib/CHANGELOG.md index c2c96f0f7..b5fc58171 100644 --- a/generator/konfig-dash/packages/konfig-lib/CHANGELOG.md +++ b/generator/konfig-dash/packages/konfig-lib/CHANGELOG.md @@ -1,5 +1,11 @@ # konfig-lib +## 1.28.0 + +### Minor Changes + +- [#343](https://github.com/konfig-dev/konfig/pull/343) [`c88285d0`](https://github.com/konfig-dev/konfig/commit/c88285d03321f2d1fedffdfa6164bc22cba92f2b) Thanks [@dphuang2](https://github.com/dphuang2)! - add readmeHeaderSnippet configuration + ## 1.27.0 ### Minor Changes diff --git a/generator/konfig-dash/packages/konfig-lib/konfig-yaml.schema.json b/generator/konfig-dash/packages/konfig-lib/konfig-yaml.schema.json index 04695da9e..7a6d1e881 100644 --- a/generator/konfig-dash/packages/konfig-lib/konfig-yaml.schema.json +++ b/generator/konfig-dash/packages/konfig-lib/konfig-yaml.schema.json @@ -961,6 +961,10 @@ "type": "boolean", "description": "Whether or not to use the operation's description in the operation table documentation. By default the summary is used." }, + "readmeHeaderSnippet": { + "type": "string", + "description": "A snippet of markdown that will be inserted at the top of the README.md file. This is useful for adding a custom header to the README.md file that is not generated by Konfig." + }, "language": { "type": "string", "const": "python", @@ -2011,6 +2015,9 @@ "useDescriptionInOperationTableDocumentation": { "$ref": "#/definitions/konfigYaml/properties/generators/properties/python/properties/useDescriptionInOperationTableDocumentation" }, + "readmeHeaderSnippet": { + "$ref": "#/definitions/konfigYaml/properties/generators/properties/python/properties/readmeHeaderSnippet" + }, "language": { "$ref": "#/definitions/konfigYaml/properties/generators/properties/python/properties/language" }, diff --git a/generator/konfig-dash/packages/konfig-lib/package.json b/generator/konfig-dash/packages/konfig-lib/package.json index db0de9289..4af353cfd 100644 --- a/generator/konfig-dash/packages/konfig-lib/package.json +++ b/generator/konfig-dash/packages/konfig-lib/package.json @@ -49,5 +49,5 @@ "typescript": "^4.7.4", "zod-to-json-schema": "^3.20.4" }, - "version": "1.27.0" + "version": "1.28.0" } diff --git a/generator/konfig-dash/packages/konfig-openapi-spec/CHANGELOG.md b/generator/konfig-dash/packages/konfig-openapi-spec/CHANGELOG.md index 153f406ba..a55cb5b9f 100644 --- a/generator/konfig-dash/packages/konfig-openapi-spec/CHANGELOG.md +++ b/generator/konfig-dash/packages/konfig-openapi-spec/CHANGELOG.md @@ -1,5 +1,16 @@ # konfig-openapi-spec +## 1.7.0 + +### Minor Changes + +- [#343](https://github.com/konfig-dev/konfig/pull/343) [`c88285d0`](https://github.com/konfig-dev/konfig/commit/c88285d03321f2d1fedffdfa6164bc22cba92f2b) Thanks [@dphuang2](https://github.com/dphuang2)! - add readmeHeaderSnippet configuration + +### Patch Changes + +- Updated dependencies [[`c88285d0`](https://github.com/konfig-dev/konfig/commit/c88285d03321f2d1fedffdfa6164bc22cba92f2b)]: + - konfig-lib@1.28.0 + ## 1.6.4 ### Patch Changes diff --git a/generator/konfig-dash/packages/konfig-openapi-spec/package.json b/generator/konfig-dash/packages/konfig-openapi-spec/package.json index ca36ede79..889148550 100644 --- a/generator/konfig-dash/packages/konfig-openapi-spec/package.json +++ b/generator/konfig-dash/packages/konfig-openapi-spec/package.json @@ -1,6 +1,6 @@ { "name": "konfig-openapi-spec", - "version": "1.6.4", + "version": "1.7.0", "packageManager": "yarn@3.2.3", "main": "./dist/index.js", "types": "./dist/index.d.ts", diff --git a/generator/konfig-dash/packages/konfig-postman-to-openapi/CHANGELOG.md b/generator/konfig-dash/packages/konfig-postman-to-openapi/CHANGELOG.md index ded4f675f..7b79e55f2 100644 --- a/generator/konfig-dash/packages/konfig-postman-to-openapi/CHANGELOG.md +++ b/generator/konfig-dash/packages/konfig-postman-to-openapi/CHANGELOG.md @@ -1,5 +1,12 @@ ### [3.0.1](https://github.com/joolfe/postman-to-openapi/compare/3.0.0...3.0.1) (2023-01-21) +## 3.0.142 + +### Patch Changes + +- Updated dependencies [[`c88285d0`](https://github.com/konfig-dev/konfig/commit/c88285d03321f2d1fedffdfa6164bc22cba92f2b)]: + - konfig-lib@1.28.0 + ## 3.0.141 ### Patch Changes diff --git a/generator/konfig-dash/packages/konfig-postman-to-openapi/package.json b/generator/konfig-dash/packages/konfig-postman-to-openapi/package.json index bdb9dc8ee..1ceaf583d 100644 --- a/generator/konfig-dash/packages/konfig-postman-to-openapi/package.json +++ b/generator/konfig-dash/packages/konfig-postman-to-openapi/package.json @@ -1,6 +1,6 @@ { "name": "konfig-postman-to-openapi", - "version": "3.0.141", + "version": "3.0.142", "description": "Convert postman collection to OpenAPI spec", "main": "lib/index.js", "types": "types/index.d.ts", diff --git a/generator/konfig-dash/packages/konfig-spectral-ruleset/CHANGELOG.md b/generator/konfig-dash/packages/konfig-spectral-ruleset/CHANGELOG.md index fa30b19ae..302c2fb8c 100644 --- a/generator/konfig-dash/packages/konfig-spectral-ruleset/CHANGELOG.md +++ b/generator/konfig-dash/packages/konfig-spectral-ruleset/CHANGELOG.md @@ -1,5 +1,12 @@ # konfig-spectral-ruleset +## 1.2.17 + +### Patch Changes + +- Updated dependencies [[`c88285d0`](https://github.com/konfig-dev/konfig/commit/c88285d03321f2d1fedffdfa6164bc22cba92f2b)]: + - konfig-lib@1.28.0 + ## 1.2.16 ### Patch Changes diff --git a/generator/konfig-dash/packages/konfig-spectral-ruleset/package.json b/generator/konfig-dash/packages/konfig-spectral-ruleset/package.json index 9c1342a79..3d2d6eb70 100644 --- a/generator/konfig-dash/packages/konfig-spectral-ruleset/package.json +++ b/generator/konfig-dash/packages/konfig-spectral-ruleset/package.json @@ -1,6 +1,6 @@ { "name": "konfig-spectral-ruleset", - "version": "1.2.16", + "version": "1.2.17", "description": "Make your HTTP APIs better, faster, stronger, whether they are still being designed (API Design-First) or your organization has flopped various mismatched APIs into production and now you're thinking some consistency would be nice. Using Spectral and OpenAPI.", "main": "dist/ruleset.js", "module": "dist/ruleset.mjs",