Skip to content

docs: drop NOT EXPOSED stubs from API7 EE spec#40

Merged
shreemaan-abhishek merged 2 commits into
masterfrom
docs-purge-stale-references
May 26, 2026
Merged

docs: drop NOT EXPOSED stubs from API7 EE spec#40
shreemaan-abhishek merged 2 commits into
masterfrom
docs-purge-stale-references

Conversation

@shreemaan-abhishek
Copy link
Copy Markdown
Contributor

@shreemaan-abhishek shreemaan-abhishek commented May 26, 2026

Summary

Sweeps docs/api7ee-api-spec.md of 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:

  • All nodes: examples across docs/ and skills/ already use the API7 EE array-of-objects format; no map-style "backend:8080": 1 entries remain.
  • docs/ga-test-plan.md references these commands and top-level YAML sections as expected-failure validation criteria — kept as-is.
  • docs/ga-test-report.md is a frozen 2026-05-14 snapshot; left untouched.
  • docs/user-guide/upstream.md and docs/user-guide/declarative-config.md already document the inline-only model with explicit warnings.
  • The "plugin-configured" wording in skills/a7-plugin-response-rewrite/SKILL.md refers to the body field set by the plugin, not the removed plugin-config resource.

Closes #27.

Test plan

  • make validate-skillsValidated 40 skills
  • make test-skillsok 5.833s

Summary by CodeRabbit

  • Documentation
    • Updated API specification to reflect current runtime/admin resource endpoints and standardized per-resource entries
    • Rewrote the resource types reference table with streamlined columns for clearer lookup
    • Removed references to legacy or non-exposed resources to reduce confusion
    • Clarified supported resource list for Gateway/runtime operations and improved consistency of descriptions

Review Change Stack

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.
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 26, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: d04651d4-e042-4b21-9c8d-13bc9cdc30e5

📥 Commits

Reviewing files that changed from the base of the PR and between bb0a49b and 6e4de67.

📒 Files selected for processing (1)
  • docs/api7ee-api-spec.md

📝 Walkthrough

Walkthrough

The 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 /apisix/admin. The "Summary of Resource Types" table is simplified to list only active resource types with Resource, Prefix, Identifier, and Scope columns, removing previously documented but non-exposed endpoints.

Changes

API Specification Documentation Refresh

Layer / File(s) Summary
Remove Service Template from control-plane list
docs/api7ee-api-spec.md
Removes the control-plane documentation section for Service Template so the control-plane resources list proceeds directly to runtime resources.
Runtime Resource Endpoint and Summary Table Update
docs/api7ee-api-spec.md
The /apisix/admin runtime API resource section expands per-resource method and field descriptions for Route, Service, Consumer, SSL, Global Rule, Stream Route, Plugin Metadata, Credential, Secret, Proto, and Plugin. The "Summary of Resource Types" table is rewritten to use Resource/Prefix/Identifier/Scope columns only, removing the Status column and rows for non-exposed resource types (Upstream, Plugin Config, Consumer Group).

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes


Important

Pre-merge checks failed

Please resolve all errors before merging. Addressing warnings is optional.

❌ Failed checks (1 error)

Check name Status Explanation Resolution
Security Check ❌ Error CRITICAL: SSL export exposes unredacted TLS private keys. RedactSSL() used in get/list/create/update but not in export's stripTimestamps(). Replace stripTimestamps() in ssl/export/export.go line 91 with api.RedactSSLs(items) to match redaction in other ssl commands.
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately captures the main change: removing documentation stubs for non-exposed API7 EE resources from the spec document.
Linked Issues check ✅ Passed The PR addresses all coding requirements from issue #27: removes stale references to non-exposed resources, updates the API spec documentation, and validates changes with make validate-skills and make test-skills.
Out of Scope Changes check ✅ Passed All changes are within scope—the PR modifies only docs/api7ee-api-spec.md to remove documentation stubs for non-exposed resources as specified in issue #27.
E2e Test Quality Review ✅ Passed PR is documentation-only with no E2E tests to review; E2E Test Quality Review check is not applicable to documentation changes.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs-purge-stale-references

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

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

📥 Commits

Reviewing files that changed from the base of the PR and between ac31b9d and bb0a49b.

📒 Files selected for processing (1)
  • docs/api7ee-api-spec.md

Comment thread docs/api7ee-api-spec.md Outdated
Comment thread docs/api7ee-api-spec.md Outdated
- 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.
@shreemaan-abhishek shreemaan-abhishek merged commit 3506fbd into master May 26, 2026
5 of 6 checks passed
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.

Purge stale docs and skills examples

1 participant