Skip to content

Commit c88bed5

Browse files
author
James DeFelice
authored
Update spec.md
* also, one-sentence-per-line for non-code sections.
1 parent f946367 commit c88bed5

File tree

1 file changed

+8
-14
lines changed

1 file changed

+8
-14
lines changed

spec.md

Lines changed: 8 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -393,24 +393,18 @@ These limits apply for messages generated by both COs and plugins.
393393
* A `repeated` or `map` field listed as `REQUIRED` MUST contain at least 1 element.
394394
* A field noted as `OPTIONAL` MAY be specified and the specification SHALL clearly define expected behavior for the default, zero-value of such fields.
395395

396-
Scalar fields, even REQUIRED ones, will be defaulted if not specified, and any field set to the defaul value will not be serialized over the wire as per [proto3](https://developers.google.com/protocol-buffers/docs/proto3#default).
396+
Scalar fields, even REQUIRED ones, will be defaulted if not specified and any field set to the default value will not be serialized over the wire as per [proto3](https://developers.google.com/protocol-buffers/docs/proto3#default).
397397

398398
#### Timeouts
399399

400400
Any of the RPCs defined in this spec MAY timeout and MAY be retried.
401-
The CO MAY chooses the maximum time it is willing to wait for a call,
402-
how long it waits between retries, and how many time it retries (these
403-
values are not negotiated between plugin and CO).
404-
405-
Idempotency requirements ensure that a retried call with the same fields
406-
continues where it left off when retried. The only way to cancel a call
407-
is to issue a "negation" call if one exists (for example, issue a
408-
`ControllerUnpublishVolume` call to cancel a pending
409-
`ControllerPublishVolume` operation, etc.). In some cases, a CO MAY not
410-
be able to cancel a pending operation, because it depends on the result
411-
of the pending operation in order to execute the "negation" call (for
412-
example, if a `CreateVolume` call never completes, a CO may not have the
413-
`volume_id` to call `DeleteVolume` with).
401+
The CO MAY chooses the maximum time it is willing to wait for a call, how long it waits between retries, and how many time it retries (these values are not negotiated between plugin and CO).
402+
403+
Idempotency requirements ensure that a retried call with the same fields continues where it left off when retried.
404+
The only way to cancel a call is to issue a "negation" call if one exists.
405+
For example, issue a `ControllerUnpublishVolume` call to cancel a pending `ControllerPublishVolume` operation, etc.
406+
In some cases, a CO MAY NOT be able to cancel a pending operation because it depends on the result of the pending operation in order to execute the "negation" call.
407+
For example, if a `CreateVolume` call never completes then a CO may not have the `volume_id` to call `DeleteVolume` with.
414408

415409
### Error Scheme
416410

0 commit comments

Comments
 (0)