Skip to content

Commit bc2cb20

Browse files
authored
Merge pull request #7063 from ninjaprox/patch-1
Correct `generateName` doc when in conflict
2 parents 84286d6 + 1bf6d42 commit bc2cb20

File tree

1 file changed

+9
-11
lines changed

1 file changed

+9
-11
lines changed

contributors/devel/sig-architecture/api-conventions.md

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -724,17 +724,15 @@ same name as an existing object in the system. See
724724

725725
Names generated by the system may be requested using `metadata.generateName`.
726726
GenerateName indicates that the name should be made unique by the server prior
727-
to persisting it. A non-empty value for the field indicates the name will be
728-
made unique (and the name returned to the client will be different than the name
729-
passed). The value of this field will be combined with a unique suffix on the
730-
server if the Name field has not been provided. The provided value must be valid
731-
within the rules for Name, and may be truncated by the length of the suffix
732-
required to make the value unique on the server. If this field is specified, and
733-
Name is not present, the server will NOT return a 409 if the generated name
734-
exists - instead, it will either return 201 Created or 504 with Reason
735-
`ServerTimeout` indicating a unique name could not be found in the time
736-
allotted, and the client should retry (optionally after the time indicated in
737-
the Retry-After header).
727+
to persisting it. A non-empty value for the field indicates the server should
728+
attempt to make the name unique (and the name returned to the client will be
729+
different than the name passed). The value of this field will be combined with a
730+
random suffix on the server if the Name field has not been provided. The
731+
provided value must be valid within the rules for Name, and may be truncated by
732+
the length of the suffix. If this field is specified, and Name is not present,
733+
the server will return a 409 with Reason `AlreadyExists` if the generated name
734+
exists, and the client should retry (after waiting at least the amount of time
735+
indicated in the Retry-After header, if it is present).
738736

739737
## Optional vs. Required
740738

0 commit comments

Comments
 (0)