docs(api-spec): document route canonicalization behavior#2993
Merged
nighca merged 1 commit intogoplus:devfrom Apr 8, 2026
Merged
docs(api-spec): document route canonicalization behavior#2993nighca merged 1 commit intogoplus:devfrom
nighca merged 1 commit intogoplus:devfrom
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates the OpenAPI specification to support resource redirection and normalization for historical usernames and routes. It introduces 301 Moved Permanently and 409 Conflict responses across user, project, and release endpoints, along with new schemas for MovedResourceError and MovedResourceCanonical to provide canonical metadata. I have no feedback to provide.
aofei
added a commit
to aofei/fork.goplus.builder
that referenced
this pull request
Mar 27, 2026
Handle moved-resource responses from the backend so path-based writes retry once with the canonical route and body-derived create requests rewrite their route fields before retrying. Replace unresolved user, project, and editor routes with canonical backend values after loading so subsequent UI behavior uses canonical identifiers consistently. Updates goplus#2993 Signed-off-by: Aofei Sheng <aofei@aofeisheng.com>
aofei
added a commit
to aofei/fork.goplus.builder
that referenced
this pull request
Mar 27, 2026
Handle moved-resource responses from the backend so path-based writes retry once with the canonical route and body-derived create requests rewrite their route fields before retrying. Replace unresolved user, project, and editor routes with canonical backend values after loading so subsequent UI behavior uses canonical identifiers consistently. Updates goplus#2993 Signed-off-by: Aofei Sheng <aofei@aofeisheng.com>
aofei
force-pushed
the
route-canonicalization-api-spec
branch
from
5d36776 to
88efda3
Compare
aofei
added a commit
to aofei/fork.goplus.builder
that referenced
this pull request
Mar 31, 2026
Handle moved-resource responses from the backend without generic write retries, and retry updateProject once with the canonical route so saving existing projects still works after a project rename. Replace unresolved user, project, and editor routes with canonical backend values after loading so subsequent UI behavior uses canonical identifiers consistently. Updates goplus#2993 Signed-off-by: Aofei Sheng <aofei@aofeisheng.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the API specification to explicitly document the route canonicalization contract, including how historical routes/usernames are handled and how clients should interpret/resolve moved-resource responses.
Changes:
- Documented that several query parameters accept historical usernames/routes and are transparently normalized to canonical values.
- Added explicit moved-resource responses on affected endpoints (
301for canonical redirects and409with a canonical payload for non-idempotent operations/inputs). - Introduced reusable OpenAPI components for moved-resource responses and the
MovedResourceError/MovedResourceCanonicalschemas.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
![xgopilot[bot]](https://avatars.githubusercontent.com/in/1924301?s=60&v=4){kind=small}
Contributor
|
Good addition — the query-parameter normalization notes and reusable |
aofei
force-pushed
the
route-canonicalization-api-spec
branch
from
88efda3 to
db42b8e
Compare
aofei
added a commit
to aofei/fork.goplus.builder
that referenced
this pull request
Mar 31, 2026
Handle moved-resource responses from the backend without generic write retries, and retry updateProject once with the canonical route so saving existing projects still works after a project rename. Replace unresolved user, project, and editor routes with canonical backend values after loading so subsequent UI behavior uses canonical identifiers consistently. Updates goplus#2993 Signed-off-by: Aofei Sheng <aofei@aofeisheng.com>
aofei
added a commit
to aofei/fork.goplus.builder
that referenced
this pull request
Mar 31, 2026
Handle moved-resource responses from the backend without generic write retries, and retry updateProject once with the canonical route so saving existing projects still works after a project rename. Replace unresolved user, project, and editor routes with canonical backend values after loading so subsequent UI behavior uses canonical identifiers consistently. Updates goplus#2993 Signed-off-by: Aofei Sheng <aofei@aofeisheng.com>
aofei
force-pushed
the
route-canonicalization-api-spec
branch
from
db42b8e to
2267eea
Compare
Document the route canonicalization contract in `docs/openapi.yaml`, including moved-route responses and query normalization. Signed-off-by: Aofei Sheng <aofei@aofeisheng.com>
aofei
force-pushed
the
route-canonicalization-api-spec
branch
from
2267eea to
7311cde
Compare
aofei
added a commit
to aofei/fork.goplus.builder
that referenced
this pull request
Apr 2, 2026
Handle moved-resource responses from the backend without generic write retries, and retry updateProject once with the canonical route so saving existing projects still works after a project rename. Replace unresolved user, project, and editor routes with canonical backend values after loading so subsequent UI behavior uses canonical identifiers consistently. Updates goplus#2993 Signed-off-by: Aofei Sheng <aofei@aofeisheng.com>
nighca
approved these changes
Apr 8, 2026
aofei
added a commit
to aofei/fork.goplus.builder
that referenced
this pull request
Apr 9, 2026
Handle moved-resource responses from the backend without generic write retries, and retry updateProject once with the canonical route so saving existing projects still works after a project rename. Replace unresolved user, project, and editor routes with canonical backend values after loading so subsequent UI behavior uses canonical identifiers consistently. Updates goplus#2993 Signed-off-by: Aofei Sheng <aofei@aofeisheng.com>
aofei
added a commit
to aofei/fork.goplus.builder
that referenced
this pull request
Apr 9, 2026
Handle moved-resource responses from the backend without generic write retries, and retry updateProject once with the canonical route so saving existing projects still works after a project rename. Replace unresolved user, project, and editor routes with canonical backend values after loading so subsequent UI behavior uses canonical identifiers consistently. Updates goplus#2993 Signed-off-by: Aofei Sheng <aofei@aofeisheng.com>
aofei
added a commit
to aofei/fork.goplus.builder
that referenced
this pull request
Apr 9, 2026
Handle moved-resource responses from the backend without generic write retries, and retry updateProject once with the canonical route so saving existing projects still works after a project rename. Replace unresolved user, project, and editor routes with canonical backend values after loading so subsequent UI behavior uses canonical identifiers consistently. Updates goplus#2993 Signed-off-by: Aofei Sheng <aofei@aofeisheng.com>
aofei
added a commit
to aofei/fork.goplus.builder
that referenced
this pull request
Apr 9, 2026
Handle moved-resource responses from the backend without generic write retries, and retry updateProject once with the canonical route so saving existing projects still works after a project rename. Replace unresolved user, project, and editor routes with canonical backend values after loading so subsequent UI behavior uses canonical identifiers consistently. Updates goplus#2993 Signed-off-by: Aofei Sheng <aofei@aofeisheng.com>
aofei
added a commit
to aofei/fork.goplus.builder
that referenced
this pull request
Apr 9, 2026
Handle moved-resource responses from the backend without generic write retries, and retry updateProject once with the canonical route so saving existing projects still works after a project rename. Replace unresolved user, project, and editor routes with canonical backend values after loading so subsequent UI behavior uses canonical identifiers consistently. Updates goplus#2993 Signed-off-by: Aofei Sheng <aofei@aofeisheng.com>
aofei
added a commit
to aofei/fork.goplus.builder
that referenced
this pull request
Apr 9, 2026
Handle moved-resource responses from the backend without generic write retries, and retry updateProject once with the canonical route so saving existing projects still works after a project rename. Replace unresolved user, project, and editor routes with canonical backend values after loading so subsequent UI behavior uses canonical identifiers consistently. Updates goplus#2993 Signed-off-by: Aofei Sheng <aofei@aofeisheng.com>
aofei
added a commit
to aofei/fork.goplus.builder
that referenced
this pull request
Apr 9, 2026
Handle moved-resource responses from the backend without generic write retries, and retry updateProject once with the canonical route so saving existing projects still works after a project rename. Replace unresolved user, project, and editor routes with canonical backend values after loading so subsequent UI behavior uses canonical identifiers consistently. Updates goplus#2993 Signed-off-by: Aofei Sheng <aofei@aofeisheng.com>
aofei
added a commit
to aofei/fork.goplus.builder
that referenced
this pull request
Apr 9, 2026
Handle moved-resource responses from the backend without generic write retries, and retry updateProject once with the canonical route so saving existing projects still works after a project rename. Replace unresolved user, project, and editor routes with canonical backend values after loading so subsequent UI behavior uses canonical identifiers consistently. Updates goplus#2993 Signed-off-by: Aofei Sheng <aofei@aofeisheng.com>
aofei
added a commit
to aofei/fork.goplus.builder
that referenced
this pull request
Apr 9, 2026
Handle moved-resource responses from the backend without generic write retries, and retry updateProject once with the canonical route so saving existing projects still works after a project rename. Replace unresolved user, project, and editor routes with canonical backend values after loading so subsequent UI behavior uses canonical identifiers consistently. Updates goplus#2993 Signed-off-by: Aofei Sheng <aofei@aofeisheng.com>
aofei
added a commit
to aofei/fork.goplus.builder
that referenced
this pull request
Apr 10, 2026
Handle moved-resource responses from the backend without generic write retries, and retry updateProject once with the canonical route so saving existing projects still works after a project rename. Replace unresolved user, project, and editor routes with canonical backend values after loading so subsequent UI behavior uses canonical identifiers consistently. Updates goplus#2993 Signed-off-by: Aofei Sheng <aofei@aofeisheng.com>
nighca
pushed a commit
that referenced
this pull request
Apr 10, 2026
Handle moved-resource responses from the backend without generic write retries, and retry updateProject once with the canonical route so saving existing projects still works after a project rename. Replace unresolved user, project, and editor routes with canonical backend values after loading so subsequent UI behavior uses canonical identifiers consistently. Updates #2993 Signed-off-by: Aofei Sheng <aofei@aofeisheng.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Document the route canonicalization contract in
docs/openapi.yaml, including moved-route responses and query normalization.