feat(docs) prepare api docs generation (#1741)

* feat(docs) prepare api docs generation Signed-off-by: Bart Smykla <bartek@smykla.com> * feat(docs) mark policy proto files to gen. docs Signed-off-by: Bart Smykla <bartek@smykla.com> (cherry picked from commit 9196f44) Signed-off-by: Bart Smykla <bartek@smykla.com>
kumahq · May 6, 2021 · 1058ebc · 1058ebc
1 parent c608a9f
commit 1058ebc
Show file tree

Hide file tree

Showing 11 changed files with 77 additions and 0 deletions.
diff --git a/api/mesh/v1alpha1/circuit_breaker.proto b/api/mesh/v1alpha1/circuit_breaker.proto
@@ -7,6 +7,13 @@ option go_package = "github.com/kumahq/kuma/api/mesh/v1alpha1";
 import "mesh/v1alpha1/selector.proto";
 import "google/protobuf/duration.proto";
 import "google/protobuf/wrappers.proto";
+import "config.proto";
+
+option (doc.config) = {
+  type : Policy,
+  name : "CircuitBreaker",
+  file_name : "circuit-breaker"
+};
 
 // CircuitBreaker defines circuit breaking policy for dataplane's outbound
 message CircuitBreaker {

diff --git a/api/mesh/v1alpha1/externalservice.proto b/api/mesh/v1alpha1/externalservice.proto
@@ -7,6 +7,13 @@ option go_package = "github.com/kumahq/kuma/api/mesh/v1alpha1";
 import "validate/validate.proto";
 
 import "system/v1alpha1/datasource.proto";
+import "config.proto";
+
+option (doc.config) = {
+  type : Policy,
+  name : "ExternalService",
+  file_name : "external-service"
+};
 
 // ExternalService defines configuration of the externaly accessible service
 message ExternalService {

diff --git a/api/mesh/v1alpha1/fault_injection.proto b/api/mesh/v1alpha1/fault_injection.proto
@@ -7,6 +7,13 @@ option go_package = "github.com/kumahq/kuma/api/mesh/v1alpha1";
 import "google/protobuf/duration.proto";
 import "mesh/v1alpha1/selector.proto";
 import "google/protobuf/wrappers.proto";
+import "config.proto";
+
+option (doc.config) = {
+  type : Policy,
+  name : "FaultInjection",
+  file_name : "fault-injection"
+};
 
 // FaultInjection defines the configuration of faults between dataplanes.
 message FaultInjection {

diff --git a/api/mesh/v1alpha1/health_check.proto b/api/mesh/v1alpha1/health_check.proto
@@ -9,6 +9,13 @@ import "mesh/v1alpha1/selector.proto";
 import "google/protobuf/duration.proto";
 import "google/protobuf/wrappers.proto";
 import "validate/validate.proto";
+import "config.proto";
+
+option (doc.config) = {
+  type : Policy,
+  name : "HealthCheck",
+  file_name : "health-check"
+};
 
 // HealthCheck defines configuration for health checking.
 message HealthCheck {

diff --git a/api/mesh/v1alpha1/proxy_template.proto b/api/mesh/v1alpha1/proxy_template.proto
@@ -5,6 +5,13 @@ package kuma.mesh.v1alpha1;
 option go_package = "github.com/kumahq/kuma/api/mesh/v1alpha1";
 
 import "mesh/v1alpha1/selector.proto";
+import "config.proto";
+
+option (doc.config) = {
+  type : Policy,
+  name : "ProxyTemplate",
+  file_name : "proxy-template"
+};
 
 // ProxyTemplate defines the desired state of ProxyTemplate
 message ProxyTemplate {

diff --git a/api/mesh/v1alpha1/retry.proto b/api/mesh/v1alpha1/retry.proto
@@ -9,6 +9,13 @@ import "mesh/v1alpha1/selector.proto";
 import "google/protobuf/duration.proto";
 import "google/protobuf/wrappers.proto";
 import "validate/validate.proto";
+import "config.proto";
+
+option (doc.config) = {
+  type : Policy,
+  name : "Retry",
+  file_name : "retry"
+};
 
 message Retry {
   // List of selectors to match dataplanes that retry policy should be

diff --git a/api/mesh/v1alpha1/timeout.proto b/api/mesh/v1alpha1/timeout.proto
@@ -6,6 +6,13 @@ option go_package = "github.com/kumahq/kuma/api/mesh/v1alpha1";
 
 import "mesh/v1alpha1/selector.proto";
 import "google/protobuf/duration.proto";
+import "config.proto";
+
+option (doc.config) = {
+  type : Policy,
+  name : "Timeout",
+  file_name : "timeout"
+};
 
 message Timeout {
 

diff --git a/api/mesh/v1alpha1/traffic_log.proto b/api/mesh/v1alpha1/traffic_log.proto
@@ -5,6 +5,13 @@ package kuma.mesh.v1alpha1;
 option go_package = "github.com/kumahq/kuma/api/mesh/v1alpha1";
 
 import "mesh/v1alpha1/selector.proto";
+import "config.proto";
+
+option (doc.config) = {
+  type : Policy,
+  name : "TrafficLog",
+  file_name : "traffic-log"
+};
 
 // TrafficLog defines log for traffic between dataplanes.
 message TrafficLog {

diff --git a/api/mesh/v1alpha1/traffic_permission.proto b/api/mesh/v1alpha1/traffic_permission.proto
@@ -5,6 +5,13 @@ package kuma.mesh.v1alpha1;
 option go_package = "github.com/kumahq/kuma/api/mesh/v1alpha1";
 
 import "mesh/v1alpha1/selector.proto";
+import "config.proto";
+
+option (doc.config) = {
+  type : Policy,
+  name : "TrafficPermissions",
+  file_name : "traffic-permissions"
+};
 
 // TrafficPermission defines permission for traffic between dataplanes.
 message TrafficPermission {

diff --git a/api/mesh/v1alpha1/traffic_route.proto b/api/mesh/v1alpha1/traffic_route.proto
@@ -6,6 +6,13 @@ option go_package = "github.com/kumahq/kuma/api/mesh/v1alpha1";
 
 import "mesh/v1alpha1/selector.proto";
 import "validate/validate.proto";
+import "config.proto";
+
+option (doc.config) = {
+  type : Policy,
+  name : "TrafficRoute",
+  file_name : "traffic-route"
+};
 
 // TrafficRoute defines routing rules for L4 traffic.
 message TrafficRoute {

diff --git a/api/mesh/v1alpha1/traffic_trace.proto b/api/mesh/v1alpha1/traffic_trace.proto
@@ -5,6 +5,13 @@ package kuma.mesh.v1alpha1;
 option go_package = "github.com/kumahq/kuma/api/mesh/v1alpha1";
 
 import "mesh/v1alpha1/selector.proto";
+import "config.proto";
+
+option (doc.config) = {
+  type : Policy,
+  name : "TrafficTrace",
+  file_name : "traffic-trace"
+};
 
 // TrafficTrace defines trace configuration for selected dataplanes.
 message TrafficTrace {