From 702d10d7a4b4e203edd26246195d185dff78dbc6 Mon Sep 17 00:00:00 2001 From: Lance Bragstad Date: Wed, 27 Mar 2019 19:57:18 +0000 Subject: [PATCH] Update links in api conventions document As I was reading through api-conventions.md, I noticed a couple of broken links. This commit updates those links to resolve to their previously linked content. --- contributors/devel/sig-architecture/api-conventions.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/contributors/devel/sig-architecture/api-conventions.md b/contributors/devel/sig-architecture/api-conventions.md index 24ae0ebfd..be47d4702 100644 --- a/contributors/devel/sig-architecture/api-conventions.md +++ b/contributors/devel/sig-architecture/api-conventions.md @@ -379,7 +379,7 @@ Some resources in the v1 API contain fields called **`phase`**, and associated `message`, `reason`, and other status fields. The pattern of using `phase` is deprecated. Newer API types should use conditions instead. Phase was essentially a state-machine enumeration field, that contradicted [system-design -principles](../design-proposals/architecture/principles.md#control-logic) and +principles](../../design-proposals/architecture/principles.md#control-logic) and hampered evolution, since [adding new enum values breaks backward compatibility](api_changes.md). Rather than encouraging clients to infer implicit properties from phases, we prefer to explicitly expose the individual @@ -404,7 +404,7 @@ only provided with reasonable effort, and is not guaranteed to not be lost. Status information that may be large (especially proportional in size to collections of other resources, such as lists of references to other objects -- see below) and/or rapidly changing, such as -[resource usage](../design-proposals/scheduling/resources.md#usage-data), should be put into separate +[resource usage](../../design-proposals/scheduling/resources.md#usage-data), should be put into separate objects, with possibly a reference from the original object. This helps to ensure that GETs and watch remain reasonably efficient for the majority of clients, which may not need that data.