Skip to content
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

Clean up proto naming #176

Closed
wants to merge 1 commit into from
Closed

Clean up proto naming #176

wants to merge 1 commit into from

Conversation

sbezverk
Copy link
Contributor

@sbezverk sbezverk commented Jan 25, 2018

Closes: #172 #173 #174

  • Don't use unsigned integers in proto
  • Change “ID” to “Id” in Method names
  • Every “noun” should have a message, so Volume should be a message

These are breaking changes from the 0.1 release.

@sbezverk
Copy link
Contributor Author

/assign @saad-ali

@saad-ali saad-ali changed the title Issues_172_173_174 Clean up proto naming Jan 31, 2018
csi.proto Outdated
@@ -413,7 +413,7 @@ message ListVolumesRequest {

message ListVolumesResponse {
message Entry {
VolumeInfo volume_info = 1;
Volume volume_info = 1;
Copy link
Member

Choose a reason for hiding this comment

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

volume_info -> volume?

@saad-ali
Copy link
Member

Minor change requested, otherwise, LGTM
Thanks @sbezverk

@sbezverk
Copy link
Contributor Author

@saad-ali thanks for catching that, fixed.

@sbezverk
Copy link
Contributor Author

@jieyu please review when you have a chance

Copy link
Member

@jieyu jieyu left a comment

Choose a reason for hiding this comment

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

The rest LGTM. Only one naming nits.

@@ -717,7 +717,7 @@ message ControllerPublishVolumeResponse {
// The SP specific information that will be passed to the Plugin in
// the subsequent `NodePublishVolume` call for the given volume.
// This information is opaque to the CO. This field is OPTIONAL.
map<string, string> publish_volume_info = 1;
map<string, string> publish_volume = 1;
Copy link
Member

Choose a reason for hiding this comment

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

I would actually rename this to publish_info. publish_volume sounds a bit weird.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yep, +1 for publish_info, done

Copy link
Member

@jdef jdef left a comment

Choose a reason for hiding this comment

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

All of our fields that used to be uintXX were typed that way because negative values aren't allowed. Now that they're converted to their sibling intXX type, I'm wondering if we need additional language regarding the treatment of negative values? It certainly adds validation code for plugins and COs implementing the spec because now they need to deal with possibly invalid, negative numbers.

@sbezverk
Copy link
Contributor Author

sbezverk commented Feb 1, 2018

Closing as the branch stoped accepting any changes. This PR addresses the same issues: #182

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.

4 participants