Open
Conversation
There was a problem hiding this comment.
Pull request overview
This PR updates API v2 OpenAPI documentation generation and helper/model metadata to improve the produced schema and introduces CI linting for the OpenAPI output.
Changes:
- Restrict
LogEntryAPIto GET-only viagetAvailableMethods(). - Adjust several helper
getResponse()implementations to better describe response shapes/types for OpenAPI generation. - Update OpenAPI schema generation utilities/routes and add a GitHub Actions workflow to lint the generated OpenAPI schema with Spectral.
Reviewed changes
Copilot reviewed 10 out of 10 changed files in this pull request and generated 9 comments.
Show a summary per file
| File | Description |
|---|---|
| src/inc/apiv2/model/LogEntryAPI.php | Limits allowed methods to GET to align behavior and docs. |
| src/inc/apiv2/helper/ImportFileHelperAPI.php | Changes helper response description returned by getResponse(). |
| src/inc/apiv2/helper/GetUserPermissionHelperAPI.php | Updates getResponse() to reference a model schema. |
| src/inc/apiv2/helper/GetCracksOfTaskHelper.php | Updates getResponse() to reference a model schema. |
| src/inc/apiv2/helper/GetBestTasksAgent.php | Updates getResponse() to reference a model schema. |
| src/inc/apiv2/helper/GetAccessGroupsHelperAPI.php | Updates getResponse() to reference a model schema. |
| src/inc/apiv2/helper/CurrentUserHelperAPI.php | Updates getResponse() value used by OpenAPI generation. |
| src/inc/apiv2/common/openAPISchema.routes.php | Substantial changes to OpenAPI path/schema generation and hardcoded importFile docs. |
| src/inc/apiv2/common/OpenAPISchemaUtils.php | Refactors relationship/expandable schema helpers and improves example-to-schema mapping. |
| .github/workflows/openapi-lint.yml | Adds CI job to lint the generated OpenAPI schema via Spectral. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
added 2 commits
March 26, 2026 08:14
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.
No description provided.