Skip to content

Commit 8002edd

Browse files
calebdoxseycalebdoxsey
committed
routes: add description and logo url
1 parent 7eee751 commit 8002edd

File tree

4 files changed

+147
-6
lines changed

4 files changed

+147
-6
lines changed

‎content/docs/reference/img/routes/route-description.png

118 KB
Loading

‎content/docs/reference/reference.json

+57-6
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
"id": "address",
2222
"title": "Address",
2323
"path": "/address",
24-
"description": "Specifies the Host and Port to serve HTTP requests from.",
24+
"description": "Specifies the IP Address and Port to serve HTTP requests from.",
2525
"short_description": "",
2626
"type": "string",
2727
"services": ["proxy"]
@@ -439,7 +439,7 @@
439439
"id": "http-redirect-address",
440440
"title": "HTTP Redirect Address",
441441
"path": "/http-redirect-address",
442-
"description": "If set, HTTP Redirect Address specifies the Host and Port to redirect HTTP to HTTPS traffic on.",
442+
"description": "If set, HTTP Redirect Address specifies the IP Address and Port to redirect HTTP to HTTPS traffic on.",
443443
"services": [],
444444
"type": "string"
445445
},
@@ -546,17 +546,24 @@
546546
"path": "/tracing",
547547
"services": []
548548
},
549-
"tracing-provider": {
550-
"id": "tracing-provider",
549+
"tracing-otlp-endpoint": {
550+
"id": "tracing-otlp-endpoint",
551551
"title": "Tracing Provider",
552-
"description": "The name of the tracing provider. For example, Jaeger or Zipkin. Required.",
552+
"description": "Endpoint URL for OTLP trace data. Required.",
553+
"path": "/tracing",
554+
"services": []
555+
},
556+
"tracing-otlp-protocol": {
557+
"id": "tracing-otlp-endpoint",
558+
"title": "Tracing Provider",
559+
"description": "Transport protocol to be used for OTLP trace data.",
553560
"path": "/tracing",
554561
"services": []
555562
},
556563
"tracing-sample-rate": {
557564
"id": "tracing-sample-rate",
558565
"title": "Tracing Sample Rate",
559-
"description": "The percentage of requests to sample in decimal notation. Default is 0.0001, or .01%. Optional.",
566+
"description": "The percentage of requests to sample. Default is 100%.",
560567
"path": "/tracing",
561568
"services": []
562569
},
@@ -774,6 +781,34 @@
774781
"services": [],
775782
"type": "string"
776783
},
784+
"data-broker-storage-certificate-file": {
785+
"id": "data-broker-storage-certificate-file",
786+
"title": "Databroker Storage Certificate File",
787+
"path": "/databroker#databroker-storage-certificate-file",
788+
"services": [],
789+
"type": "relative file location"
790+
},
791+
"data-broker-storage-certificate-key-file": {
792+
"id": "data-broker-storage-certificate-key-file",
793+
"title": "Databroker Storage Certificate Key File",
794+
"path": "/databroker#databroker-storage-certificate-key-file",
795+
"services": [],
796+
"type": "relative file location"
797+
},
798+
"data-broker-storage-certificate-authority": {
799+
"id": "data-broker-storage-certificate-authority",
800+
"title": "Databroker Storage Certificate Authority",
801+
"path": "/databroker#databroker-storage-certificate-authority",
802+
"services": [],
803+
"type": "relative file location"
804+
},
805+
"data-broker-storage-tls-skip-verify": {
806+
"id": "data-broker-storage-tls-skip-verify",
807+
"title": "Databroker Storage TLS Skip Verify",
808+
"path": "/databroker#databroker-storage-tls-skip-verify",
809+
"services": [],
810+
"type": "bool"
811+
},
777812
"allow-any-authenticated-user": {
778813
"id": "allow-any-authenticated-user",
779814
"title": "Allow Any Authenticated User",
@@ -797,6 +832,14 @@
797832
"description": "Allows unauthenticated HTTP OPTIONS requests.",
798833
"type": "bool"
799834
},
835+
"description": {
836+
"id": "description",
837+
"title": "Description",
838+
"path": "/routes/description",
839+
"services": ["proxy"],
840+
"description": "Description of the route.",
841+
"type": "string"
842+
},
800843
"enable-google-cloud-serverless-authentication": {
801844
"id": "enable-google-cloud-serverless-authentication",
802845
"title": "Enable Google Cloud Serverless Authentication",
@@ -1318,6 +1361,14 @@
13181361
"description": "Modifies response headers before they are returned to the client. 'Header' matches the HTTP header name; 'prefix' will be replaced with 'value'.",
13191362
"type": "object"
13201363
},
1364+
"route-logo-url": {
1365+
"id": "route-logo-url",
1366+
"title": "Logo URL",
1367+
"path": "/routes/logo-url",
1368+
"services": ["proxy"],
1369+
"description": "The route logo URL.",
1370+
"type": "string"
1371+
},
13211372
"route-timeout": {
13221373
"id": "route-timeout",
13231374
"title": "Route Timeout",

‎content/docs/reference/routes/description.mdx

+45
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
---
2+
id: description
3+
title: Route Description
4+
keywords:
5+
- reference
6+
- Route Description
7+
pagination_prev: null
8+
pagination_next: null
9+
toc_max_heading_level: 2
10+
---
11+
12+
import Tabs from '@theme/Tabs';
13+
import TabItem from '@theme/TabItem';
14+
15+
# Route Description
16+
17+
## Summary
18+
19+
Route description shown in the routes portal.
20+
21+
## How to configure
22+
23+
<Tabs>
24+
<TabItem value="Core" label="Core">
25+
26+
| **Config file key** | **Type** | **Usage** |
27+
| :------------------ | :------- | :----------- |
28+
| `description` | `string` | **optional** |
29+
30+
</TabItem>
31+
<TabItem value="Enterprise" label="Enterprise">
32+
33+
Set the route **description** under **General** route settings in the Console:
34+
35+
![Set the route **description** under **General** route settings in the Console](../img/routes/route-description.png)
36+
37+
</TabItem>
38+
<TabItem value="Kubernetes" label="Kubernetes">
39+
40+
| **[Annotation name](/docs/deploy/k8s/ingress#set-ingress-annotations)** | **Type** | **Usage** |
41+
| :-- | :-- | :-- |
42+
| `description` | `string` | **optional** |
43+
44+
</TabItem>
45+
</Tabs>

‎content/docs/reference/routes/logo-url.mdx

+45
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
---
2+
id: description
3+
title: Route Logo URL
4+
keywords:
5+
- reference
6+
- Route Logo URL
7+
pagination_prev: null
8+
pagination_next: null
9+
toc_max_heading_level: 2
10+
---
11+
12+
import Tabs from '@theme/Tabs';
13+
import TabItem from '@theme/TabItem';
14+
15+
# Route Logo URL
16+
17+
## Summary
18+
19+
Route logo URL shown in the routes portal.
20+
21+
## How to configure
22+
23+
<Tabs>
24+
<TabItem value="Core" label="Core">
25+
26+
| **Config file key** | **Type** | **Usage** |
27+
| :------------------ | :------- | :----------- |
28+
| `logo_url` | `string` | **optional** |
29+
30+
</TabItem>
31+
<TabItem value="Enterprise" label="Enterprise">
32+
33+
Set the route **logo URL** under **General** route settings in the Console:
34+
35+
![Set the route **logo URL** under **General** route settings in the Console](../img/routes/route-description.png)
36+
37+
</TabItem>
38+
<TabItem value="Kubernetes" label="Kubernetes">
39+
40+
| **[Annotation name](/docs/deploy/k8s/ingress#set-ingress-annotations)** | **Type** | **Usage** |
41+
| :-- | :-- | :-- |
42+
| `logo_url` | `string` | **optional** |
43+
44+
</TabItem>
45+
</Tabs>

0 commit comments

Comments
 (0)