Merge pull request #2628 from cloudfoundry/remove-experimental-label-…

…from-docs Remove experimental tags from v3 docs
cloudfoundry · Jan 18, 2022 · cf3a1b3 · cf3a1b3
2 parents 3c99791 + 9f906d8
commit cf3a1b3
Show file tree

Hide file tree

Showing 132 changed files with 316 additions and 316 deletions.
diff --git a/docs/v3/README.md b/docs/v3/README.md
@@ -34,7 +34,7 @@ Style Rules
   - alphabetical everything else
 - Object names should be lowercased and separated by a space
 - Every object description should have examples
-- Every request should have a "Permitted Roles"
+- Every request should have a "Permitted roles"
   - Use "All Roles" to define any set of permissions that do not apply to org/space managers, developers, etc.
 - Optional params should be omitted from request examples.
 
@@ -46,4 +46,4 @@ From this directory:
 ```bash
 bundle exec middleman build
 cf push docs -b staticfile_buildpack -p ./build
-```
+```
diff --git a/docs/v3/source/includes/concepts/_filters.md.erb b/docs/v3/source/includes/concepts/_filters.md.erb
@@ -46,7 +46,7 @@ This will return all buildpacks with stack `NULL`.
 
 This will return all routes with hostname `"hostname1"`, `""` OR `"hostname2"`.
 
-#### Relational Operators (Experimental)
+#### Relational Operators
 
 Some fields (e.g. `created_at` and `updated_at`) can be filtered using relational operators when listing resources.
 
@@ -68,7 +68,7 @@ Timestamps must be in [standard timestamp format](#timestamps).
 **gt**       | Return resources strictly greater than the given value for the filtered attribute
 **gte**      | Return resources greater than or equal to the given value for the filtered attribute
 
-#### Exclusion Operator (Experimental)
+#### Exclusion Operator
 
 Some fields support filtering on all values except a given set of values.
 

diff --git a/docs/v3/source/includes/resources/admin/_clear_buildpack_cache.md.erb b/docs/v3/source/includes/resources/admin/_clear_buildpack_cache.md.erb
@@ -28,7 +28,7 @@ unnecessary blobs.
 #### Definition
 `POST /v3/admin/actions/clear_buildpack_cache`
 
-#### Permitted Roles
+#### Permitted roles
  |
 --- | ---
 Admin |
diff --git a/docs/v3/source/includes/resources/app_features/_get.md.erb b/docs/v3/source/includes/resources/app_features/_get.md.erb
@@ -26,13 +26,13 @@ Content-Type: application/json
 
 #### Permitted roles
 
-Role | Notes
---- | ---
+ |
+--- |
 Admin |
 Admin Read-Only |
 Global Auditor |
 Org Manager |
 Space Auditor |
 Space Developer |
 Space Manager |
-Space Supporter | Experimental
+Space Supporter |
diff --git a/docs/v3/source/includes/resources/app_features/_list.md.erb b/docs/v3/source/includes/resources/app_features/_list.md.erb
@@ -28,13 +28,13 @@ This endpoint retrieves the list of features for the specified app.
 
 #### Permitted roles
 
-Role | Notes
---- | ---
+ |
+--- |
 Admin |
 Admin Read-Only |
 Global Auditor |
 Org Manager |
 Space Auditor |
 Space Developer |
 Space Manager |
-Space Supporter | Experimental
+Space Supporter |
diff --git a/docs/v3/source/includes/resources/app_features/_update.md.erb b/docs/v3/source/includes/resources/app_features/_update.md.erb
@@ -38,4 +38,4 @@ Role | Notes
 --- | ---
 Admin |
 Space Developer |
-Space Supporter | Experimental; Can only update **revisions** feature
+Space Supporter | Can only update **revisions** feature
diff --git a/docs/v3/source/includes/resources/app_usage_events/_delete.md.erb b/docs/v3/source/includes/resources/app_usage_events/_delete.md.erb
@@ -25,7 +25,7 @@ Destroys all existing events. Populates new usage events, one for each started a
 
 `POST /v3/app_usage_events/actions/destructively_purge_all_and_reseed`
 
-#### Permitted Roles
+#### Permitted roles
  |
 --- | ---
 Admin |
diff --git a/docs/v3/source/includes/resources/app_usage_events/_get.md.erb b/docs/v3/source/includes/resources/app_usage_events/_get.md.erb
@@ -27,7 +27,7 @@ Retrieve an app usage event.
 
 `GET /v3/app_usage_events/:guid`
 
-#### Permitted Roles
+#### Permitted roles
  |
 --- | ---
 Admin |

diff --git a/docs/v3/source/includes/resources/app_usage_events/_list.md.erb b/docs/v3/source/includes/resources/app_usage_events/_list.md.erb
@@ -36,9 +36,9 @@ Name | Type | Description
 **order_by** | _string_ | Value to sort by. Defaults to ascending; prepend with `-` to sort descending. <br>Valid value is `created_at`
 **after_guid** | _string_ | Filters out events before and including the event with the given guid
 **guids** | _list of strings_ | Comma-delimited list of usage event guids to filter by
-**created_ats** (*experimental*)| _[timestamp](#timestamps)_ | Timestamp to filter by. When filtering on equality, several comma-delimited timestamps may be passed. Also supports filtering with [relational operators](#relational-operators-experimental)
+**created_ats** | _[timestamp](#timestamps)_ | Timestamp to filter by. When filtering on equality, several comma-delimited timestamps may be passed. Also supports filtering with [relational operators](#relational-operators)
 
-#### Permitted Roles
+#### Permitted roles
  |
 --- | ---
 All Roles |
diff --git a/docs/v3/source/includes/resources/apps/_current_droplet.md.erb b/docs/v3/source/includes/resources/apps/_current_droplet.md.erb
@@ -30,8 +30,8 @@ Set the current droplet for an app. The current droplet is the droplet that the
 
 #### Permitted roles
 
-Role | Notes
---- | ---
+ |
+--- |
 Admin |
 Space Developer |
-Space Supporter | Experimental
+Space Supporter |
diff --git a/docs/v3/source/includes/resources/apps/_env.md.erb b/docs/v3/source/includes/resources/apps/_env.md.erb
@@ -80,4 +80,4 @@ Role | Notes
 Admin |
 Admin Read-Only |
 Space Developer |
-Space Supporter | Experimental, system_env_json redacted
+Space Supporter | `system_env_json` redacted
diff --git a/docs/v3/source/includes/resources/apps/_environment_variables.md.erb b/docs/v3/source/includes/resources/apps/_environment_variables.md.erb
@@ -40,9 +40,9 @@ For the entire list of environment variables that will be available to the app a
 `GET /v3/apps/:guid/environment_variables`
 
 #### Permitted roles
-Role | Notes
---- | ---
+ |
+--- |
 Admin |
 Admin Read-Only |
 Space Developer |
-Space Supporter | Experimental
+Space Supporter |
diff --git a/docs/v3/source/includes/resources/apps/_get.md.erb b/docs/v3/source/includes/resources/apps/_get.md.erb
@@ -31,13 +31,13 @@ Name | Type | Description
 **include**| _list of strings_ | Optionally include additional related resources in the response; valid values are `space` and `space.organization`
 
 #### Permitted roles
-Role | Notes
---- | ---
+ |
+--- |
 Admin |
 Admin Read-Only |
 Global Auditor |
 Org Manager |
 Space Auditor |
 Space Developer |
 Space Manager |
-Space Supporter | Experimental
+Space Supporter |
diff --git a/docs/v3/source/includes/resources/apps/_get_current_droplet.md.erb b/docs/v3/source/includes/resources/apps/_get_current_droplet.md.erb
@@ -25,13 +25,13 @@ Content-Type: application/json
 `GET /v3/apps/:guid/droplets/current`
 
 #### Permitted roles
-Role | Notes
---- | ---
+ |
+--- |
 Admin |
 Admin Read-Only |
 Global Auditor |
 Org Manager |
 Space Auditor |
 Space Developer |
 Space Manager |
-Space Supporter | Experimental
+Space Supporter |
diff --git a/docs/v3/source/includes/resources/apps/_get_current_droplet_relationship.md.erb b/docs/v3/source/includes/resources/apps/_get_current_droplet_relationship.md.erb
@@ -29,13 +29,13 @@ This endpoint retrieves the current droplet relationship for an app.
 `GET /v3/apps/:guid/relationships/current_droplet`
 
 #### Permitted roles
-Role | Notes
---- | ---
+ |
+--- |
 Admin |
 Admin Read-Only |
 Global Auditor |
 Org Manager |
 Space Auditor |
 Space Developer |
 Space Manager |
-Space Supporter | Experimental
+Space Supporter |
diff --git a/docs/v3/source/includes/resources/apps/_list.md.erb b/docs/v3/source/includes/resources/apps/_list.md.erb
@@ -41,8 +41,8 @@ Name | Type | Description
 **label_selector** | _string_ | A query string containing a list of [label selector](#labels-and-selectors) requirements
 **lifecycle_type** | _string_ | [Lifecycle](#lifecycles) type to filter by; valid values are `buildpack`, `docker`
 **include**| _list of strings_ | Optionally include a list of unique related resources in the response; valid values are `space` and `spaceorganization`
-**created_ats** (*experimental*)| _[timestamp](#timestamps)_ | Timestamp to filter by. When filtering on equality, several comma-delimited timestamps may be passed. Also supports filtering with [relational operators](#relational-operators-experimental)
-**updated_ats** (*experimental*)| _[timestamp](#timestamps)_ | Timestamp to filter by. When filtering on equality, several comma-delimited timestamps may be passed. Also supports filtering with [relational operators](#relational-operators-experimental)
+**created_ats** | _[timestamp](#timestamps)_ | Timestamp to filter by. When filtering on equality, several comma-delimited timestamps may be passed. Also supports filtering with [relational operators](#relational-operators)
+**updated_ats** | _[timestamp](#timestamps)_ | Timestamp to filter by. When filtering on equality, several comma-delimited timestamps may be passed. Also supports filtering with [relational operators](#relational-operators)
 
 #### Permitted roles
  |

diff --git a/docs/v3/source/includes/resources/apps/_permissions.md.erb b/docs/v3/source/includes/resources/apps/_permissions.md.erb
@@ -32,13 +32,13 @@ developers can read sensitive data.
 `GET /v3/apps/:guid/permissions`
 
 #### Permitted roles
-Role | Notes
---- | ---
+ |
+--- |
 Admin |
 Admin Read-Only |
 Global Auditor |
 Org Manager |
 Space Auditor |
 Space Developer |
 Space Manager |
-Space Supporter | Experimental
+Space Supporter |
diff --git a/docs/v3/source/includes/resources/apps/_restart.md.erb b/docs/v3/source/includes/resources/apps/_restart.md.erb
@@ -33,8 +33,8 @@ For restarting applications without downtime, see the [deployments](#deployments
 
 #### Permitted roles
 
-Role | Notes
---- | ---
+ |
+--- |
 Admin |
 Space Developer |
-Space Supporter | Experimental |
+Space Supporter |
diff --git a/docs/v3/source/includes/resources/apps/_ssh_enabled.md.erb b/docs/v3/source/includes/resources/apps/_ssh_enabled.md.erb
@@ -30,13 +30,13 @@ whether it is disabled globally, at the space level, or at the app level.
 `GET /v3/apps/:guid/ssh_enabled` <br>
 
 #### Permitted roles
-Role | Notes
---- | ---
+ |
+--- |
 Admin |
 Admin Read-Only |
 Global Auditor |
 Org Manager |
 Space Auditor |
 Space Developer |
 Space Manager |
-Space Supporter | Experimental
+Space Supporter |
diff --git a/docs/v3/source/includes/resources/apps/_start.md.erb b/docs/v3/source/includes/resources/apps/_start.md.erb
@@ -26,8 +26,8 @@ Content-Type: application/json
 
 #### Permitted roles
 
-Role | Notes
---- | ---
+ |
+--- |
 Admin |
 Space Developer |
-Space Supporter | Experimental |
+Space Supporter |
diff --git a/docs/v3/source/includes/resources/apps/_stop.md.erb b/docs/v3/source/includes/resources/apps/_stop.md.erb
@@ -26,8 +26,8 @@ Content-Type: application/json
 
 #### Permitted roles
 
-Role | Notes
---- | ---
+ |
+--- |
 Admin |
 Space Developer |
-Space Supporter | Experimental |
+Space Supporter |
diff --git a/docs/v3/source/includes/resources/apps/_update_environment_variables.md.erb b/docs/v3/source/includes/resources/apps/_update_environment_variables.md.erb
@@ -52,8 +52,8 @@ Environment variable names may not start with VCAP_. PORT is not a valid environ
 `PATCH /v3/apps/:guid/environment_variables`
 
 #### Permitted roles
-Role | Notes
---- | ---
+ |
+--- |
 Admin |
 Space Developer |
-Space Supporter | Experimental
+Space Supporter |
diff --git a/docs/v3/source/includes/resources/audit_events/_get.md.erb b/docs/v3/source/includes/resources/audit_events/_get.md.erb
@@ -34,4 +34,4 @@ Global Auditor |
 Org Auditor | Cannot see events which occurred in orgs that the user does not belong to
 Space Auditor | Cannot see events which occurred in spaces that the user does not belong to
 Space Developer | Cannot see events which occurred in spaces that the user does not belong to
-Space Supporter | Experimental; Cannot see events which occurred in spaces that the user does not belong to
+Space Supporter | Cannot see events which occurred in spaces that the user does not belong to
diff --git a/docs/v3/source/includes/resources/audit_events/_list.md.erb b/docs/v3/source/includes/resources/audit_events/_list.md.erb
@@ -31,18 +31,18 @@ Retrieve all audit events the user has access to.
 Name | Type | Description
 ---- | ---- | ------------
 **types** | _list of strings_ | Comma-delimited list of event types to filter by
-**target_guids** | _list of strings_ | Comma-delimited list of target guids to filter by. Also supports [filtering by exclusion](#exclusion-operator-experimental).
+**target_guids** | _list of strings_ | Comma-delimited list of target guids to filter by. Also supports [filtering by exclusion](#exclusion-operator).
 **space_guids** | _list of strings_ | Comma-delimited list of space guids to filter by
 **organization_guids** | _list of strings_ | Comma-delimited list of organization guids to filter by
 **page** | _integer_ | Page to display; valid values are integers >= 1
 **per_page** | _integer_ | Number of results per page; <br>valid values are 1 through 5000
 **order_by** | _string_ | Value to sort by. Defaults to ascending; prepend with `-` to sort descending. <br>Valid values are `created_at`, `updated_at`
-**created_ats** (*experimental*)| _[timestamp](#timestamps)_ | Timestamp to filter by. When filtering on equality, several comma-delimited timestamps may be passed. Also supports filtering with [relational operators](#relational-operators-experimental)
-**updated_ats** (*experimental*)| _[timestamp](#timestamps)_ | Timestamp to filter by. When filtering on equality, several comma-delimited timestamps may be passed. Also supports filtering with [relational operators](#relational-operators-experimental)
+**created_ats** | _[timestamp](#timestamps)_ | Timestamp to filter by. When filtering on equality, several comma-delimited timestamps may be passed. Also supports filtering with [relational operators](#relational-operators)
+**updated_ats** | _[timestamp](#timestamps)_ | Timestamp to filter by. When filtering on equality, several comma-delimited timestamps may be passed. Also supports filtering with [relational operators](#relational-operators)
 
 #### Permitted roles
-Role | Notes
---- | ---
+ |
+--- |
 Admin |
 Admin Read-Only |
 Global Auditor |
@@ -51,4 +51,4 @@ Org Manager |
 Space Auditor |
 Space Developer |
 Space Manager |
-Space Supporter | Experimental |
+Space Supporter |
diff --git a/docs/v3/source/includes/resources/buildpacks/_delete.md b/docs/v3/source/includes/resources/buildpacks/_delete.md
@@ -22,7 +22,7 @@ Location: https://api.example.org/v3/jobs/[guid]
 #### Definition
 `DELETE /v3/buildpacks/:guid`
 
-#### Permitted Roles
+#### Permitted roles
  |
 --- | ---
 Admin |
diff --git a/docs/v3/source/includes/resources/buildpacks/_list.md.erb b/docs/v3/source/includes/resources/buildpacks/_list.md.erb
@@ -36,8 +36,8 @@ Name | Type | Description
 **stacks**| _list of strings_ | Comma-delimited list of stack names to filter by
 **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`
 **label_selector** | _string_ | A query string containing a list of [label selector](#labels-and-selectors) requirements
-**created_ats** (*experimental*)| _[timestamp](#timestamps)_ | Timestamp to filter by. When filtering on equality, several comma-delimited timestamps may be passed. Also supports filtering with [relational operators](#relational-operators-experimental)
-**updated_ats** (*experimental*)| _[timestamp](#timestamps)_ | Timestamp to filter by. When filtering on equality, several comma-delimited timestamps may be passed. Also supports filtering with [relational operators](#relational-operators-experimental)
+**created_ats** | _[timestamp](#timestamps)_ | Timestamp to filter by. When filtering on equality, several comma-delimited timestamps may be passed. Also supports filtering with [relational operators](#relational-operators)
+**updated_ats** | _[timestamp](#timestamps)_ | Timestamp to filter by. When filtering on equality, several comma-delimited timestamps may be passed. Also supports filtering with [relational operators](#relational-operators)
 
 #### Permitted roles
  |

diff --git a/docs/v3/source/includes/resources/builds/_create.md.erb b/docs/v3/source/includes/resources/builds/_create.md.erb
@@ -48,8 +48,8 @@ Name | Type | Description | Default
 
 #### Permitted roles
  |
---- | ---
+--- |
 Admin |
 Space Developer |
-Space Supporter | Experimental
+Space Supporter |
 
diff --git a/docs/v3/source/includes/resources/builds/_get.md.erb b/docs/v3/source/includes/resources/builds/_get.md.erb
@@ -26,12 +26,12 @@ Content-Type: application/json
 
 #### Permitted roles
  |
---- | ---
+--- |
 Admin |
 Admin Read-Only |
 Global Auditor |
 Org Manager |
 Space Auditor |
 Space Developer |
 Space Manager |
-Space Supporter | Experimental
+Space Supporter |
diff --git a/docs/v3/source/includes/resources/builds/_list.md.erb b/docs/v3/source/includes/resources/builds/_list.md.erb
@@ -37,8 +37,8 @@ Name | Type | Description
 **per_page** | _integer_ | Number of results per page; <br>valid values are 1 through 5000
 **order_by** | _string_ | Value to sort by; defaults to ascending. Prepend with `-` to sort descending. <br>Valid values are `created_at`, `updated_at`
 **label_selector** | _string_ | A query string containing a list of [label selector](#labels-and-selectors) requirements
-**created_ats** (*experimental*)| _[timestamp](#timestamps)_ | Timestamp to filter by. When filtering on equality, several comma-delimited timestamps may be passed. Also supports filtering with [relational operators](#relational-operators-experimental)
-**updated_ats** (*experimental*)| _[timestamp](#timestamps)_ | Timestamp to filter by. When filtering on equality, several comma-delimited timestamps may be passed. Also supports filtering with [relational operators](#relational-operators-experimental)
+**created_ats** | _[timestamp](#timestamps)_ | Timestamp to filter by. When filtering on equality, several comma-delimited timestamps may be passed. Also supports filtering with [relational operators](#relational-operators)
+**updated_ats** | _[timestamp](#timestamps)_ | Timestamp to filter by. When filtering on equality, several comma-delimited timestamps may be passed. Also supports filtering with [relational operators](#relational-operators)
 
 #### Permitted roles
  |