fix: generate new README using docgen

Author: benoitgravitee

.circleci/config.yml

@@ -4,7 +4,7 @@ version: 2.1
 setup: true
 
 orbs:
-    gravitee: gravitee-io/gravitee@4.12.1
+    gravitee: gravitee-io/gravitee@4.14.1
 
 # our single workflow, that triggers the setup job defined above, filters on tag and branches are needed otherwise
 # some workflow and job will not be triggered for tags (default CircleCI behavior)

.docgen/before-gateway-options.md

@@ -0,0 +1,5 @@
+### System proxy
+
+If the option `useSystemProxy` is checked, proxy information will be read from `JVM_OPTS`, or from the `gravitee.yml` file if `JVM_OPTS` is not set.
+
+For example: 

.docgen/errors.yaml

@@ -0,0 +1,5 @@
+rows:
+    - data:
+          key: "CALLOUT_EXIT_ON_ERROR"
+    - data:
+          key: "CALLOUT_HTTP_ERROR"

.docgen/examples.yaml

@@ -0,0 +1,15 @@
+genExamples: []
+
+rawExamples:
+    - title: API with basic callout
+      templateRef: v4-api-proxy
+      language: json
+      properties:
+          phase: request
+      file: .docgen/examples/callout.json
+    - title: API CRD with basic callout
+      templateRef: v4-api-crd-proxy
+      language: yaml
+      properties:
+          phase: request
+      file: .docgen/examples/callout.yaml

.docgen/examples/callout.json

@@ -0,0 +1,17 @@
+{
+    "method": "GET",
+    "url": "https://api.gravitee.io/echo",
+    "headers": [
+        {
+            "name": "X-Gravitee-Request-Id",
+            "value": "{#request.id}"
+        }
+    ],
+    "variables": [
+        {
+            "name": "my-server",
+            "value": "{#jsonPath(#calloutResponse.content, '$.headers.X-Forwarded-Server')}"
+        }
+    ],
+    "exitOnError": true
+}

.docgen/examples/callout.yaml

@@ -0,0 +1,9 @@
+method: GET
+url: https://api.gravitee.io/echo
+headers:
+    - name: X-Gravitee-Request-Id
+      value: "{#request.id}"
+variables:
+    - name: my-server
+      value: "{#jsonPath(#calloutResponse.content, '$.headers.X-Forwarded-Server')}"
+exitOnError: true

.docgen/gateway-config.yaml

@@ -0,0 +1,13 @@
+before: .docgen/before-gateway-options.md
+snippets:
+    - title: "gravitee.yml"
+      description: Gateway level configuration of the http client
+      language: YAML
+      content: >-
+          system:
+            proxy:
+              type: HTTP      # HTTP, SOCK4, SOCK5
+              host: localhost
+              port: 3128
+              username: user
+              password: secret

.docgen/matrix.yaml

@@ -0,0 +1,23 @@
+rows:
+    - data:
+          plugin: 4.x
+          apim: 4.4.x to latest
+    - data:
+          plugin: 3.x
+          apim: 4.0.x to 4.3.x
+    - data:
+          plugin: 2.x
+          apim: 3.18.x to 3.20.x
+      deprecated: true
+    - data:
+          plugin: 1.15.x and upper
+          apim: 3.15.x to 3.17.x
+      deprecated: true
+    - data:
+          plugin: 1.13.x to 1.14.x
+          apim: 3.10.x to 3.14.x
+      deprecated: true
+    - data:
+          plugin: Up to 1.12.x
+          apim: Up to 3.9.x
+      deprecated: true

.docgen/overview.md

@@ -0,0 +1,9 @@
+You can use the `callout-http` policy to invoke an HTTP(S) URL and place a subset, or all, of the content in
+one or more variables of the request execution context.
+
+This can be useful if you need some data from an external service and want to inject it during request
+processing.
+
+The result of the callout is placed in a variable called `calloutResponse` and is only available during policy
+execution. If no variable is configured the result of the callout is no longer available.
+

.github/CODEOWNERS

@@ -1,2 +1,5 @@
 # Default
 *       @gravitee-io/apim @gravitee-io/am
+/.docgen/  @gravitee-io/tech-writers
+/docs/     @gravitee-io/tech-writers
+README.md  @gravitee-io/tech-writers