Skip to content

feat(query-service-api-client): add refreshMetadataOnSuccess to submitQueryJob PHPDoc#481

Open
devin-ai-integration[bot] wants to merge 1 commit intomainfrom
devin/1774858804-add-refresh-metadata-on-success
Open

feat(query-service-api-client): add refreshMetadataOnSuccess to submitQueryJob PHPDoc#481
devin-ai-integration[bot] wants to merge 1 commit intomainfrom
devin/1774858804-add-refresh-metadata-on-success

Conversation

@devin-ai-integration
Copy link
Copy Markdown
Contributor

Summary

Adds refreshMetadataOnSuccess?: bool to the PHPDoc @param array shape for submitQueryJob() in the query-service-api-client library. This documents the new optional boolean field already supported by the Query Service backend (go-monorepo), which triggers workspace metadata refresh after successful query execution.

This is a documentation-only change — no runtime behavior is modified. The method passes the request body array through to the API as-is.

Review & Testing Checklist for Human

  • Verify the field name refreshMetadataOnSuccess and type bool match the backend API contract in go-monorepo/services/query/api/handlers/submit.go
  • Check if any existing callers of submitQueryJob in the codebase need to be updated to pass this field

Notes

  • This is part of a broader effort to add refreshMetadataOnSuccess across all Query Service SDKs (Python, JS, PHP, MCP server).
  • The backend already supports this field — see SubmitQueryJobRequest.RefreshMetadataOnSuccess in the go-monorepo query service.

Release Notes

Justification, description

Added refreshMetadataOnSuccess optional boolean to the submitQueryJob PHPDoc type hint, aligning the PHP client documentation with the backend API contract.

Plans for Customer Communication

N/A

Impact Analysis

PHPDoc-only change. No runtime behavior affected.

Deployment Plan

N/A

Rollback Plan

N/A

Post-Release Support Plan

N/A

Link to Devin session: https://app.devin.ai/sessions/f269ff38856946e6b8a0f3b6c84eab0b

…tQueryJob PHPDoc

Co-Authored-By: Martin Vasko <Matovidlo2@gmail.com>
@devin-ai-integration
Copy link
Copy Markdown
Contributor Author

devin-ai-integration Bot commented Mar 30, 2026

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

@Matovidlo Matovidlo marked this pull request as ready for review March 30, 2026 08:40
@Matovidlo Matovidlo requested a review from MiroCillik March 30, 2026 08:40
@Matovidlo
Copy link
Copy Markdown

@MiroCillik nevim ci tohle staci

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant