feat: added project api spec for list and patch - #462
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
@wim07101993 must be a member of the zitadel team on Vercel to deploy. Learn more about collaboration on Vercel and other options here. |
🦋 Changeset detectedLatest commit: 73744a6 The changes in this PR will be included in the next version bump. This PR includes changesets to release 19 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
There was a problem hiding this comment.
Pull request overview
This PR extends the Project API OpenAPI contract to include project listing and partial updates, and regenerates the Go OpenAPI types/handlers to match.
Changes:
- Added
GET /projects(cursor-pagination scaffolding vialimit+page_token) andPATCH /projects/{project_id}to the OpenAPI spec. - Updated project request/response schemas to include
name, and introduced alist-projects-responseschema. - Regenerated
api/generated/*to include the new operations, parameters, schemas, and encoders/decoders; added a changeset for@zitadel/server.
Reviewed changes
Copilot reviewed 9 out of 25 changed files in this pull request and generated 7 comments.
Show a summary per file
| File | Description |
|---|---|
| api/openapi/security/oauth2.yaml | Adds project-related OAuth2 scopes (needs consistent naming with endpoint security). |
| api/openapi/endpoints/projects/methods.yaml | Adds GET /projects operation with pagination parameters and responses. |
| api/openapi/endpoints/projects/list-projects-response.yaml | Defines paginated list response shape for projects. |
| api/openapi/endpoints/projects/get-project-response.yaml | Extends project read model with name and previewOrigins. |
| api/openapi/endpoints/projects/create-project-response.yaml | Extends create response to include name. |
| api/openapi/endpoints/projects/create-project-request.yaml | Extends create request to require name. |
| api/openapi/endpoints/projects/by_id/patch-project-request.yaml | Introduces PATCH request schema for project updates. |
| api/openapi/endpoints/projects/by_id/methods.yaml | Adds PATCH /projects/{project_id} operation definition. |
| api/generated/oas_validators_gen.go | Adds validators for newly generated request/response types. |
| api/generated/oas_unimplemented_gen.go | Adds unimplemented handler stubs for the new operations. |
| api/generated/oas_server_gen.go | Extends handler interface with ListProjects/PatchProject. |
| api/generated/oas_security_gen.go | Adds scope mappings for the new operations. |
| api/generated/oas_schemas_gen.go | Adds/updates generated schema types for projects and list/patch operations. |
| api/generated/oas_router_gen.go | Routes GET /projects and PATCH /projects/{project_id}. |
| api/generated/oas_response_encoders_gen.go | Adds encoders for list/patch operation responses. |
| api/generated/oas_response_decoders_gen.go | Adds decoders for list/patch operation responses. |
| api/generated/oas_request_encoders_gen.go | Adds request encoder for PatchProject. |
| api/generated/oas_request_decoders_gen.go | Adds request decoder for PatchProject. |
| api/generated/oas_parameters_gen.go | Adds query/path parameter decoding for ListProjects/PatchProject. |
| api/generated/oas_operations_gen.go | Registers the new operation names. |
| api/generated/oas_json_gen.go | Adds JSON encode/decode for new/updated project types. |
| api/generated/oas_interfaces_gen.go | Adds response interfaces for the new operations. |
| api/generated/oas_handlers_gen.go | Adds server handler wiring for ListProjects/PatchProject. |
| api/generated/oas_client_gen.go | Adds client methods for ListProjects/PatchProject. |
| .changeset/add-get-patch-project-endpoints.md | Declares a minor bump for @zitadel/server due to API surface changes. |
b169b80 to
d9bbaa3
Compare
d9bbaa3 to
09fd663
Compare
|
@IAM-marco must be a member of the zitadel team on Vercel to deploy. Learn more about collaboration on Vercel and other options here. |
|
Looks extremely good 👍 |
Summary
POST /projects/queryandPATCH /projects/{id}endpointsValidation
go generate ./...go test ./...go test -tags postgres_integration ./...openapi lint ./openapi/openapi-spec.yamlRelease notes / changeset
GET /projectsandPATCH /projects/{id}endpointsNotes