Skip to content

Fix Redoc CLI warning #1465

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 29, 2023
Merged

Fix Redoc CLI warning #1465

merged 1 commit into from
Nov 29, 2023

Conversation

drwpow
Copy link
Contributor

@drwpow drwpow commented Nov 29, 2023

Changes

Fixes #1463 by changing openapi-ts to x-openapi-ts. This is a breaking change, but there’s a helpful migration error for users of the beta version.

How to Review

  • Tests updated; tests should pass

Checklist

  • Unit tests updated
  • docs/ updated (if necessary)
  • pnpm run update:examples run (only applicable for openapi-typescript)

Copy link

changeset-bot bot commented Nov 29, 2023

⚠️ No Changeset found

Latest commit: 713a3dd

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR


```yaml
apis:
core@v2:
root: ./openapi/openapi.yaml
openapi-ts:
x-openapi-ts:
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👀

@@ -38,6 +38,7 @@ Options
const OUTPUT_FILE = "FILE";
const OUTPUT_STDOUT = "STDOUT";
const CWD = new URL(`file://${process.cwd()}/`);
const REDOC_CONFIG_KEY = "x-openapi-ts";
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A manually-typed constant 3× was a bug waiting to happen 😅

@drwpow drwpow merged commit 3994af5 into main Nov 29, 2023
@drwpow drwpow deleted the rename-redoc-config-key branch November 29, 2023 00:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Adding 'openapi-ts' property in .redocly.yaml results in Redocly lint warning
1 participant