这是indexloc提供的服务,不要输入任何密码
Skip to content

Make metadata required in Vertex AI Index resource #14382

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

jaylonmcshan19-x
Copy link

@jaylonmcshan19-x jaylonmcshan19-x commented Jun 26, 2025

This PR updates the Vertex AI Index resource schema to make the metadata field required. This aligns with the expectations of the Vertex AI API

Release Note Template for Downstream PRs (will be copied)

See Write release notes for guidance.

vertexai: make the `metadata` field required in `google_vertex_ai_index`

Copy link

google-cla bot commented Jun 26, 2025

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

View this failed invocation of the CLA check for more information.

For the most up to date status, view the checks section at the bottom of the pull request.

@modular-magician modular-magician added the awaiting-approval Pull requests that need reviewer's approval to run presubmit tests label Jun 26, 2025
@jaylonmcshan19-x jaylonmcshan19-x marked this pull request as ready for review June 30, 2025 22:21
@github-actions github-actions bot requested a review from trodge June 30, 2025 22:22
Copy link

Hello! I am a robot. Tests will require approval from a repository maintainer to run.

Googlers: For automatic test runs see go/terraform-auto-test-runs.

@trodge, a repository maintainer, has been assigned to review your changes. If you have not received review feedback within 2 business days, please leave a comment on this PR asking them to take a look.

You can help make sure that review is quick by doing a self-review and by running impacted tests locally.

@modular-magician modular-magician added service/aiplatform-matching-engine and removed awaiting-approval Pull requests that need reviewer's approval to run presubmit tests labels Jun 30, 2025
@modular-magician
Copy link
Collaborator

Hi there, I'm the Modular magician. I've detected the following information about your changes:

Diff report

Your PR generated some diffs in downstreams - here they are.

google provider: Diff ( 2 files changed, 52 insertions(+), 52 deletions(-))
google-beta provider: Diff ( 2 files changed, 52 insertions(+), 52 deletions(-))

Breaking Change(s) Detected

The following breaking change(s) were detected within your pull request.

  • Field metadata changed from optional to required on google_vertex_ai_index - reference

If you believe this detection to be incorrect please raise the concern with your reviewer.
If you intend to make this change you will need to wait for a major release window.
An override-breaking-change label can be added to allow merging.

@trodge
Copy link
Contributor

trodge commented Jun 30, 2025

Thanks for the contribution.

Do we know that the API will never accept an empty value for this field?

Also, please replace

```release-note:REPLACEME

```

with

```release-note:breaking-change
vertexai: made the `metadata` field required in `google_vertex_ai_index`
```

in the description

@modular-magician
Copy link
Collaborator

Tests analytics

Total tests: 67
Passed tests: 64
Skipped tests: 3
Affected tests: 0

Click here to see the affected service packages
  • vertexai
🟢 All tests passed!

View the build log

@jaylonmcshan19-x
Copy link
Author

Hi @trodge yes, the API returns a 400 response from the API, stating metadata is missing. When it is omitted, or empty!

Copy link

github-actions bot commented Jul 3, 2025

@trodge This PR has been waiting for review for 3 weekdays. Please take a look! Use the label disable-review-reminders to disable these notifications.

Copy link

github-actions bot commented Jul 7, 2025

@GoogleCloudPlatform/terraform-team @trodge This PR has been waiting for review for 1 week. Please take a look! Use the label disable-review-reminders to disable these notifications.

@jaylonmcshan19-x
Copy link
Author

Hi @trodge, just checking in — is there anything else you'd like me to address in this PR before it can be approved? Let me know if any further changes are needed!

Copy link

@GoogleCloudPlatform/terraform-team @trodge This PR has been waiting for review for 2 weeks. Please take a look! Use the label disable-review-reminders to disable these notifications.

@trodge
Copy link
Contributor

trodge commented Jul 17, 2025

Sorry for the delay,

I asked the API team internally about this issue and they indicated that they would prefer to keep the terraform field aligned with the API field in not being required in the specification, even though there is currently no way to create the resource without it. I suggested making a description change in the API spec to indicate that the field is currently required, and we could safely do that here in the mean time.

Copy link

@GoogleCloudPlatform/terraform-team @trodge This PR has been waiting for review for 3 weeks. Please take a look! Use the label disable-review-reminders to disable these notifications.

@iBrandyJackson
Copy link

@trodge any latest update on this to share? This is a HashiCorp support team reported issue. Please advise on best next steps to get this resolved. Thanks!

@trodge
Copy link
Contributor

trodge commented Jul 24, 2025

@trodge any latest update on this to share? This is a HashiCorp support team reported issue. Please advise on best next steps to get this resolved. Thanks!

At this point, I think the next step is to note the issue in the field's description without making it required, which would be a breaking change.

Copy link
Contributor

@trodge trodge left a comment

Choose a reason for hiding this comment

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

Let's instead update the description and leave the field optional.

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

Successfully merging this pull request may close these issues.

4 participants