[codex] Add portal management OpenAPI contracts#28
Conversation
|
Important Review skippedToo many files! This PR contains 293 files, which is 143 over the limit of 150. To get a review, narrow the scope: ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (293)
You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ 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. Comment |
|
Thanks for checking this PR. The large diff is expected here because this is a spec-first OpenAPI update and the generated clients/servers are committed for Java, Spring Boot 2, Python, TypeScript, and Rust. The hand-authored part is primarily the OpenAPI contract plus generator compatibility adjustments; the rest is generated output. I validated the generated artifacts and compatibility locally with:
Given the generated SDK size, I do not plan to split the generated language artifacts out of this contract PR. |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 6823047212
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| summary: 获取当前Portal用户(new added) | ||
| operationId: getCurrentUser | ||
| deprecated: false | ||
| description: GET /openapi/v1/user | ||
| tags: |
There was a problem hiding this comment.
Override token auth on portal-session operations
This operation is documented as "Portal用户登录态" but inherits the top-level ApiKeyAuth requirement because no per-operation security override is defined. That makes the contract self-contradictory (session-only semantics vs token-required auth) and drives generated clients/docs toward the wrong auth flow for these new Portal endpoints. Add an explicit operation-level security definition (for example security: [] or a cookie/session scheme) for the Portal session APIs so callers are not forced into Authorization-token auth.
Useful? React with 👍 / 👎.
Summary
OpenUserDTOfor the remaining Apollo Portal migration surface.v0.3.4spec.Compatibility
v0.3.3; the local compatibility check passed for 97 operations and 40 schemas.Tests
./generate.sh(cd java-client && mvn -q -DskipTests package)(cd spring-boot2 && mvn -q -DskipTests package)python3 -m compileall -q python/apollo_openapi python/testtyposv0.3.3./mvnw -Dapollo.openapi.spec.url=/Users/jason/git/mine/apollo-openapi/apollo-openapi.yaml clean test.github/workflows/portal-ui-e2e.yml: 19 passed