fix: update API docs for list projects endpoint #7707
Conversation
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
The GET /api/v1/projects endpoint documentation incorrectly referenced the full Project schema which includes environments, but the actual API only returns id, uuid, name, and description. This commit: - Adds a new ProjectListItem schema for the list endpoint - Updates the /projects endpoint to reference ProjectListItem - Updates the PHP OpenAPI annotation to match Fixes coollabsio#7702
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
The
GET /api/v1/projectsendpoint documentation incorrectly referenced the fullProjectschema which includesenvironments, but the actual API only returnsid,uuid,name, anddescription.Changes
ProjectListItemschema for the list endpoint/projectsendpoint to referenceProjectListItemRelated Issue
Fixes #7702