Merge pull request #1439 from rajatdiptabiswas/api-doc-to-openapi-json

Update 3scale.go

addons/threescale/3scale.go

@@ -41,7 +41,7 @@ type threeScaleTrait struct {
 	Path string `property:"path"`
 	// The port where the service is exposed (default `80`)
 	Port int `property:"port"`
-	// The path where the Open-API specification is published (default `/api-doc`)
+	// The path where the Open-API specification is published (default `/openapi.json`)
 	DescriptionPath *string `property:"description-path"`
 }
 
@@ -64,7 +64,7 @@ const (
 	// ThreeScaleDescriptionPathAnnotation --
 	ThreeScaleDescriptionPathAnnotation = "discovery.3scale.net/description-path"
 	// ThreeScaleDescriptionPathDefaultValue --
-	ThreeScaleDescriptionPathDefaultValue = "/api-doc"
+	ThreeScaleDescriptionPathDefaultValue = "/openapi.json"
 
 	// ThreeScaleDiscoveryLabel --
 	ThreeScaleDiscoveryLabel = "discovery.3scale.net"

addons/threescale/3scale_test.go

@@ -59,7 +59,7 @@ func TestThreeScaleInjection(t *testing.T) {
 	assert.Equal(t, "http", svc.Annotations["discovery.3scale.net/scheme"])
 	assert.Equal(t, "/", svc.Annotations["discovery.3scale.net/path"])
 	assert.Equal(t, "80", svc.Annotations["discovery.3scale.net/port"])
-	assert.Equal(t, "/api-doc", svc.Annotations["discovery.3scale.net/description-path"])
+	assert.Equal(t, "/openapi.json", svc.Annotations["discovery.3scale.net/description-path"])
 }
 
 func TestThreeScaleInjectionNoAPIPath(t *testing.T) {

deploy/traits.yaml

@@ -706,3 +706,32 @@ traits:
   - name: auto
     type: bool
     description: To automatically detect from the code if a Service needs to be created.
+- name: 3scale
+  platform: false
+  profiles:
+  - Kubernetes
+  - Knative
+  - OpenShift
+  description: The 3scale trait can be used to automatically create annotations that
+    allow3scale to discover the generated service and make it available for API management.The
+    3scale trait is disabled by default.
+  properties:
+  - name: enabled
+    type: bool
+    description: Can be used to enable or disable a trait. All traits share this common
+      property.
+  - name: auto
+    type: bool
+    description: Enables automatic configuration of the trait.
+  - name: scheme
+    type: string
+    description: The scheme to use to contact the service (default `http`)
+  - name: path
+    type: string
+    description: The path where the API is published (default `/`)
+  - name: port
+    type: int
+    description: The port where the service is exposed (default `80`)
+  - name: description-path
+    type: string
+    description: The path where the Open-API specification is published (default `/openapi.json`)