Skip to content

docs(other): alternative respect usage code walkthrough article#300

Merged
DmitryAnansky merged 4 commits into
chore/respect-simple-usage-blog-postfrom
docs/respect-simple-usage-guide-walkthrough-version
May 14, 2026
Merged

docs(other): alternative respect usage code walkthrough article#300
DmitryAnansky merged 4 commits into
chore/respect-simple-usage-blog-postfrom
docs/respect-simple-usage-guide-walkthrough-version

Conversation

@DmitryAnansky
Copy link
Copy Markdown
Contributor

What/Why/How?

Alternative respect usage code walkthrough article.

Reference

Testing

Screenshots (optional)

Check yourself

  • Code is linted
  • Tested
  • All new/updated code is covered with tests

Security

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

Copy link
Copy Markdown

@redocly redocly Bot left a comment

Choose a reason for hiding this comment

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

marketing-site AI Review: 🟢 Completed

Reunite Bot has reviewed your changes and found 13 potential issue(s).

Note

Low Risk

The changes are entirely confined to documentation and example files within the learn/arazzo directory. There is no modification to the core system, application logic, or build configuration, meaning there is no risk to production behavior or functionality.

Overview

Refactors the Arazzo "Respect" usage articles to implement an alternative, interactive code walkthrough format.

  • Migrates inline OpenAPI and Arazzo YAML snippets into standalone external files within new _filesets directories.
  • Annotates the new YAML files with # @chunk tags to break down complex configurations into digestible steps.
  • Updates api-contract-testing-01.md and oauth2-authorization-02.md to use the {% code-walkthrough %} and {% step %} components, providing a better side-by-side reading experience for the tutorials.

@DmitryAnansky DmitryAnansky requested review from a team May 13, 2026 10:12
Comment thread learn/arazzo/_filesets/practical-example-series/oauth2/authorization.arazzo.yaml Outdated
type: string
format: uri
registrationAccessToken:
type: string
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

The OAuth2Client schema exposes registrationAccessToken. This is a highly sensitive token that should be handled with care and typically not returned unless necessary for client management (API3:2023).

Comment thread learn/arazzo/practical-example-series/oauth2-authorization-02.md
Comment thread learn/arazzo/practical-example-series/oauth2-authorization-02.md
Comment thread learn/arazzo/practical-example-series/api-contract-testing-01.md
Comment thread learn/arazzo/_filesets/practical-example-series/oauth2/authorization.arazzo.yaml Outdated
Comment thread learn/arazzo/practical-example-series/oauth2-authorization-02.md
Comment thread learn/arazzo/practical-example-series/api-contract-testing-01.md Outdated
Comment thread learn/arazzo/practical-example-series/api-contract-testing-01.md
Comment thread learn/arazzo/practical-example-series/api-contract-testing-01.md Outdated
Comment thread learn/arazzo/practical-example-series/api-contract-testing-01.md
Comment thread learn/arazzo/practical-example-series/api-contract-testing-01.md Outdated
Comment thread learn/arazzo/practical-example-series/api-contract-testing-01.md Outdated
Comment thread learn/arazzo/practical-example-series/api-contract-testing-01.md Outdated
Comment thread learn/arazzo/practical-example-series/api-contract-testing-01.md Outdated
Comment thread learn/arazzo/practical-example-series/api-contract-testing-01.md Outdated
Comment thread learn/arazzo/practical-example-series/oauth2-authorization-02.md
@DmitryAnansky DmitryAnansky merged commit 3f94d45 into chore/respect-simple-usage-blog-post May 14, 2026
1 of 2 checks passed
@DmitryAnansky DmitryAnansky deleted the docs/respect-simple-usage-guide-walkthrough-version branch May 14, 2026 13:03
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.

2 participants