Skip to content
This repository was archived by the owner on Jun 2, 2021. It is now read-only.

Commit 65bac54

Browse files
committed
v3: Add documentation for port and protocol fields on routes
[finishes #162107369, #172512289] Authored-by: Sarah Weinstein <sweinstein@pivotal.io>
1 parent 3ec790f commit 65bac54

3 files changed

Lines changed: 7 additions & 0 deletions

File tree

docs/v3/source/includes/api_resources/_routes.erb

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
<% content_for :single_route do | metadata={} | %>
22
{
33
"guid": "cbad697f-cac1-48f4-9017-ac08f39dfb31",
4+
"protocol": "tcp",
5+
"port": 6666,
46
"created_at": "2019-05-10T17:17:48Z",
57
"updated_at": "2019-05-10T17:17:48Z",
68
"host": "a-hostname",
@@ -86,6 +88,7 @@
8688
"resources": [
8789
{
8890
"guid": "cbad697f-cac1-48f4-9017-ac08f39dfb31",
91+
"protocol": "http",
8992
"created_at": "2019-05-10T17:17:48Z",
9093
"updated_at": "2019-05-10T17:17:48Z",
9194
"host": "a-hostname",

docs/v3/source/includes/resources/routes/_create.md.erb

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ curl "https://api.example.org/v3/routes" \
1212
-d '{
1313
"host": "a-hostname",
1414
"path": "/some_path",
15+
"port": 6666,
1516
"relationships": {
1617
"domain": {
1718
"data": { "guid": "domain-guid" }
@@ -54,6 +55,7 @@ Content-Type: application/json
5455
| ----------------------------------------- | ----------------------------------- | --------------------------------- |
5556
| **host** | _string_ | The host component for the route. |
5657
| **path** | _string_ | The path component for the route. Should begin with a `/`.
58+
| **port** _(experimental)_ | _integer_ | The port the route will listen on. Only compatible with routes leveraging a domain that supports the `tcp` protocol.
5759
| **metadata.annotations** | [_annotation object_](#annotations) | Annotations applied to the route. |
5860
| **metadata.labels** | [_label object_](#labels) | Labels applied to the route. |
5961

docs/v3/source/includes/resources/routes/_object.md.erb

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ Example Route object
1111
| Name | Type | Description |
1212
| -------------- | ------------------------ | ------------------------------------------------------ |
1313
| **guid** | _uuid_ | Unique identifier for the route.
14+
| **protocol** _(experimental)_ | _string_ | The protocol supported by the route, based on the route's domain configuration.
15+
| **port** _(experimental)_ | _integer or `null`_ | The port that the route listens on. Only compatible with routes leveraging the `tcp` protocol.
1416
| **created_at** | _datetime_ | The time with zone when the object was created. |
1517
| **updated_at** | _datetime_ | The time with zone when the object was last updated. |
1618
| **host** | _string_ | The hostname for the route.<br>Must be under 63 character long and only contain letters, numbers, dashes (-) or underscores(_). |

0 commit comments

Comments
 (0)