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

Commit 923e852

Browse files
committed
Update domains docs to include link to router groups when necessary
* mark router groups field on request as experimental as per [story](https://www.pivotaltracker.com/story/show/169276053) [finishes #172547117] Authored-by: Mona Mohebbi <mmohebbi@pivotal.io>
1 parent ea47561 commit 923e852

2 files changed

Lines changed: 6 additions & 3 deletions

File tree

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,9 @@
8282
},
8383
"route_reservations": {
8484
"href": "https://api.example.org/v3/domains/3a5d3d89-3f89-4f05-8188-8a2b298c79d5/route_reservations"
85+
},
86+
"router_group": {
87+
"href": "https://api.example.org/routing/v1/router_groups/5806148f-cce6-4d86-7fbd-aa269e3f6f3f"
8588
}
8689
}
8790
},

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,10 +40,10 @@ Name | Type | Description
4040
| Name | Type | Description | Default |
4141
| ----------- | -------- | ------------------------------------------------------------------------ | ------- |
4242
| **internal** | _boolean_ | Whether the domain is used for internal (container-to-container) traffic. | false |
43-
| **router_group.guid** | _uuid_ | The desired router group guid. <br>_Note: cannot be used when `internal` is set to `true` or domain is scoped to an org._ | null |
43+
| **router_group.guid** | _uuid_ | **Experimental** - The desired router group guid. <br>_Note: cannot be used when `internal` is set to `true` or domain is scoped to an org._ | null |
4444
| **supported_protocols** | _list of strings_ | The protocols that are supported by the domain. | |
45-
| **organization** | [_to-one relationship_](#to-one-relationships) | A relationship to the organization the domain will be scoped to. <br>_Note: cannot be used when `internal` is set to `true` or domain is associated with a router group._ | |
46-
| **shared_organizations** | [_to-many relationship_](#to-many-relationships) | A relationship to organizations the domain will be shared with. <br>_Note: cannot be used without an organization relationship_ | |
45+
| **organization** | [_to-one relationship_](#to-one-relationships) | A relationship to the organization the domain will be scoped to. <br>_Note: cannot be used when `internal` is set to `true` or domain is associated with a router group._ | |
46+
| **shared_organizations** | [_to-many relationship_](#to-many-relationships) | A relationship to organizations the domain will be shared with. <br>_Note: cannot be used without an organization relationship_ | |
4747
| **metadata.labels** | [_label object_](#labels) | Labels applied to the domain. | |
4848
| **metadata.annotations** | [_annotation object_](#annotations) | Annotations applied to the domain. | |
4949

0 commit comments

Comments
 (0)