Skip to content

docs: add x-security extension documentation for Respect#7

Merged
DmitryAnansky merged 8 commits intomainfrom
docs/respect-x-security-extension
Jul 25, 2025
Merged

docs: add x-security extension documentation for Respect#7
DmitryAnansky merged 8 commits intomainfrom
docs/respect-x-security-extension

Conversation

@yarokon
Copy link
Contributor

@yarokon yarokon commented Jun 2, 2025

What/Why/How?

Added x-security extension documentation for Respect

Reference

Testing

Screenshots (optional)

Screenshot 2025-06-02 at 11 16 55

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

@yarokon yarokon requested a review from adamaltman June 2, 2025 14:56
Copy link
Member

@adamaltman adamaltman left a comment

Choose a reason for hiding this comment

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

Minor change

Co-authored-by: Adam Altman <adam@rebilly.com>
@yarokon yarokon requested a review from adamaltman June 2, 2025 16:16
@DmitryAnansky
Copy link
Contributor

Probably we should wait for cli v2 release before merging the Docs.

@adamaltman
Copy link
Member

Why @DmitryAnansky ?

@yarokon yarokon added the documentation Improvements or additions to documentation label Jun 5, 2025
@DmitryAnansky
Copy link
Contributor

DmitryAnansky commented Jun 10, 2025

Why @DmitryAnansky ?

It does not have rbac: anymore and feature is not released, only merged and we have snapshot version + this snapshot version in mono-repo.
Currently we have some pool of PRs not released publicly due to CLI V2 release preparation.
This is the only argument I have.

@adamaltman
Copy link
Member

Got it, it will be released with the CLI v2. I found a minor issue in the changelog.

Redocly/redocly-cli#2056 (comment)

@DmitryAnansky DmitryAnansky merged commit 1877886 into main Jul 25, 2025
5 checks passed
@DmitryAnansky DmitryAnansky deleted the docs/respect-x-security-extension branch July 25, 2025 14:12
themattwilliams pushed a commit that referenced this pull request Sep 18, 2025
…ization

- Split original api-design-first-security-guide.md into 6 focused articles
- Remove Redocly branding to create vendor-neutral security content
- Add 3 strategic Mermaid diagrams (#4, #5, #7) for visual learning

New Articles Created:
• learn/security/index.md - Main landing page with article overview
• api-tls-encryption-https-best-practices.md - TLS 1.3, HTTPS, mTLS guide
• api-input-validation-injection-prevention.md - Schema validation, SQL injection prevention
• api-rate-limiting-abuse-prevention.md - DoS protection, rate limiting algorithms
• authentication-authorization-openapi.md - JWT, OAuth2, security schemes
• api-design-first-security-governance.md - Automated governance, policy-as-code

Navigation & UX Improvements:
• Updated learn/security/sidebars.yaml with organized article structure
• Enhanced pages/learning-center/cards.ts with all 6 security articles
• Added strategic cross-links between related security topics
• Implemented target='_blank' links to preserve user navigation context
• Fixed URLs to use clean paths without .md extensions

Content Quality:
• Each article SEO-optimized with focused keywords and standalone value
• Comprehensive cross-referencing between security domains
• Real-world case studies: Heartbleed, Equifax, Facebook phone scraping
• Practical code examples and governance rule implementations
• Progressive learning path from infrastructure to organizational maturity
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

Comments