[EDU-6373] API v4 change rollout for 26 guides #1799
Closed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…cal user guides This commit implements the complete API v4 rollout documentation structure across all critical user journeys, supporting both legacy (API v3/Domains) and new (API v4/Workloads) interfaces during the migration period. Key changes: - Added Apiv4Rollout component and 4-tab structure (Console-Workloads, Console-Domains, API v4, API v3) to 26+ guides - Implemented Workloads interface support for mTLS, certificates, cache settings, and error responses - Added Edge Connectors documentation replacing Origins and Load Balancers - Implemented Custom Pages replacing Error Responses with proper 3-tab structure - Added comprehensive API v4 endpoints with proper authentication and request bodies - Verified all API v3 endpoints use correct base URL (api.azionapi.net) and headers - Fixed endpoint error in cache-settings.mdx during final sweep - Added critical operation guides: clone, delete, and personal-token management - Maintained bilingual consistency across EN/PT-BR documentation Architectural concepts covered: - Workloads (aggregated TLS/mTLS configuration replacing individual domain management) - Edge Connectors (unified origin and load balancer replacement) - Custom Pages (modernized error response handling) - Let's Encrypt HTTP-01 challenge automation in API v4 - Data Stream workload association replacing domain-based configuration This ensures users at any migration stage have clear, accurate documentation for their preferred interface while maintaining technical accuracy across all endpoints and authentication methods. 🤖 Powered by AI
…cal user guides This commit implements the complete API v4 rollout documentation structure across all critical user journeys, supporting both legacy (API v3/Domains) and new (API v4/Workloads) interfaces during the migration period. Key changes: - Added Apiv4Rollout component and 4-tab structure (Console-Workloads, Console-Domains, API v4, API v3) to 26+ guides - Implemented Workloads interface support for mTLS, certificates, cache settings, and error responses - Added Edge Connectors documentation replacing Origins and Load Balancers - Implemented Custom Pages replacing Error Responses with proper 3-tab structure - Added comprehensive API v4 endpoints with proper authentication and request bodies - Verified all API v3 endpoints use correct base URL (api.azionapi.net) and headers - Fixed endpoint error in cache-settings.mdx during final sweep - Added critical operation guides: clone, delete, and personal-token management - Maintained bilingual consistency across EN/PT-BR documentation Architectural concepts covered: - Workloads (aggregated TLS/mTLS configuration replacing individual domain management) - Edge Connectors (unified origin and load balancer replacement) - Custom Pages (modernized error response handling) - Let's Encrypt HTTP-01 challenge automation in API v4 - Data Stream workload association replacing domain-based configuration This ensures users at any migration stage have clear, accurate documentation for their preferred interface while maintaining technical accuracy across all endpoints and authentication methods. 🤖 Powered by AI
… errors This commit addresses systematic issues in the API v4 rollout documentation: ## Major Architectural Corrections: - Fix Cache Settings location: remains under Edge Application, not Workloads - Fix Rules Engine location: remains under Edge Application, not Workloads - Fix Let's Encrypt configuration: done through workload interface, not dropdown - Correct Edge Connector types: use "http" instead of fabricated "origin" type ## API Endpoint Corrections: - Remove fabricated API v4 domains endpoints (v4 uses workloads only) - Remove non-existent edge application clone endpoints (v3/v4) - Remove fabricated template deployment endpoints - Fix Edge SQL/Storage: v4-only products, remove v3 references ## MDX Syntax Fixes: - Fix malformed Fragment tags causing build failures - Correct host variable escaping in code blocks - Remove extra closing Fragment tags ## Files Modified: - 21 documentation files across EN/PT-BR - Focus on build-journey, guides, and reference sections - Systematic corrections based on actual v4 architecture 🤖 Powered by AI
…tency ## Architectural Corrections: - Remove incorrect guidance about using "Domains interface" for edge application cloning - Fix edge application cloning to direct users to Edge Application interface - Correct Edge Connector type from "Origin" to "HTTP" type in PT-BR ## EN/PT-BR Consistency: - Add tab structure to PT-BR clone guide to match EN version - Ensure consistent messaging across both languages - Add API v4 rollout snippets and migration guidance ## Files Modified: - EN: ea-clone-edge-application.mdx - Fixed incorrect architectural guidance - PT-BR: multiple-origins.mdx - Fixed Edge Connector types - PT-BR: ea-clone-edge-application.mdx - Added equivalent structure 🤖 Powered by AI
mrmessa
force-pushed
the
v4-mrm-updates
branch
from
27ed85c to
defc248
Compare
mrmessa
force-pushed
the
v4-mrm-updates
branch
2 times, most recently
from
265a04d to
3f11836
Compare
Keep corrected Edge Connector types (http not origin), proper Edge Application interface guidance for cloning, Cache Settings under Edge Applications, and accurate Let's Encrypt configuration through workload interface. 🤖 Powered by AI
mrmessa
force-pushed
the
v4-mrm-updates
branch
from
3f11836 to
82da28b
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This commit implements the complete API v4 rollout documentation structure across all critical user journeys, supporting both legacy (API v3/Domains) and new (API v4/Workloads) interfaces during the migration period.
Key changes:
Architectural concepts covered:
This ensures users at any migration stage have clear, accurate documentation for their preferred interface while maintaining technical accuracy across all endpoints and authentication methods.
🤖 Powered by AI