Skip to content

Commit 00d7321

Browse files
committed
consolidate object ref guidance in api conventions
API conventions had two semi-duplicated sections for object references, with slightly different guidance. Consolidating guidance to point to the most recent guidance. Clarifying the naming recommendations for naming of lists of object references, as the guidance was not explicit.
1 parent fc4656b commit 00d7321

File tree

1 file changed

+4
-5
lines changed

1 file changed

+4
-5
lines changed

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

+4-5
Original file line numberDiff line numberDiff line change
@@ -479,11 +479,7 @@ ensure that GETs of individual objects remain bounded in time and space, these
479479
sets may be queried via separate API queries, but will not be expanded in the
480480
referring object's status.
481481

482-
References to specific objects, especially specific resource versions and/or
483-
specific fields of those objects, are specified using the `ObjectReference` type
484-
(or other types representing strict subsets of it). Unlike partial URLs, the
485-
ObjectReference type facilitates flexible defaulting of fields from the
486-
referring object or other contextual information.
482+
For references to specific objects, see [Object references](#object-references).
487483

488484
References in the status of the referee to the referrer may be permitted, when
489485
the references are one-to-one and do not need to be frequently updated,
@@ -906,6 +902,9 @@ It is okay to have the "{field}" component indicate the resource type. For examp
906902
a secret. However, this comes with the risk of the field being a misnomer in the case that the field is expanded to
907903
reference more than one type.
908904

905+
In the case of a list of object references, the field should be of the format "{field}Refs", with the same guidance
906+
as the singular case above.
907+
909908
### Referencing resources with multiple versions
910909

911910
Most resources will have multiple versions. For example, core resources

0 commit comments

Comments
 (0)