Skip to content

feat: improve generate-arazzo command output#1962

Merged
DmitryAnansky merged 9 commits intomainfrom
feat/improve-generate-arazzo-command-with-security
Mar 3, 2025
Merged

feat: improve generate-arazzo command output#1962
DmitryAnansky merged 9 commits intomainfrom
feat/improve-generate-arazzo-command-with-security

Conversation

@DmitryAnansky
Copy link
Contributor

@DmitryAnansky DmitryAnansky commented Feb 26, 2025

What/Why/How?

Expend Arazzo genration to handle simple cases of securitySchemes (basic, apiKey, bearer) and create inputs on components level, parameters and inputs per Workflow.
Autogeneration is still not perfect, but can give more insides about Step security requirements.

Reference

Closes: #1961

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

@changeset-bot
Copy link

changeset-bot bot commented Feb 26, 2025

🦋 Changeset detected

Latest commit: ea5c1dd

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 3 packages
Name Type
@redocly/respect-core Patch
@redocly/cli Patch
@redocly/openapi-core Patch

Not sure what this means? Click here to learn what changesets are.

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

@github-actions
Copy link
Contributor

github-actions bot commented Feb 26, 2025

Command Mean [ms] Min [ms] Max [ms] Relative
redocly lint packages/core/src/benchmark/benches/rebilly.yaml 966.6 ± 13.2 938.7 987.5 1.00
redocly-next lint packages/core/src/benchmark/benches/rebilly.yaml 979.1 ± 23.3 955.6 1035.4 1.01 ± 0.03

@github-actions
Copy link
Contributor

github-actions bot commented Feb 26, 2025

Coverage report

St.
Category Percentage Covered / Total
🟡 Statements 79.38% 7031/8857
🟡 Branches 68.37% 2929/4284
🟡 Functions 75.08% 1148/1529
🟡 Lines 79.76% 6705/8406
Show new covered files 🐣
St.
File Statements Branches Functions Lines
🟢
... / generate-workflows-from-description.ts
95.83% 72.73% 66.67% 95.83%
🟢
... / generate-workflow-security-inputs.ts
100% 100% 100% 100%
🟢
... / generate-workflow-security-parameters.ts
94.44% 87.5% 100% 94.44%
🟢
... / generate-inputs-arazzo-components.ts
90.91% 88.89% 100% 90.91%

Test suite run success

1338 tests passing in 193 suites.

Report generated by 🧪jest coverage report action from ea5c1dd

@DmitryAnansky DmitryAnansky force-pushed the feat/improve-generate-arazzo-command-with-security branch 3 times, most recently from d4c37be to 5266f59 Compare February 28, 2025 10:48
@DmitryAnansky DmitryAnansky marked this pull request as ready for review February 28, 2025 11:31
@DmitryAnansky DmitryAnansky requested review from a team as code owners February 28, 2025 11:31
@DmitryAnansky DmitryAnansky changed the title feat: improve generate-arazzo commang output feat: improve generate-arazzo command output Feb 28, 2025
@DmitryAnansky DmitryAnansky force-pushed the feat/improve-generate-arazzo-command-with-security branch from 6e0f5f8 to 53f48dc Compare March 3, 2025 09:30
@DmitryAnansky DmitryAnansky force-pushed the feat/improve-generate-arazzo-command-with-security branch from 53f48dc to 30b3c89 Compare March 3, 2025 13:57
@DmitryAnansky DmitryAnansky requested a review from tatomyr March 3, 2025 15:12
@DmitryAnansky DmitryAnansky force-pushed the feat/improve-generate-arazzo-command-with-security branch from 286261b to ca687de Compare March 3, 2025 15:12
@DmitryAnansky DmitryAnansky requested a review from tatomyr March 3, 2025 15:46
DmitryAnansky and others added 6 commits March 3, 2025 17:47
Co-authored-by: Jacek Łękawa <164185257+JLekawa@users.noreply.github.com>
Co-authored-by: Jacek Łękawa <164185257+JLekawa@users.noreply.github.com>
@DmitryAnansky DmitryAnansky force-pushed the feat/improve-generate-arazzo-command-with-security branch from 190b41a to ea5c1dd Compare March 3, 2025 15:47
@DmitryAnansky DmitryAnansky merged commit 180de62 into main Mar 3, 2025
41 checks passed
@DmitryAnansky DmitryAnansky deleted the feat/improve-generate-arazzo-command-with-security branch March 3, 2025 15:56
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.

Improve generate-arazzo command to create security inputs

3 participants