Skip to content
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

chore: do not override theme.openapi with ConfigReferenceDocs node type #1495

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

tatomyr
Copy link
Contributor

@tatomyr tatomyr commented Mar 20, 2024

What/Why/How?

Getting rid of overwriting theme.openapi with the ConfigReferenceDocs node type it's going to come from the Redocly config package soon.

Reference

Related changes in the Redocly config package: https://github.com/Redocly/redocly/pull/8628

Testing

Screenshots (optional)

Check yourself

  • Code changed? - Tested with redoc/reference-docs/workflows (internal)
  • All new/updated code is covered with tests
  • New package installed? - Tested in different environments (browser/node)

Security

  • Security impact of change has been considered
  • Code follows company security practices and guidelines

@tatomyr tatomyr self-assigned this Mar 20, 2024
Copy link

changeset-bot bot commented Mar 20, 2024

⚠️ No Changeset found

Latest commit: fc37b3d

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

Copy link
Contributor

Command Mean [s] Min [s] Max [s] Relative
redocly lint packages/core/src/benchmark/benches/rebilly.yaml 1.029 ± 0.014 1.018 1.065 1.00
redocly-next lint packages/core/src/benchmark/benches/rebilly.yaml 1.036 ± 0.022 1.000 1.079 1.01 ± 0.03

Copy link
Contributor

Coverage report

❌ An unexpected error occurred. For more details, check console

Error: The process '/opt/hostedtoolcache/node/20.11.1/x64/bin/npm' failed with exit code 1
St.
Category Percentage Covered / Total
🟡 Statements 76.52% 4380/5724
🟡 Branches 66.87% 2351/3516
🟡 Functions 69.75% 717/1028
🟡 Lines 76.69% 4112/5362
Show files with reduced coverage 🔻
St.
File Statements Branches Functions Lines
🟢
... / redocly-yaml.ts
82.93% (-6.67% 🔻)
52.78% (-12.22% 🔻)
66.67% (-33.33% 🔻)
82.35% (-6.81% 🔻)

Test suite run failed

Failed tests: 1/718. Failed suites: 1/102.
  ● lint › lintConfig should work

    expect(received).toMatchInlineSnapshot(snapshot)

    Snapshot name: `lint lintConfig should work 1`

    - Snapshot  - 31
    + Received  +  0

    @@ -11,37 +11,6 @@
          "message": "Expected type `ConfigApis` (object) but got `string`",
          "ruleId": "configuration spec",
          "severity": "error",
          "suggest": [],
        },
    -   {
    -     "from": undefined,
    -     "location": [
    -       {
    -         "pointer": "#/theme/openapi/layout",
    -         "reportOnKey": false,
    -         "source": "",
    -       },
    -     ],
    -     "message": "`layout` can be one of the following only: "stacked", "three-panel".",
    -     "ruleId": "configuration spec",
    -     "severity": "error",
    -     "suggest": [],
    -   },
    -   {
    -     "from": undefined,
    -     "location": [
    -       {
    -         "pointer": "#/theme/openapi/theme/theme",
    -         "reportOnKey": true,
    -         "source": "",
    -       },
    -     ],
    -     "message": "Property `theme` is not expected here.",
    -     "ruleId": "configuration spec",
    -     "severity": "error",
    -     "suggest": [
    -       "schema",
    -       "shape",
    -     ],
    -   },
      ]

      395 |     const results = await lintConfig({ document });
      396 |
    > 397 |     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
          |                                           ^
      398 |       [
      399 |         {
      400 |           "from": undefined,

      at packages/core/src/__tests__/lint.test.ts:397:43
      at fulfilled (packages/core/src/__tests__/lint.test.ts:5:58)

Report generated by 🧪jest coverage report action from fc37b3d

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.

None yet

1 participant