Skip to content

feat: added project api spec for list and patch - #462

Merged
IAM-marco merged 25 commits into
mainfrom
feat/project-api-spec
Jul 9, 2026
Merged

feat: added project api spec for list and patch#462
IAM-marco merged 25 commits into
mainfrom
feat/project-api-spec

Conversation

@wim07101993

@wim07101993 wim07101993 commented Jul 6, 2026

Copy link
Copy Markdown
Member

Summary

  • Added POST /projects/query and PATCH /projects/{id} endpoints
  • Updated request/response models for project endpoints

Validation

  • go generate ./...
  • go test ./...
  • go test -tags postgres_integration ./...
  • openapi lint ./openapi/openapi-spec.yaml

Release notes / changeset

  • Changeset: .changeset/add-get-patch-project-endpoints.md - Added GET /projects and PATCH /projects/{id} endpoints

Notes

Copilot AI review requested due to automatic review settings July 6, 2026 11:15
@vercel

vercel Bot commented Jul 6, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
nextgen Ready Ready Preview, Comment Jul 9, 2026 3:31pm
nextgen-docs Ready Ready Preview, Comment Jul 9, 2026 3:31pm
nextgen-mock-zitadel Ready Ready Preview, Comment Jul 9, 2026 3:31pm

Request Review

@vercel

vercel Bot commented Jul 6, 2026

Copy link
Copy Markdown

@wim07101993 must be a member of the zitadel team on Vercel to deploy.
- Click here to add @wim07101993 to the team.
- If you initiated this build, request access.
- If you're already a member of the zitadel team, make sure that your Vercel account is connected to your GitHub account.

Learn more about collaboration on Vercel and other options here.

@github-actions

github-actions Bot commented Jul 6, 2026

Copy link
Copy Markdown
Contributor

🦋 Changeset detected

Latest commit: 73744a6

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 19 packages
Name Type
@zitadel/server Minor
@zitadel/cli Minor
@zitadel/server-linux-x64 Minor
@zitadel/server-linux-arm64 Minor
@zitadel/server-darwin-x64 Minor
@zitadel/server-darwin-arm64 Minor
@zitadel/server-win32-x64 Minor
@zitadel/api Minor
@zitadel/config Minor
@zitadel/components Minor
@zitadel/sdk-core Minor
@zitadel/sdk-next Minor
@zitadel/sdk-nuxt Minor
@zitadel/sdk-react Minor
@zitadel/sdk-vue Minor
@zitadel/sdk-angular Minor
@zitadel/sdk-solid Minor
@zitadel/sdk-svelte Minor
@zitadel/sdk-qwik Minor

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

@wim07101993 wim07101993 linked an issue Jul 6, 2026 that may be closed by this pull request

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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 via limit + page_token) and PATCH /projects/{project_id} to the OpenAPI spec.
  • Updated project request/response schemas to include name, and introduced a list-projects-response schema.
  • 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.

Comment thread api/openapi/security/oauth2.yaml
Comment thread api/openapi/security/oauth2.yaml
Comment thread api/openapi/endpoints/projects/methods.yaml Outdated
Comment thread api/openapi/endpoints/projects/methods.yaml Outdated
Comment thread api/openapi/endpoints/projects/methods.yaml Outdated
Comment thread api/openapi/endpoints/projects/get-project-response.yaml
Comment thread api/openapi/endpoints/projects/by_id/patch-project-request.yaml Outdated

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 17 out of 34 changed files in this pull request and generated 10 comments.

Comment thread api/openapi/openapi-spec.yaml Outdated
Comment thread api/openapi/endpoints/projects/query/methods.yaml
Comment thread api/openapi/endpoints/projects/by_id/methods.yaml Outdated
Comment thread api/openapi/components/parameters/sort-direction.yaml Outdated
Comment thread api/openapi/components/schemas/sort-direction.yaml
Comment thread api/openapi/endpoints/projects/by_id/patch-project-request.yaml
Comment thread api/openapi/endpoints/projects/query/query-projects-request.yaml Outdated
Comment thread api/openapi/endpoints/projects/query/query-projects-request.yaml
Comment thread api/openapi/components/schemas/filter-operation.yaml
Comment thread api/openapi/endpoints/projects/query/filter-field.yaml Outdated

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 22 out of 39 changed files in this pull request and generated 7 comments.

Comment thread api/openapi/endpoints/projects/query/methods.yaml
Comment thread api/openapi/endpoints/projects/query/methods.yaml
Comment thread api/openapi/endpoints/projects/query/query-projects-request.yaml Outdated
Comment thread api/openapi/endpoints/projects/query/filter-field.yaml Outdated
Comment thread api/openapi/components/parameters/sort-direction.yaml Outdated
Comment thread apps/cli/tests/unit/commands/setup/index.test.ts
Comment thread apps/cli/tests/unit/commands/setup.test.ts
@fforootd
fforootd force-pushed the feat/project-api-spec branch from d9bbaa3 to 09fd663 Compare July 7, 2026 14:27
@vercel
vercel Bot temporarily deployed to Preview – nextgen-mock-zitadel July 7, 2026 14:27 Inactive
@vercel
vercel Bot temporarily deployed to Preview – nextgen-docs July 7, 2026 14:27 Inactive
@vercel

vercel Bot commented Jul 8, 2026

Copy link
Copy Markdown

@IAM-marco must be a member of the zitadel team on Vercel to deploy.
- Click here to add @IAM-marco to the team.
- If you initiated this build, request access.

Learn more about collaboration on Vercel and other options here.

@IAM-marco

Copy link
Copy Markdown
Contributor

Looks extremely good 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: ✅ Done

Development

Successfully merging this pull request may close these issues.

Project API A: API contract (OpenAPI)

5 participants