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

Commit bfe720b

Browse files
Teal Stannardbelinda-liu
andcommitted
docs: unify "experimental" tags on format
[#172899667] Co-authored-by: Teal Stannard <tstannard@pivotal.io> Co-authored-by: Belinda Liu <bliu@pivotal.io>
1 parent 7ce8c1d commit bfe720b

40 files changed

Lines changed: 63 additions & 63 deletions

docs/v3/source/includes/experimental_resources/revisions/_list.md.erb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Retrieve revisions for an app the user has access to.
3131
Name | Type | Description
3232
---- | ---- | ------------
3333
**versions** | _list of strings_ | Comma-delimited list of revision versions to filter by.
34-
**label_selector** | _string_ | **Experimental** - A query string containing a list of [label selector](#labels-and-selectors) requirements.
34+
**label_selector** (*experimental*)| _string_ | A query string containing a list of [label selector](#labels-and-selectors) requirements.
3535
**page** | _integer_ | Page to display. Valid values are integers >= 1.
3636
**per_page** | _integer_ | Number of results per page. <br>Valid values are 1 through 5000.
3737
**order_by** | _string_ | Value to sort by. Defaults to ascending. Prepend with `-` to sort descending. <br>Valid values are `created_at`, `updated_at`.

docs/v3/source/includes/resources/apps/_get.md.erb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Content-Type: application/json
2828

2929
Name | Type | Description
3030
---- | ---- | ------------
31-
**include** | _string_ | **Experimental** - Optionally include additional related resources in the response. <br>Valid values are `space` and `space.organization`.
31+
**include** (*experimental*)| _string_ | Optionally include additional related resources in the response. <br>Valid values are `space` and `space.organization`.
3232

3333
#### Permitted roles
3434
|

docs/v3/source/includes/resources/apps/_list.md.erb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,8 @@ Name | Type | Description
3838
**page** | _integer_ | Page to display. Valid values are integers >= 1.
3939
**per_page** | _integer_ | Number of results per page. <br>Valid values are 1 through 5000.
4040
**order_by** | _string_ | Value to sort by. Defaults to ascending. Prepend with `-` to sort descending. <br>Valid values are `created_at`, `updated_at`, `name`.
41-
**label_selector** | _string_ | **Experimental** - A query string containing a list of [label selector](#labels-and-selectors) requirements.
42-
**include** | _string_ | **Experimental** - Optionally include a list of unique related resources in the response. <br>Valid values are `space` and `space.organization`
41+
**label_selector** (*experimental*)| _string_ | A query string containing a list of [label selector](#labels-and-selectors) requirements.
42+
**include** (*experimental*)| _string_ | Optionally include a list of unique related resources in the response. <br>Valid values are `space` and `space.organization`
4343
**lifecycle_type** | _string_ | [Lifecycle](#lifecycles) type to filter by. Valid values are `buildpack`, `docker`.
4444

4545
#### Permitted roles

docs/v3/source/includes/resources/buildpacks/_list.md.erb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Name | Type | Description
3535
**names** | _list of strings_ | Comma-delimited list of buildpack names to filter by.
3636
**stacks**| _list of strings_ | Comma-delimited list of stack names to filter by.
3737
**order_by** | _string_ | Value to sort by. Defaults to ascending. Prepend with `-` to sort descending. <br>Valid values are `created_at`, `updated_at`, and `position`.
38-
**label_selector** | _string_ | **Experimental** - A query string containing a list of [label selector](#labels-and-selectors) requirements.
38+
**label_selector** (*experimental*)| _string_ | A query string containing a list of [label selector](#labels-and-selectors) requirements.
3939

4040
#### Permitted roles
4141
|

docs/v3/source/includes/resources/builds/_list.md.erb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ Name | Type | Description
3636
**page** | _integer_ | Page to display. Valid values are integers >= 1.
3737
**per_page** | _integer_ | Number of results per page. <br>Valid values are 1 through 5000.
3838
**order_by** | _string_ | Value to sort by. Defaults to ascending. Prepend with `-` to sort descending. <br>Valid values are `created_at`, `updated_at`.
39-
**label_selector** | _string_ | **Experimental** - A query string containing a list of [label selector](#labels-and-selectors) requirements.
39+
**label_selector** (*experimental*)| _string_ | A query string containing a list of [label selector](#labels-and-selectors) requirements.
4040

4141
#### Permitted roles
4242
|

docs/v3/source/includes/resources/builds/_list_for_app.md.erb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Name | Type | Description
3434
**page** | _integer_ | Page to display. Valid values are integers >= 1.
3535
**per_page** | _integer_ | Number of results per page. <br>Valid values are 1 through 5000.
3636
**order_by** | _string_ | Value to sort by. Defaults to ascending. Prepend with `-` to sort descending. <br>Valid values are `created_at`, `updated_at`.
37-
**label_selector** | _string_ | **Experimental** - A query string containing a list of [label selector](#labels-and-selectors) requirements.
37+
**label_selector** (*experimental*)| _string_ | A query string containing a list of [label selector](#labels-and-selectors) requirements.
3838

3939
#### Permitted roles
4040
|

docs/v3/source/includes/resources/builds/_update.md.erb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,8 @@ Name | Type | Description
3333
---- | ---- | -----------
3434
**metadata.labels** | [_label object_](#labels) | Labels applied to the build.
3535
**metadata.annotations** | [_annotation object_](#annotations) | Annotations applied to the build.
36-
**state** _(experimental)_ | _string_ | Build status (FAILED, STAGED). **
37-
**lifecycle.data.image** _(experimental)_ | _string_ | Image reference tag where the built complete image was stored. **
36+
**state** (*experimental*) | _string_ | Build status (FAILED, STAGED). **
37+
**lifecycle.data.image** (*experimental*) | _string_ | Image reference tag where the built complete image was stored. **
3838

3939
#### Permitted roles
4040
|

docs/v3/source/includes/resources/deployments/_list.md.erb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ Name | Type | Description
3737
**page** | _integer_ | Page to display. Valid values are integers >= 1.
3838
**per_page** | _integer_ | Number of results per page. <br>Valid values are 1 through 5000.
3939
**order_by** | _string_ | Value to sort by. Defaults to ascending. Prepend with `-` to sort descending. <br>Valid values are `created_at`, `updated_at`.
40-
**label_selector** | _string_ | **Experimental** - A query string containing a list of [label selector](#labels-and-selectors) requirements.
40+
**label_selector** (*experimental*)| _string_ | A query string containing a list of [label selector](#labels-and-selectors) requirements.
4141

4242
#### Permitted roles
4343
|

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ 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_ | **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 |
43+
| **router_group.guid** (*experimental*) | _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 |
4444
| **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._ | |
4545
| **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_ | |
4646
| **metadata.labels** | [_label object_](#labels) | Labels applied to the domain. | |

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Retrieve all domains the user has access to.
3535
| **organization_guids** | _list of strings_ | Comma-delimited list of owning organization guids to filter by. |
3636
| **page** | _integer_ | Page to display. Valid values are integers >= 1. |
3737
| **per_page** | _integer_ | Number of results per page. <br>Valid values are 1 through 5000. |
38-
| **label_selector** | _string_ | **Experimental** - A query string containing a list of [label selector](#labels-and-selectors) requirements. |
38+
| **label_selector** (*experimental*)| _string_ | A query string containing a list of [label selector](#labels-and-selectors) requirements. |
3939

4040
#### Permitted roles
4141

0 commit comments

Comments
 (0)