docs: drop NOT EXPOSED stubs from API7 EE spec#40
Conversation
Removes the Service Template, Upstream, Plugin Config, and Consumer Group placeholder sections from docs/api7ee-api-spec.md and the corresponding rows from the summary table. None of these have REST API endpoints in API7 EE, and the matching CLI commands have all been removed, so the stubs only added noise. Part of #27.
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughThe pull request updates the API specification documentation for API7 EE by removing references to unsupported control-plane resources (Service Template) and standardizing the runtime resource reference under ChangesAPI Specification Documentation Refresh
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Important Pre-merge checks failedPlease resolve all errors before merging. Addressing warnings is optional. ❌ Failed checks (1 error)
✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/api7ee-api-spec.md`:
- Around line 133-135: The markdown table rows for the identifier column contain
missing spaces before the closing pipe for the code cells (`plugin_name` and
`manager/id`), causing inconsistent rendering; update those table cells in the
table so each code cell is surrounded by spaces and followed by a space before
the `|` (e.g., change `` `plugin_name`| `` to `` `plugin_name` | `` and ``
`manager/id`| `` to `` `manager/id` | ``) to restore consistent table spacing
and readability.
- Around line 92-93: Update the Consumer methods entry so the PUT method
includes the resource identifier by changing `PUT` to `PUT /:username` in the
Consumer section (so clients know the endpoint shape); also fix the summary
table spacing by adding a space before the column separator for the `Plugin
Metadata` row (`plugin_name |`) and the `Secret` row (`manager/id |`) to make
the table formatting consistent.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 5fd6a9de-3a71-4450-b7ef-c16ddc67cc64
📒 Files selected for processing (1)
docs/api7ee-api-spec.md
- PUT on /apisix/admin/consumers requires :username (matches the client
in pkg/cmd/consumer/{create,update}).
- Add the missing space before the column separator on the Plugin
Metadata and Secret rows of the summary table.
Summary
Sweeps
docs/api7ee-api-spec.mdof the four placeholder sections for endpoints that aren't exposed by the API7 EE Admin API and whose matching CLI commands have all been removed:The summary table loses the same four rows and the now-uniform "Status" column. Runtime section numbers are re-sequenced to fill the gaps.
Scope notes
The rest of the audit found nothing else to change:
nodes:examples acrossdocs/andskills/already use the API7 EE array-of-objects format; no map-style"backend:8080": 1entries remain.docs/ga-test-plan.mdreferences these commands and top-level YAML sections as expected-failure validation criteria — kept as-is.docs/ga-test-report.mdis a frozen 2026-05-14 snapshot; left untouched.docs/user-guide/upstream.mdanddocs/user-guide/declarative-config.mdalready document the inline-only model with explicit warnings.skills/a7-plugin-response-rewrite/SKILL.mdrefers to the body field set by the plugin, not the removed plugin-config resource.Closes #27.
Test plan
make validate-skills→Validated 40 skillsmake test-skills→ok 5.833sSummary by CodeRabbit