feat: allow users to specify shipment resource ID #188
Conversation
This file contains 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
m4mm4r
reviewed
Sep 26, 2023
Comment on lines
225
to
237
| // A user specified ID for the shipment resource. This must adhere to these rules: | ||
| // 1. Must only contain upper-case letters, lower-case letters, numbers 0-9 and a hyphen '-'. | ||
| // 2. Must have a length between 4 and 63 characters. | ||
| // 3. Must start with a letter or a number. | ||
| // 4. Must end with a letter or a number. | ||
| // The following regular expression can be used to validate these rules: | ||
| // ^[a-zA-Z0-9]([a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?$ | ||
| string shipment_id = 3 [(google.api.field_behavior) = OPTIONAL]; | ||
|
|
There was a problem hiding this comment.
Should we maybe add to the description that a random value will be generated if not provided? Read something similar in some google APIs like:
https://github.com/googleapis/google-cloud-go/blob/aiplatform/v1.50.0/aiplatform/apiv1/aiplatformpb/metadata_service.pb.go#L481-L501
There was a problem hiding this comment.
Good call, I've updated and also tried made it clear that it must be unique within a space. Also added expected format for resource names similar to the service you linked :)
m4mm4r
approved these changes
Sep 26, 2023
DavyJ0nes
force-pushed
the
allow-shipment_id-to-be-set-on-request
branch
3 times, most recently
from
a1671c5
to
88d1fe9
Compare
This makes the API more declarative and adherant to the following AIP: https://google.aip.dev/122#resource-id-segments
DavyJ0nes
force-pushed
the
allow-shipment_id-to-be-set-on-request
branch
from
88d1fe9
to
e63856c
Compare
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.
This makes the API more declarative and adherant to the following AIP:
https://google.aip.dev/122#resource-id-segments