docs: align user guides with service routes#10
Conversation
|
Warning Rate limit exceeded
To keep reviews running without waiting, you can enable usage-based add-on for your organization. This allows additional reviews beyond the hourly cap. Account admins can enable it under billing. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (4)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Review rate limit: 0/1 reviews remaining, refill in 55 minutes and 47 seconds.Comment |
There was a problem hiding this comment.
Pull request overview
Updates CLI documentation to reflect the recommended workflow of creating a service first and then creating routes that reference it, aligning examples with current API7 EE route/service expectations.
Changes:
- Reworks route docs and getting-started to prefer
paths+service_id(service-first flow). - Updates examples to use upstream
nodesarray format and documentsroute list --service-idusage. - Removes stale roadmap references and refreshes the “golden example” route schema snippet/output.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/user-guide/route.md | Updates route listing guidance and route payload examples to prefer paths + service_id. |
| docs/user-guide/getting-started.md | Switches the quickstart to create a service first, then create a route bound to that service; updates export example to services. |
| docs/roadmap.md | Removes/renames stale “portal” roadmap item and updates the PR-36 label. |
| docs/golden-example.md | Refreshes the documented Route struct and example JSON to use paths + service_id. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| Hosts []string `json:"hosts,omitempty"` | ||
| Priority int `json:"priority"` | ||
| Status int `json:"status"` | ||
| ServiceID string `json:"service_id,omitempty"` |
| | `methods` | array | HTTP methods allowed (e.g., ["GET", "POST"]) | | ||
| | `upstream` | object | Inline upstream configuration | | ||
| | `upstream_id` | string | Reference to an existing upstream ID | | ||
| | `service_id` | string | Reference to the service that owns the upstream configuration | |
There was a problem hiding this comment.
Pull request overview
Updates CLI documentation to reflect the current API7 EE runtime workflow where routes are typically managed in the context of services, and refreshes examples to use current route/service payload fields.
Changes:
- Update route and getting-started guides to create a service before creating routes, and prefer
paths+service_id. - Document
a7 route list --service-idand remove stale/unsupported flags and roadmap references. - Refresh the “golden example” route schema and example response to include
paths/service_id.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| docs/user-guide/route.md | Updates route listing/create docs to emphasize service scoping and paths + service_id. |
| docs/user-guide/getting-started.md | Reworks tutorial to create a service first, then a route referencing it; updates export example. |
| docs/roadmap.md | Removes a7 portal mention and adjusts PR-36 roadmap wording. |
| docs/golden-example.md | Updates example Route schema/printing and example JSON to reflect current route fields. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| Lists routes in the specified gateway group. In current API7 EE environments, | ||
| routes are scoped by service, so prefer passing `--service-id` when listing | ||
| routes for a known service. |
| fmt.Fprintln(w, "ID\tNAME\tURIS\tSTATUS\tSERVICE_ID\tUPSTREAM_ID") | ||
|
|
||
| for _, r := range routes { | ||
| uris := strings.Join(r.URIs, ",") | ||
| status := fmt.Sprintf("%d", r.Status) | ||
| upstream := "N/A" | ||
| if r.UpstreamID != nil { | ||
| upstream = *r.UpstreamID | ||
| service := r.ServiceID |
| "paths": ["/api/v1/users"], | ||
| "methods": ["GET", "POST"], | ||
| "status": 1, | ||
| "upstream_id": "u1" | ||
| "service_id": "svc-users" |
Summary
pathsplusservice_id, and documentroute list --service-idfor current EE route listing.a7 portalroadmap reference and replace upstream export example with service export.Validation
go test ./...git diff --check