Add editor service documentation to the list of the APIs #359
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.
https://keboola.atlassian.net/browse/AJDA-1188
follow up to https://github.com/keboola/api-service/pull/73
Release Notes Plan:
Documentation update adding Editor API to the list of available Keboola APIs, including its regional endpoints across all supported cloud providers (AWS, GCP, Azure).
For Customer Communication:
Developers will now find Editor Service API documentation properly listed in the API overview page alongside other Keboola services. No functional changes to existing APIs or services.
Impact Analysis:
Zero impact on existing functionality - this is purely a documentation update that makes the Editor API visible to developers browsing the API reference page. Also includes cleanup of deprecated docker-compose version field.
Change Type:
Documentation enhancement - adding missing API service reference and updating service endpoint table.
Justification:
Editor Service has been deployed and operational but was missing from the developer documentation. This follows up on related api-service changes.
Deployment Plan:
Standard CI/CD pipeline deploys documentation updates automatically upon merge to main branch.
Rollback Plan:
Git revert to previous commit if documentation issues are discovered post-deployment.
Post Release:
Verify Editor API documentation links are accessible and correctly formatted on the live developers docs site.
Support Plan:
No support impact expected - documentation-only change with no API or service modifications.