Skip to content

Commit 7df1ac6

Browse files
authored
spec: clarify expectations for Identity RPCs (#72)
1 parent 4c54118 commit 7df1ac6

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

spec.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -289,17 +289,21 @@ The error code `OPERATION_PENDING_FOR_VOLUME` may be returned by the plugin in t
289289

290290
#### `GetSupportedVersions`
291291

292-
A Plugin SHALL reply with a list of supported CSI versions. The initial version of the CSI specification is 0.1.0 (in *major.minor.patch* format).
292+
A Plugin SHALL reply with a list of supported CSI versions.
293+
The initial version of the CSI specification is 0.1.0 (in *major.minor.patch* format).
293294
A CO MAY execute plugin RPCs in the manner prescribed by any such supported CSI version.
294295
The versions returned by this call are orthogonal to any vendor-specific version metadata (see `vendor_version` in `GetPluginInfoResponse`).
295296

297+
NOTE: Changes to this RPC should be approached very conservatively since the request/response protobufs here are critical for proper client-server version negotiation.
298+
Future changes to this RPC MUST **guarantee** backwards compatibility.
299+
296300
```protobuf
297301
message GetSupportedVersionsRequest {
298302
}
299303
300304
message GetSupportedVersionsResponse {
301305
message Result {
302-
// All the versions that the Plugin supports. This field is
306+
// All the CSI versions that the Plugin supports. This field is
303307
// REQUIRED.
304308
repeated Version supported_versions = 1;
305309
}
@@ -311,7 +315,8 @@ message GetSupportedVersionsResponse {
311315
}
312316
}
313317
314-
// Specifies the version in Semantic Version 2.0 format.
318+
// Specifies a version in Semantic Version 2.0 format.
319+
// (http://semver.org/spec/v2.0.0.html)
315320
message Version {
316321
uint32 major = 1; // This field is REQUIRED.
317322
uint32 minor = 2; // This field is REQUIRED.

0 commit comments

Comments
 (0)