Align the structure of the 4 APIs

Signed-off-by: Patrice Krakow <patrice.krakow@gmail.com>
servicemeshinterface · Sep 29, 2020 · 5ea7e93 · 5ea7e93
1 parent 6fbbadb
commit 5ea7e93
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 8 deletions.
diff --git a/apis/traffic-access/traffic-access-WD.md b/apis/traffic-access/traffic-access-WD.md
@@ -4,7 +4,9 @@
 
 **API Version:** v1alpha3-WD
 
-**Compatible With:** specs.smi-spec.io/v1alpha3
+**Compatible with:** specs.smi-spec.io/v1alpha4-WD
+
+## Specification
 
 This set of resources allows users to define access control policy for their
 applications. It is the authorization side of the picture. Authentication should
@@ -13,8 +15,6 @@ already be handled by the underlying implementation and surfaced through a subje
 Access control in this specification is additive, all traffic is denied by default.
 See [tradeoffs](#tradeoffs) for a longer discussion about why.
 
-## Specification
-
 ### TrafficTarget
 
 A `TrafficTarget` associates a set of traffic definitions (rules) with a

diff --git a/apis/traffic-metrics/traffic-metrics-WD.md b/apis/traffic-metrics/traffic-metrics-WD.md
@@ -4,7 +4,7 @@
 
 **API Version:** v1alpha2-WD
 
-## Specfication
+## Specification
 
 This specification describes a resource that provides a common integration
 point for tools that can benefit by consuming metrics related to HTTP traffic.
@@ -51,7 +51,7 @@ are two main ways to query the API for metrics:
 * A sub-resource allows querying for all the edges associated with a specific
   resource.
 
-## Specification
+### TrafficMetrics
 
 The core resource is `TrafficMetrics`. It references a `resource`, has an `edge`
 and surfaces latency percentiles and request volume.
@@ -441,7 +441,7 @@ targets pods with an Envoy sidecar and periodically requests
   rules and force integrations to query those directly. This feels like it
   increases the bar for metrics stores to change their internal configuration
   around to support this specification. There is also not a multi-tenant story
-  for Prometheus series visibility that maps across Kuberenetes RBAC. From the
+  for Prometheus series visibility that maps across Kubernetes RBAC. From the
   other side, consumers of these metrics will have to do discovery of
   Prometheus' location in the cluster and do some kind of queries to surface the
   data that they need.

diff --git a/apis/traffic-specs/traffic-specs-WD.md b/apis/traffic-specs/traffic-specs-WD.md
@@ -2,7 +2,7 @@
 
 **API Group:** specs.smi-spec.io
 
-**Version:** v1alpha4-WD
+**API Version:** v1alpha4-WD
 
 ## Specification
 

diff --git a/apis/traffic-split/traffic-split-WD.md b/apis/traffic-split/traffic-split-WD.md
@@ -4,7 +4,7 @@
 
 **API Version:** v1alpha4-WD
 
-**Compatible with:** specs.smi-spec.io/v1alpha3
+**Compatible with:** specs.smi-spec.io/v1alpha4-WD
 
 ## Specification