diff --git a/docs/v3/README.md b/docs/v3/README.md index 33064ed31e5..1b86da483de 100644 --- 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 -``` \ No newline at end of file +``` diff --git a/docs/v3/source/includes/concepts/_filters.md.erb b/docs/v3/source/includes/concepts/_filters.md.erb index e66bcbe945a..1adf4262cff 100644 --- 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 index a4064ca8740..2ffc1571502 100644 --- 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 index bac374e6950..be8bc111df6 100644 --- a/docs/v3/source/includes/resources/app_features/_get.md.erb +++ b/docs/v3/source/includes/resources/app_features/_get.md.erb @@ -26,8 +26,8 @@ Content-Type: application/json #### Permitted roles -Role | Notes ---- | --- + | +--- | Admin | Admin Read-Only | Global Auditor | @@ -35,4 +35,4 @@ 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 index 1bd2f437016..1a8537b5ae1 100644 --- a/docs/v3/source/includes/resources/app_features/_list.md.erb +++ b/docs/v3/source/includes/resources/app_features/_list.md.erb @@ -28,8 +28,8 @@ This endpoint retrieves the list of features for the specified app. #### Permitted roles -Role | Notes ---- | --- + | +--- | Admin | Admin Read-Only | Global Auditor | @@ -37,4 +37,4 @@ 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 index 59e9c4f435b..ec3519a7bb6 100644 --- 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 index aa17bc33468..68c7ffe8fb3 100644 --- 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 index ecec66c940c..4253bf3f3cf 100644 --- 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 index 07f8580a25f..427c4d722f6 100644 --- 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.
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 index 1025ace11f6..23b64322097 100644 --- 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 index bf6dd77c204..57535aa8c04 100644 --- 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 \ No newline at end of file +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 index ff6f02f6419..5785df52eff 100644 --- 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 \ No newline at end of file +Space Supporter | diff --git a/docs/v3/source/includes/resources/apps/_get.md.erb b/docs/v3/source/includes/resources/apps/_get.md.erb index f0bd9f2ca80..0975aeccd52 100644 --- a/docs/v3/source/includes/resources/apps/_get.md.erb +++ b/docs/v3/source/includes/resources/apps/_get.md.erb @@ -31,8 +31,8 @@ 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 | @@ -40,4 +40,4 @@ 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 index 83d379582de..a141ed97325 100644 --- 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,8 +25,8 @@ Content-Type: application/json `GET /v3/apps/:guid/droplets/current` #### Permitted roles -Role | Notes ---- | --- + | +--- | Admin | Admin Read-Only | Global Auditor | @@ -34,4 +34,4 @@ 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 index 378f6d44e21..c19e33c825f 100644 --- 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,8 +29,8 @@ 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 | @@ -38,4 +38,4 @@ 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 index 0697c5ef1fe..47bd7684fa4 100644 --- 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 index 836036b8265..5ee236a57c3 100644 --- a/docs/v3/source/includes/resources/apps/_permissions.md.erb +++ b/docs/v3/source/includes/resources/apps/_permissions.md.erb @@ -32,8 +32,8 @@ developers can read sensitive data. `GET /v3/apps/:guid/permissions` #### Permitted roles -Role | Notes ---- | --- + | +--- | Admin | Admin Read-Only | Global Auditor | @@ -41,4 +41,4 @@ 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 index e8b22d8fab4..40f43b6cee3 100644 --- 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 index d402c142a4c..2ed65524c31 100644 --- a/docs/v3/source/includes/resources/apps/_ssh_enabled.md.erb +++ b/docs/v3/source/includes/resources/apps/_ssh_enabled.md.erb @@ -30,8 +30,8 @@ whether it is disabled globally, at the space level, or at the app level. `GET /v3/apps/:guid/ssh_enabled`
#### Permitted roles -Role | Notes ---- | --- + | +--- | Admin | Admin Read-Only | Global Auditor | @@ -39,4 +39,4 @@ 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 index 96211fe84d9..949dd579bb1 100644 --- 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 index 998361f992c..a699fccea5c 100644 --- 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 index 9e7a09de2b9..3d963a022b1 100644 --- 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 \ No newline at end of file +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 index 6da5319609b..de53b281335 100644 --- 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 index 87ef5b4d96e..400fdbbf1d2 100644 --- 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;
valid values are 1 through 5000 **order_by** | _string_ | Value to sort by. Defaults to ascending; prepend with `-` to sort descending.
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 index 801272a24dc..a135a093887 100644 --- 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 index 8aea93b512c..bfad835b683 100644 --- 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.
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 index 754127dcd0d..49e8673cc40 100644 --- 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 index 28f3b82972d..c5f106e9341 100644 --- a/docs/v3/source/includes/resources/builds/_get.md.erb +++ b/docs/v3/source/includes/resources/builds/_get.md.erb @@ -26,7 +26,7 @@ Content-Type: application/json #### Permitted roles | ---- | --- +--- | Admin | Admin Read-Only | Global Auditor | @@ -34,4 +34,4 @@ 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 index 5fccb323723..040d093dcfb 100644 --- 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;
valid values are 1 through 5000 **order_by** | _string_ | Value to sort by; defaults to ascending. Prepend with `-` to sort descending.
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 | diff --git a/docs/v3/source/includes/resources/builds/_list_for_app.md.erb b/docs/v3/source/includes/resources/builds/_list_for_app.md.erb index 2859ef53613..e2d2cd05ec4 100644 --- a/docs/v3/source/includes/resources/builds/_list_for_app.md.erb +++ b/docs/v3/source/includes/resources/builds/_list_for_app.md.erb @@ -35,12 +35,12 @@ Name | Type | Description **per_page** | _integer_ | Number of results per page;
valid values are 1 through 5000 **order_by** | _string_ | Value to sort by; defaults to ascending. Prepend with `-` to sort descending.
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 - Role | Notes ---- | --- + | +--- | Admin | Admin Read-Only | Global Auditor | @@ -48,4 +48,4 @@ Org Manager | Space Auditor | Space Developer | Space Manager | -Space Supporter | Experimental +Space Supporter | diff --git a/docs/v3/source/includes/resources/builds/_update.md.erb b/docs/v3/source/includes/resources/builds/_update.md.erb index 1dd48058308..14f433788ea 100644 --- a/docs/v3/source/includes/resources/builds/_update.md.erb +++ b/docs/v3/source/includes/resources/builds/_update.md.erb @@ -33,8 +33,8 @@ Name | Type | Description ---- | ---- | ----------- **metadata.labels** | [_label object_](#labels) | Labels applied to the build **metadata.annotations** | [_annotation object_](#annotations) | Annotations applied to the build -**state** *(experimental)* | _string_ | Build status; valid values are `FAILED` or `STAGED` (field can only be passed by Build State Updaters) -**lifecycle.data.image** *(experimental)* | _string_ | Image reference tag where the built complete image was stored (field can only be passed by Build State Updaters) +**state** | _string_ | Build status; valid values are `FAILED` or `STAGED` (field can only be passed by Build State Updaters) +**lifecycle.data.image** | _string_ | Image reference tag where the built complete image was stored (field can only be passed by Build State Updaters) #### Permitted roles diff --git a/docs/v3/source/includes/resources/deployments/_cancel.md.erb b/docs/v3/source/includes/resources/deployments/_cancel.md.erb index 6ad98c81845..63cbaa5ecd8 100644 --- a/docs/v3/source/includes/resources/deployments/_cancel.md.erb +++ b/docs/v3/source/includes/resources/deployments/_cancel.md.erb @@ -23,8 +23,8 @@ HTTP/1.1 200 OK `POST /v3/deployments/:guid/actions/cancel` #### Permitted roles - Roles | Notes ---- | --- + | +--- | Admin | Space Developer | -Space Supporter | Experimental | +Space Supporter | diff --git a/docs/v3/source/includes/resources/deployments/_create.md.erb b/docs/v3/source/includes/resources/deployments/_create.md.erb index fe5513559e0..ae705dc5a72 100644 --- a/docs/v3/source/includes/resources/deployments/_create.md.erb +++ b/docs/v3/source/includes/resources/deployments/_create.md.erb @@ -84,8 +84,8 @@ Name | Type | Description | Default 1 Only a droplet _or_ a revision may be provided, not both. #### Permitted roles - Roles | Notes ---- | --- + | +--- | Admin | Space Developer | -Space Supporter | Experimental | +Space Supporter | diff --git a/docs/v3/source/includes/resources/deployments/_get.md.erb b/docs/v3/source/includes/resources/deployments/_get.md.erb index 837dbea778d..06206231d13 100644 --- a/docs/v3/source/includes/resources/deployments/_get.md.erb +++ b/docs/v3/source/includes/resources/deployments/_get.md.erb @@ -25,8 +25,8 @@ Content-Type: application/json `GET /v3/deployments/:guid` #### Permitted roles - Roles | Notes ---- | --- + | +--- | Admin | Admin Read-Only | Global Auditor | @@ -34,4 +34,4 @@ Org Manager | Space Auditor | Space Developer | Space Manager | -Space Supporter | Experimental | +Space Supporter | diff --git a/docs/v3/source/includes/resources/deployments/_list.md.erb b/docs/v3/source/includes/resources/deployments/_list.md.erb index f826a42293e..21eba19cf99 100644 --- a/docs/v3/source/includes/resources/deployments/_list.md.erb +++ b/docs/v3/source/includes/resources/deployments/_list.md.erb @@ -38,10 +38,10 @@ Name | Type | Description **per_page** | _integer_ | Number of results per page;
valid values are 1 through 5000 **order_by** | _string_ | Value to sort by. Defaults to ascending; prepend with `-` to sort descending.
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 - Roles | Notes ---- | --- -All Roles | \ No newline at end of file + | +--- | +All Roles | diff --git a/docs/v3/source/includes/resources/deployments/_update.md.erb b/docs/v3/source/includes/resources/deployments/_update.md.erb index ebe3f2244d0..33a17248ea0 100644 --- a/docs/v3/source/includes/resources/deployments/_update.md.erb +++ b/docs/v3/source/includes/resources/deployments/_update.md.erb @@ -35,7 +35,7 @@ Name | Type | Description **metadata.annotations** | [_annotation object_](#annotations) | Annotations applied to the deployment #### Permitted roles - Roles | Notes ---- | --- + | +--- | Admin | -Space Developer | \ No newline at end of file +Space Developer | diff --git a/docs/v3/source/includes/resources/domains/_get.md.erb b/docs/v3/source/includes/resources/domains/_get.md.erb index 92652788e97..b7943df1c63 100644 --- a/docs/v3/source/includes/resources/domains/_get.md.erb +++ b/docs/v3/source/includes/resources/domains/_get.md.erb @@ -37,4 +37,4 @@ Org Manager | Space Auditor | Space Developer | Space Manager | -Space Supporter | Experimental +Space Supporter | diff --git a/docs/v3/source/includes/resources/domains/_list.md.erb b/docs/v3/source/includes/resources/domains/_list.md.erb index d2a93913c38..29091c9a215 100644 --- a/docs/v3/source/includes/resources/domains/_list.md.erb +++ b/docs/v3/source/includes/resources/domains/_list.md.erb @@ -37,8 +37,8 @@ Retrieve all domains the user has access to. | **per_page** | _integer_ | Number of results per page;
valid values are 1 through 5000 | **order_by** | _string_ | Value to sort by. Defaults to ascending; prepend with `-` to sort descending
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 diff --git a/docs/v3/source/includes/resources/domains/_share.md.erb b/docs/v3/source/includes/resources/domains/_share.md.erb index 869e26980b4..6a58a7560ea 100644 --- a/docs/v3/source/includes/resources/domains/_share.md.erb +++ b/docs/v3/source/includes/resources/domains/_share.md.erb @@ -41,7 +41,7 @@ Name | Type | Description #### Permitted roles -Role | Notes ------ | --- + | +----- | Admin | Org Manager | diff --git a/docs/v3/source/includes/resources/droplets/_delete.md b/docs/v3/source/includes/resources/droplets/_delete.md index 7bf0df7fa7d..d17822965e2 100644 --- a/docs/v3/source/includes/resources/droplets/_delete.md +++ b/docs/v3/source/includes/resources/droplets/_delete.md @@ -22,7 +22,7 @@ Location: https://api.example.org/v3/jobs/[guid] #### Definition `DELETE /v3/droplets/:guid` -#### Permitted Roles +#### Permitted roles | --- | --- Admin | diff --git a/docs/v3/source/includes/resources/droplets/_get.md.erb b/docs/v3/source/includes/resources/droplets/_get.md.erb index 52f85875739..884bc73f5bf 100644 --- a/docs/v3/source/includes/resources/droplets/_get.md.erb +++ b/docs/v3/source/includes/resources/droplets/_get.md.erb @@ -34,4 +34,4 @@ Org Manager | Some fields are redacted Space Auditor | Some fields are redacted Space Developer | Space Manager | Some fields are redacted -Space Supporter | Experimental; Some fields are redacted +Space Supporter | Some fields are redacted diff --git a/docs/v3/source/includes/resources/droplets/_list.md.erb b/docs/v3/source/includes/resources/droplets/_list.md.erb index 08b507cdba7..adccc40ef62 100644 --- a/docs/v3/source/includes/resources/droplets/_list.md.erb +++ b/docs/v3/source/includes/resources/droplets/_list.md.erb @@ -39,8 +39,8 @@ Name | Type | Description **per_page** | _integer_ | Number of results per page;
valid values are 1 through 5000 **order_by** | _string_ | Value to sort by. Defaults to ascending; prepend with `-` to sort descending.
Valid values are `created_at` and `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 | diff --git a/docs/v3/source/includes/resources/droplets/_list_for_app.md.erb b/docs/v3/source/includes/resources/droplets/_list_for_app.md.erb index c0e84d005ba..4c969e7c372 100644 --- a/docs/v3/source/includes/resources/droplets/_list_for_app.md.erb +++ b/docs/v3/source/includes/resources/droplets/_list_for_app.md.erb @@ -39,8 +39,8 @@ Name | Type | Description **label_selector** | _string_ | A query string containing a list of [label selector](#labels-and-selectors) requirements #### Permitted roles -Role | Notes | ---- | --- | + | +--- | Admin | Admin Read-Only | Global Auditor | @@ -48,4 +48,4 @@ Org Manager | Space Auditor | Space Developer | Space Manager | -Space Supporter | Experimental | +Space Supporter | diff --git a/docs/v3/source/includes/resources/droplets/_list_for_package.md.erb b/docs/v3/source/includes/resources/droplets/_list_for_package.md.erb index 3a74e624681..1377d38d1dc 100644 --- a/docs/v3/source/includes/resources/droplets/_list_for_package.md.erb +++ b/docs/v3/source/includes/resources/droplets/_list_for_package.md.erb @@ -38,8 +38,8 @@ Name | Type | Description **label_selector** | _string_ | A query string containing a list of [label selector](#labels-and-selectors) requirements #### Permitted roles -Role | Notes | ---- | --- | + | +--- | Admin | Admin Read-Only | Global Auditor | @@ -47,4 +47,4 @@ Org Manager | Space Auditor | Space Developer | Space Manager | -Space Supporter | Experimental | +Space Supporter | diff --git a/docs/v3/source/includes/resources/feature_flags/_list.md.erb b/docs/v3/source/includes/resources/feature_flags/_list.md.erb index dd9ccf79039..f6dae0930ab 100644 --- a/docs/v3/source/includes/resources/feature_flags/_list.md.erb +++ b/docs/v3/source/includes/resources/feature_flags/_list.md.erb @@ -33,7 +33,7 @@ Name | Type | Description **page** | _integer_ | Page to display; valid values are integers >= 1 **per_page** | _integer_ | Number of results per page;
valid values are 1 through 5000 **order_by** | _string_ | Value to sort by. Defaults to `name` ascending; prepend with `-` to sort descending.
Valid value is `name` -**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) +**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/isolation_segments/_list.md.erb b/docs/v3/source/includes/resources/isolation_segments/_list.md.erb index 738cd609a38..76300d9dbf3 100644 --- a/docs/v3/source/includes/resources/isolation_segments/_list.md.erb +++ b/docs/v3/source/includes/resources/isolation_segments/_list.md.erb @@ -37,8 +37,8 @@ Name | Type | Description **per_page** | _integer_ | Number of results per page;
valid values are 1 through 5000 **order_by** | _string_ | Value to sort by; defaults to ascending. Prepend with `-` to sort descending.
Valid values are `created_at`, `updated_at`, and `name` **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/manifests/_create_diff.md b/docs/v3/source/includes/resources/manifests/_create_diff.md index be186b531d3..e3fdb89fade 100644 --- a/docs/v3/source/includes/resources/manifests/_create_diff.md +++ b/docs/v3/source/includes/resources/manifests/_create_diff.md @@ -63,7 +63,7 @@ Name | Type | Description `POST /v3/spaces/:guid/manifest_diff` -#### Permitted Roles +#### Permitted roles | --- | --- Admin | diff --git a/docs/v3/source/includes/resources/manifests/_get.md b/docs/v3/source/includes/resources/manifests/_get.md index 70003bb7314..d6eea6f0a81 100644 --- a/docs/v3/source/includes/resources/manifests/_get.md +++ b/docs/v3/source/includes/resources/manifests/_get.md @@ -40,7 +40,7 @@ Generate a manifest for an app and its underlying processes. #### Definition `GET /v3/apps/:guid/manifest` -#### Permitted Roles +#### Permitted roles | --- | --- Admin | diff --git a/docs/v3/source/includes/resources/organization_quotas/_apply.md.erb b/docs/v3/source/includes/resources/organization_quotas/_apply.md.erb index dd18bb0015a..13b9914b42c 100644 --- a/docs/v3/source/includes/resources/organization_quotas/_apply.md.erb +++ b/docs/v3/source/includes/resources/organization_quotas/_apply.md.erb @@ -42,6 +42,6 @@ Name | Type | Description #### Permitted roles -Role | Notes ---- | --- + | +--- | Admin | diff --git a/docs/v3/source/includes/resources/organization_quotas/_create.md.erb b/docs/v3/source/includes/resources/organization_quotas/_create.md.erb index 802e0f3d5b9..c578c4a05c2 100644 --- a/docs/v3/source/includes/resources/organization_quotas/_create.md.erb +++ b/docs/v3/source/includes/resources/organization_quotas/_create.md.erb @@ -60,6 +60,6 @@ Name | Type | Description | Default | #### Permitted roles -Role | Notes ---- | --- + | +--- | Admin | diff --git a/docs/v3/source/includes/resources/organization_quotas/_delete.md.erb b/docs/v3/source/includes/resources/organization_quotas/_delete.md.erb index 740c4f6e9df..bb481a52a2e 100644 --- a/docs/v3/source/includes/resources/organization_quotas/_delete.md.erb +++ b/docs/v3/source/includes/resources/organization_quotas/_delete.md.erb @@ -26,7 +26,7 @@ Location: https://api.example.org/v3/jobs/[guid] #### Permitted roles -Role | Notes ---- | --- + | +--- | Admin | diff --git a/docs/v3/source/includes/resources/organization_quotas/_get.md.erb b/docs/v3/source/includes/resources/organization_quotas/_get.md.erb index dbe66445175..87fe5d970a0 100644 --- a/docs/v3/source/includes/resources/organization_quotas/_get.md.erb +++ b/docs/v3/source/includes/resources/organization_quotas/_get.md.erb @@ -40,4 +40,4 @@ Org Billing Manager | Response will only include guids of billing-managed organi Space Auditor | Response will only include guids of parent organizations Space Developer | Response will only include guids of parent organizations Space Manager | Response will only include guids of parent organizations -Space Supporter | Experimental / Response will only include guids of parent organizations \ No newline at end of file +Space Supporter | Response will only include guids of parent organizations diff --git a/docs/v3/source/includes/resources/organization_quotas/_list.md.erb b/docs/v3/source/includes/resources/organization_quotas/_list.md.erb index cf53a0f5d98..9f8467933e2 100644 --- a/docs/v3/source/includes/resources/organization_quotas/_list.md.erb +++ b/docs/v3/source/includes/resources/organization_quotas/_list.md.erb @@ -36,8 +36,8 @@ Name | Type | Description **page** | _integer_ | Page to display; valid values are integers >= 1 **per_page** | _integer_ | Number of results per page;
valid values are 1 through 5000 **order_by** | _string_ | Value to sort by; defaults to ascending. Prepend with `-` to sort descending.
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 @@ -52,4 +52,4 @@ Org Billing Manager | Response will only include guids of billing-managed organi Space Auditor | Response will only include guids of parent organizations Space Developer | Response will only include guids of parent organizations Space Manager | Response will only include guids of parent organizations -Space Supporter | Experimental / Response will only include guids of parent organizations +Space Supporter | Response will only include guids of parent organizations diff --git a/docs/v3/source/includes/resources/organization_quotas/_update.md.erb b/docs/v3/source/includes/resources/organization_quotas/_update.md.erb index 91c53109155..8338b4f509b 100644 --- a/docs/v3/source/includes/resources/organization_quotas/_update.md.erb +++ b/docs/v3/source/includes/resources/organization_quotas/_update.md.erb @@ -69,6 +69,6 @@ Name | Type | Description #### Permitted roles -Role | Notes ------ | --- + | +----- | Admin | diff --git a/docs/v3/source/includes/resources/organizations/_get_default_domain.md.erb b/docs/v3/source/includes/resources/organizations/_get_default_domain.md.erb index aaf83cb0121..ede15aa8d1b 100644 --- a/docs/v3/source/includes/resources/organizations/_get_default_domain.md.erb +++ b/docs/v3/source/includes/resources/organizations/_get_default_domain.md.erb @@ -38,4 +38,4 @@ Org Manager | Space Auditor | Space Developer | Space Manager | -Space Supporter | Experimental +Space Supporter | diff --git a/docs/v3/source/includes/resources/organizations/_list.md.erb b/docs/v3/source/includes/resources/organizations/_list.md.erb index 63b580c19ed..db251067ff6 100644 --- a/docs/v3/source/includes/resources/organizations/_list.md.erb +++ b/docs/v3/source/includes/resources/organizations/_list.md.erb @@ -36,8 +36,8 @@ Name | Type | Description **per_page** | _integer_ | Number of results per page;
valid values are 1 through 5000 **order_by** | _string_ | Value to sort by; defaults to ascending. Prepend with `-` to sort descending.
Valid values are `created_at`, `updated_at`, and `name` **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/organizations/_list_users.md.erb b/docs/v3/source/includes/resources/organizations/_list_users.md.erb index c27ff3eef5b..935ebb8a90d 100644 --- a/docs/v3/source/includes/resources/organizations/_list_users.md.erb +++ b/docs/v3/source/includes/resources/organizations/_list_users.md.erb @@ -37,8 +37,8 @@ Name | Type | Description **per_page** | _integer_ | Number of results per page;
valid values are 1 through 5000 **order_by** | _string_ | Value to sort by. Defaults to ascending; prepend with `-` to sort descending
Valid values are `created_at` and `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 | diff --git a/docs/v3/source/includes/resources/packages/_delete.md b/docs/v3/source/includes/resources/packages/_delete.md index 090ceecc61f..26e41f0b863 100644 --- a/docs/v3/source/includes/resources/packages/_delete.md +++ b/docs/v3/source/includes/resources/packages/_delete.md @@ -22,7 +22,7 @@ Location: https://api.example.org/v3/jobs/[guid] #### Definition `DELETE /v3/packages/:guid` -#### Permitted Roles +#### Permitted roles | --- | --- Admin | diff --git a/docs/v3/source/includes/resources/packages/_get.md.erb b/docs/v3/source/includes/resources/packages/_get.md.erb index 7c46111c2ca..b7dfed22c19 100644 --- a/docs/v3/source/includes/resources/packages/_get.md.erb +++ b/docs/v3/source/includes/resources/packages/_get.md.erb @@ -25,8 +25,8 @@ Content-Type: application/json `GET /v3/packages/:guid` #### Permitted roles -Role | Notes ---- | --- + | +--- | Admin | Admin Read-Only | Global Auditor | @@ -34,4 +34,4 @@ Org Manager | Space Auditor | Space Developer | Space Manager | -Space Supporter | Experimental +Space Supporter | diff --git a/docs/v3/source/includes/resources/packages/_list.md.erb b/docs/v3/source/includes/resources/packages/_list.md.erb index a857e919cea..d80ae63d385 100644 --- a/docs/v3/source/includes/resources/packages/_list.md.erb +++ b/docs/v3/source/includes/resources/packages/_list.md.erb @@ -40,8 +40,8 @@ Name | Type | Description **per_page** | _integer_ | Number of results per page;
valid values are 1 through 5000 **order_by** | _string_ | Value to sort by; defaults to ascending. Prepend with `-` to sort descending.
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 | diff --git a/docs/v3/source/includes/resources/packages/_list_for_app.md.erb b/docs/v3/source/includes/resources/packages/_list_for_app.md.erb index 1946c373350..6a0e6a9cdf8 100644 --- a/docs/v3/source/includes/resources/packages/_list_for_app.md.erb +++ b/docs/v3/source/includes/resources/packages/_list_for_app.md.erb @@ -36,12 +36,12 @@ Name | Type | Description **page** | _integer_ | Page to display; valid values are integers >= 1 **per_page** | _integer_ | Number of results per page;
valid values are 1 through 5000 **order_by** | _string_ | Value to sort by; defaults to ascending. Prepend with `-` to sort descending.
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 | @@ -49,4 +49,4 @@ Org Manager | Space Auditor | Space Developer | Space Manager | -Space Supporter | Experimental +Space Supporter | diff --git a/docs/v3/source/includes/resources/processes/_get.md.erb b/docs/v3/source/includes/resources/processes/_get.md.erb index 309149de069..99bf56d0aa2 100644 --- a/docs/v3/source/includes/resources/processes/_get.md.erb +++ b/docs/v3/source/includes/resources/processes/_get.md.erb @@ -35,4 +35,4 @@ Org Manager | Some fields are redacted Space Auditor | Some fields are redacted Space Developer | Space Manager | Some fields are redacted -Space Supporter | Experimental; Some fields are redacted +Space Supporter | Some fields are redacted diff --git a/docs/v3/source/includes/resources/processes/_list.md.erb b/docs/v3/source/includes/resources/processes/_list.md.erb index dd7bc0a5c0e..5e364d93a5f 100644 --- a/docs/v3/source/includes/resources/processes/_list.md.erb +++ b/docs/v3/source/includes/resources/processes/_list.md.erb @@ -39,8 +39,8 @@ Name | Type | Description **per_page** | _integer_ | Number of results per page;
valid values are 1 through 5000 **order_by** | _string_ | Value to sort by. Defaults to ascending; prepend with `-` to sort descending.
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 | diff --git a/docs/v3/source/includes/resources/processes/_list_for_app.md.erb b/docs/v3/source/includes/resources/processes/_list_for_app.md.erb index 9efe1f80a6b..2d290db2fa1 100644 --- a/docs/v3/source/includes/resources/processes/_list_for_app.md.erb +++ b/docs/v3/source/includes/resources/processes/_list_for_app.md.erb @@ -36,12 +36,12 @@ Name | Type | Description **per_page** | _integer_ | Number of results per page;
valid values are 1 through 5000 **order_by** | _string_ | Value to sort by. Defaults to ascending; prepend with `-` to sort descending.
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 -Roles | Notes | ---- | --- + | +--- | Admin | Admin Read-Only | Global Auditor | diff --git a/docs/v3/source/includes/resources/processes/_object.md.erb b/docs/v3/source/includes/resources/processes/_object.md.erb index b1be1e971cd..3d07fbc1f34 100644 --- a/docs/v3/source/includes/resources/processes/_object.md.erb +++ b/docs/v3/source/includes/resources/processes/_object.md.erb @@ -19,7 +19,7 @@ Name | Type | Description **disk_in_mb** | _integer_ | The disk in MB allocated per instance **health_check** | [_health check object_](#the-health-check-object) | The health check to perform on the process **relationships.app** | [_to-one relationship_](#to-one-relationships) | The app the process belongs to -**relationships.revision** (*experimental*)| [_to-one relationship_](#to-one-relationships) | The app revision the process is currently running +**relationships.revision** | [_to-one relationship_](#to-one-relationships) | The app revision the process is currently running **metadata.labels** | [_label object_](#labels) | Labels applied to the process **metadata.annotations** | [_annotation object_](#annotations) | Annotations applied to the process **links** | [_links object_](#links) | Links to related resources diff --git a/docs/v3/source/includes/resources/processes/_stats.md.erb b/docs/v3/source/includes/resources/processes/_stats.md.erb index cacf39c279c..8df73df43a4 100644 --- a/docs/v3/source/includes/resources/processes/_stats.md.erb +++ b/docs/v3/source/includes/resources/processes/_stats.md.erb @@ -35,4 +35,4 @@ Org Manager | Some fields are redacted Space Auditor | Some fields are redacted Space Developer | Space Manager | Some fields are redacted -Space Supporter | Experimental; Some fields are redacted +Space Supporter | Some fields are redacted diff --git a/docs/v3/source/includes/resources/processes/_terminate_instance.md b/docs/v3/source/includes/resources/processes/_terminate_instance.md index 637357e2e1c..d0607ac4bcc 100644 --- a/docs/v3/source/includes/resources/processes/_terminate_instance.md +++ b/docs/v3/source/includes/resources/processes/_terminate_instance.md @@ -26,7 +26,7 @@ This allows a user to stop a single misbehaving instance of a process. `DELETE /v3/processes/:guid/instances/:index`
`DELETE /v3/apps/:guid/processes/:type/instances/:index` -#### Permitted Roles +#### Permitted roles | --- | --- Admin | diff --git a/docs/v3/source/includes/resources/revisions/_deployed_list.md.erb b/docs/v3/source/includes/resources/revisions/_deployed_list.md.erb index ad6189fc922..ac931955dc2 100644 --- a/docs/v3/source/includes/resources/revisions/_deployed_list.md.erb +++ b/docs/v3/source/includes/resources/revisions/_deployed_list.md.erb @@ -36,8 +36,8 @@ Name | Type | Description **order_by** | _string_ | Value to sort by. Defaults to ascending, prepend with `-` to sort descending.
Valid values are `created_at`, `updated_at` #### Permitted roles -Role | Notes ---- | --- + | +--- | Admin | Admin Read-Only | Global Auditor | @@ -45,4 +45,4 @@ Org Manager | Space Auditor | Space Developer | Space Manager | -Space Supporter | Experimental +Space Supporter | diff --git a/docs/v3/source/includes/resources/revisions/_get.md.erb b/docs/v3/source/includes/resources/revisions/_get.md.erb index 16c1c5b6a60..1d3a3a3052b 100644 --- a/docs/v3/source/includes/resources/revisions/_get.md.erb +++ b/docs/v3/source/includes/resources/revisions/_get.md.erb @@ -25,8 +25,8 @@ Content-Type: application/json `GET /v3/revisions/:guid` #### Permitted roles -Role | Notes ---- | --- + | +--- | Admin | Admin Read-Only | Global Auditor | @@ -34,4 +34,4 @@ Org Manager | Space Auditor | Space Developer | Space Manager | -Space Supporter | Experimental +Space Supporter | diff --git a/docs/v3/source/includes/resources/revisions/_list.md.erb b/docs/v3/source/includes/resources/revisions/_list.md.erb index dfd362229ab..82b1bd62292 100644 --- a/docs/v3/source/includes/resources/revisions/_list.md.erb +++ b/docs/v3/source/includes/resources/revisions/_list.md.erb @@ -35,12 +35,12 @@ Name | Type | Description **page** | _integer_ | Page to display; valid values are integers >= 1 **per_page** | _integer_ | Number of results per page;
valid values are 1 through 5000 **order_by** | _string_ | Value to sort by. Defaults to ascending; prepend with `-` to sort descending.
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 | @@ -48,4 +48,4 @@ Org Manager | Space Auditor | Space Developer | Space Manager | -Space Supporter | Experimental +Space Supporter | diff --git a/docs/v3/source/includes/resources/revisions/_object.md.erb b/docs/v3/source/includes/resources/revisions/_object.md.erb index 491bec07e4b..a26ec06a053 100644 --- a/docs/v3/source/includes/resources/revisions/_object.md.erb +++ b/docs/v3/source/includes/resources/revisions/_object.md.erb @@ -17,7 +17,7 @@ Name | Type | Description **created_at** | _[timestamp](#timestamps)_ | The time with zone when the object was created **updated_at** | _[timestamp](#timestamps)_ | The time with zone when the object was last updated **description** | _string_ | A short description of the reason for revision -**deployable** _(experimental)_ | _boolean_ | Indicates if the revision's droplet is staged and the revision can be used to [create a deployment](#create-a-deployment) +**deployable** | _boolean_ | Indicates if the revision's droplet is staged and the revision can be used to [create a deployment](#create-a-deployment) **relationships.app** | [_to-one relationship_](#to-one-relationships) | The app the revision is associated with **metadata.labels** | [_label object_](#labels) | Labels applied to the revision **metadata.annotations** | [_annotation object_](#annotations) | Annotations applied to the revision diff --git a/docs/v3/source/includes/resources/roles/_list.md.erb b/docs/v3/source/includes/resources/roles/_list.md.erb index 77f28ec3d03..06d196fb194 100644 --- a/docs/v3/source/includes/resources/roles/_list.md.erb +++ b/docs/v3/source/includes/resources/roles/_list.md.erb @@ -40,8 +40,8 @@ Name | Type | Description **per_page** | _integer_ | Number of results per page;
valid values are 1 through 5000 **order_by** | _string_ | Value to sort by. Defaults to ascending; prepend with `-` to sort descending.
Valid values are `created_at`, `updated_at` **include** | _list of strings_ | Optionally include a list of unique related resources in the response;
valid values are `user`, `space`, and `organization` -**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/routes/_check_route_reservations.md.erb b/docs/v3/source/includes/resources/routes/_check_route_reservations.md.erb index cf1dfd00554..bb9c5be44f6 100644 --- a/docs/v3/source/includes/resources/routes/_check_route_reservations.md.erb +++ b/docs/v3/source/includes/resources/routes/_check_route_reservations.md.erb @@ -48,4 +48,4 @@ Org Manager | Space Auditor | Space Developer | Space Manager | -Space Supporter | Experimental | +Space Supporter | diff --git a/docs/v3/source/includes/resources/routes/_create.md.erb b/docs/v3/source/includes/resources/routes/_create.md.erb index dbd88dc06e9..e6e28d87019 100644 --- a/docs/v3/source/includes/resources/routes/_create.md.erb +++ b/docs/v3/source/includes/resources/routes/_create.md.erb @@ -61,9 +61,9 @@ Content-Type: application/json #### Permitted roles -Role | Notes ------ | --- + | +----- | Admin | Space Developer | -Space Supporter | Experimental | +Space Supporter | diff --git a/docs/v3/source/includes/resources/routes/_delete.md.erb b/docs/v3/source/includes/resources/routes/_delete.md.erb index 7182b0b5e64..6896de4228c 100644 --- a/docs/v3/source/includes/resources/routes/_delete.md.erb +++ b/docs/v3/source/includes/resources/routes/_delete.md.erb @@ -24,8 +24,8 @@ Location: https://api.example.org/v3/jobs/[guid] #### Permitted roles -Role | Notes ---- | --- + | +--- | Admin | Space Developer | -Space Supporter | Experimental | +Space Supporter | diff --git a/docs/v3/source/includes/resources/routes/_delete_unmapped.md.erb b/docs/v3/source/includes/resources/routes/_delete_unmapped.md.erb index ef895956ecb..18d25eda7ca 100644 --- a/docs/v3/source/includes/resources/routes/_delete_unmapped.md.erb +++ b/docs/v3/source/includes/resources/routes/_delete_unmapped.md.erb @@ -26,10 +26,10 @@ Deletes all routes in a space that are not mapped to any applications and not bo #### Permitted roles -Role | Notes ---- | --- + | +--- | Admin | Space Developer | -Space Supporter | Experimental | +Space Supporter | **Note**: `unmapped=true` is a required query parameter; always include it. diff --git a/docs/v3/source/includes/resources/routes/_get.md.erb b/docs/v3/source/includes/resources/routes/_get.md.erb index c8a4c16f5b1..f437ec593f2 100644 --- a/docs/v3/source/includes/resources/routes/_get.md.erb +++ b/docs/v3/source/includes/resources/routes/_get.md.erb @@ -32,8 +32,8 @@ Name | Type | Description #### Permitted roles -Role | Notes ---- | --- + | +--- | Admin | Admin Read-Only | Global Auditor | @@ -42,4 +42,4 @@ Org Manager | Space Auditor | Space Developer | Space Manager | -Space Supporter | Experimental | +Space Supporter | diff --git a/docs/v3/source/includes/resources/routes/_insert_destinations.md.erb b/docs/v3/source/includes/resources/routes/_insert_destinations.md.erb index 69c2bf22068..75fb18dba5f 100644 --- a/docs/v3/source/includes/resources/routes/_insert_destinations.md.erb +++ b/docs/v3/source/includes/resources/routes/_insert_destinations.md.erb @@ -57,8 +57,8 @@ replace all destinations for a route at once using the [replace destinations end #### Permitted roles -| Role | Notes | -| --------------- | --- | +| | +| --------------- | | Admin | | Space Developer | -| Space Supporter | Experimental | +| Space Supporter | diff --git a/docs/v3/source/includes/resources/routes/_list.md.erb b/docs/v3/source/includes/resources/routes/_list.md.erb index a94f82de977..bc43e4d0cc7 100644 --- a/docs/v3/source/includes/resources/routes/_list.md.erb +++ b/docs/v3/source/includes/resources/routes/_list.md.erb @@ -43,8 +43,8 @@ Name | Type | Description **order_by** | _string_ | Value to sort by. Defaults to ascending; prepend with `-` to sort descending.
Valid values are `created_at`, `updated_at` **label_selector** | _string_ | A query string containing a list of [label selector](#labels-and-selectors) requirements **include** | _string_ | Optionally include a list of unique related resources in the response
Valid values are `domain`, `space.organization`, `space` -**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/routes/_list_destinations.md.erb b/docs/v3/source/includes/resources/routes/_list_destinations.md.erb index 80788fa7a1f..a56ec3509b3 100644 --- a/docs/v3/source/includes/resources/routes/_list_destinations.md.erb +++ b/docs/v3/source/includes/resources/routes/_list_destinations.md.erb @@ -35,8 +35,8 @@ Name | Type | Description #### Permitted roles -Role | Notes ---- | --- + | +--- | Admin | Admin Read-Only | Global Auditor | @@ -45,4 +45,4 @@ Org Manager | Space Auditor | Space Developer | Space Manager | -Space Supporter | Experimental | +Space Supporter | diff --git a/docs/v3/source/includes/resources/routes/_list_for_app.md.erb b/docs/v3/source/includes/resources/routes/_list_for_app.md.erb index b6d1e51f78b..3e06ea016ed 100644 --- a/docs/v3/source/includes/resources/routes/_list_for_app.md.erb +++ b/docs/v3/source/includes/resources/routes/_list_for_app.md.erb @@ -42,8 +42,8 @@ Name | Type | Description **label_selector** | _string_ | A query string containing a list of [label selector](#labels-and-selectors) requirements #### 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/routes/_remove_destination.md.erb b/docs/v3/source/includes/resources/routes/_remove_destination.md.erb index 2ef9b828a36..772bd25d3cf 100644 --- a/docs/v3/source/includes/resources/routes/_remove_destination.md.erb +++ b/docs/v3/source/includes/resources/routes/_remove_destination.md.erb @@ -25,8 +25,8 @@ Remove a destination from a route. #### Permitted roles -Role | Notes ---- | --- + | +--- | Admin | Space Developer | -Space Supporter | Experimental | +Space Supporter | diff --git a/docs/v3/source/includes/resources/routes/_replace_destinations.md.erb b/docs/v3/source/includes/resources/routes/_replace_destinations.md.erb index 8720db8b3de..645fdf602f7 100644 --- a/docs/v3/source/includes/resources/routes/_replace_destinations.md.erb +++ b/docs/v3/source/includes/resources/routes/_replace_destinations.md.erb @@ -94,8 +94,8 @@ and unweighted destinations for a route is not allowed. #### Permitted roles -| Role | Notes | -| --------------- | --- | +| | +| --------------- | | Admin | | Space Developer | -| Space Supporter | Experimental | +| Space Supporter | diff --git a/docs/v3/source/includes/resources/routes/_update.md.erb b/docs/v3/source/includes/resources/routes/_update.md.erb index 5a3456ed741..d1fa9d5ea79 100644 --- a/docs/v3/source/includes/resources/routes/_update.md.erb +++ b/docs/v3/source/includes/resources/routes/_update.md.erb @@ -40,8 +40,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/security_groups/_get.md.erb b/docs/v3/source/includes/resources/security_groups/_get.md.erb index 0bcbcc58ca5..a2d732f8473 100644 --- a/docs/v3/source/includes/resources/security_groups/_get.md.erb +++ b/docs/v3/source/includes/resources/security_groups/_get.md.erb @@ -36,5 +36,5 @@ Org Manager | Can see globally enabled security groups or groups associated with Space Auditor | Can see globally enabled security groups or groups associated with a space they can see Space Developer | Can see globally enabled security groups or groups associated with a space they can see Space Manager | Can see globally enabled security groups or groups associated with a space they can see -Space Supporter | Experimental. Can see globally enabled security groups or groups associated with a space they can see +Space Supporter | Can see globally enabled security groups or groups associated with a space they can see diff --git a/docs/v3/source/includes/resources/security_groups/_list.md.erb b/docs/v3/source/includes/resources/security_groups/_list.md.erb index c863277e0b1..82487fef35b 100644 --- a/docs/v3/source/includes/resources/security_groups/_list.md.erb +++ b/docs/v3/source/includes/resources/security_groups/_list.md.erb @@ -37,8 +37,8 @@ Name | Type | Description **page** | _integer_ | Page to display; valid values are integers >= 1 **per_page** | _integer_ | Number of results per page;
valid values are 1 through 5000 **order_by** | _string_ | Value to sort by. Defaults to ascending; prepend with `-` to sort descending.
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 @@ -52,4 +52,4 @@ Org Manager | Can see globally–enabled security groups or groups associated wi Space Auditor | Can see globally–enabled security groups or groups associated with a space they can see Space Developer | Can see globally–enabled security groups or groups associated with a space they can see Space Manager | Can see globally–enabled security groups or groups associated with a space they can see -Space Supporter | Experimental. Can see globally–enabled security groups or groups associated with a space they can see +Space Supporter | Can see globally–enabled security groups or groups associated with a space they can see diff --git a/docs/v3/source/includes/resources/security_groups/_list_running_security_groups.md.erb b/docs/v3/source/includes/resources/security_groups/_list_running_security_groups.md.erb index c4680016013..c1733d09601 100644 --- a/docs/v3/source/includes/resources/security_groups/_list_running_security_groups.md.erb +++ b/docs/v3/source/includes/resources/security_groups/_list_running_security_groups.md.erb @@ -47,4 +47,4 @@ Org Manager | Can see globally-enabled security groups and groups associated wit Space Auditor | Can see globally-enabled security groups and groups associated with spaces where they have this role Space Developer | Can see globally-enabled security groups and groups associated with spaces where they have this role Space Manager | Can see globally-enabled security groups and groups associated with spaces where they have this role -Space Supporter | Experimental. Can see globally-enabled security groups and groups associated with spaces where they have this role +Space Supporter | Can see globally-enabled security groups and groups associated with spaces where they have this role diff --git a/docs/v3/source/includes/resources/security_groups/_list_staging_security_groups.md.erb b/docs/v3/source/includes/resources/security_groups/_list_staging_security_groups.md.erb index 2965b1cecc8..48cb3b9c60d 100644 --- a/docs/v3/source/includes/resources/security_groups/_list_staging_security_groups.md.erb +++ b/docs/v3/source/includes/resources/security_groups/_list_staging_security_groups.md.erb @@ -47,4 +47,4 @@ Org Manager | Can see globally-enabled security groups and groups associated wit Space Auditor | Can see globally-enabled security groups and groups associated with spaces where they have this role Space Developer | Can see globally-enabled security groups and groups associated with spaces where they have this role Space Manager | Can see globally-enabled security groups and groups associated with spaces where they have this role -Space Supporter | Experimental. Can see globally-enabled security groups and groups associated with spaces where they have this role +Space Supporter | Can see globally-enabled security groups and groups associated with spaces where they have this role diff --git a/docs/v3/source/includes/resources/service_brokers/_get.md.erb b/docs/v3/source/includes/resources/service_brokers/_get.md.erb index d122e8b3ab9..a6f0540526d 100644 --- a/docs/v3/source/includes/resources/service_brokers/_get.md.erb +++ b/docs/v3/source/includes/resources/service_brokers/_get.md.erb @@ -33,4 +33,4 @@ Admin | Admin Read-Only | Global Auditor | Space Developer | Only space-scoped brokers -Space Supporter | Experimental; Only space-scoped brokers +Space Supporter | Only space-scoped brokers diff --git a/docs/v3/source/includes/resources/service_brokers/_list.md.erb b/docs/v3/source/includes/resources/service_brokers/_list.md.erb index ee6823a63b5..f8fe0f536c3 100644 --- a/docs/v3/source/includes/resources/service_brokers/_list.md.erb +++ b/docs/v3/source/includes/resources/service_brokers/_list.md.erb @@ -36,8 +36,8 @@ Name | Type | Description **space_guids** | _list of strings_ | Comma-delimited list of space GUIDs to filter by **order_by** | _string_ | Value to sort by. Defaults to ascending; prepend with `-` to sort descending.
Valid values are `created_at`, `updated_at`, `name` **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 Role | Notes @@ -46,5 +46,5 @@ Admin | Admin Read-Only | Global Auditor | Space Developer | Only space-scoped brokers -Space Supporter | Experimental; Only space-scoped brokers +Space Supporter | Only space-scoped brokers Other | Will receive an empty list diff --git a/docs/v3/source/includes/resources/service_credential_bindings/_create.md.erb b/docs/v3/source/includes/resources/service_credential_bindings/_create.md.erb index ee802b09c31..68fc735edd2 100644 --- a/docs/v3/source/includes/resources/service_credential_bindings/_create.md.erb +++ b/docs/v3/source/includes/resources/service_credential_bindings/_create.md.erb @@ -126,4 +126,4 @@ Role | Notes --- | --- Admin | Space Developer | -Space Supporter | Experimental. Only allowed to create bindings of type `app`. +Space Supporter | Only allowed to create bindings of type `app`. diff --git a/docs/v3/source/includes/resources/service_credential_bindings/_delete.md.erb b/docs/v3/source/includes/resources/service_credential_bindings/_delete.md.erb index a8a824d26bb..0898ddccc1b 100644 --- a/docs/v3/source/includes/resources/service_credential_bindings/_delete.md.erb +++ b/docs/v3/source/includes/resources/service_credential_bindings/_delete.md.erb @@ -35,9 +35,9 @@ respond synchronously to the delete request. #### Definition `DELETE /v3/service_credential_bindings/:guid` -#### Permitted Roles -Role | Notes ---- | --- +#### Permitted roles + | +--- | Admin | Space Developer | -Space Supporter | Experimental \ No newline at end of file +Space Supporter | diff --git a/docs/v3/source/includes/resources/service_credential_bindings/_get.md.erb b/docs/v3/source/includes/resources/service_credential_bindings/_get.md.erb index bce784db9d5..e759b420e4b 100644 --- a/docs/v3/source/includes/resources/service_credential_bindings/_get.md.erb +++ b/docs/v3/source/includes/resources/service_credential_bindings/_get.md.erb @@ -45,8 +45,8 @@ Name | Type | Description **include** | _list of strings_ | Optionally include a list of unique related resources in the response. Valid values are: `app`, `service_instance` #### Permitted roles -Role | Notes ---- | --- + | +--- | Admin | Admin Read-Only | Global Auditor | @@ -54,4 +54,4 @@ Org Manager | Space Auditor | Space Developer | Space Manager | -Space Supporter | Experimental \ No newline at end of file +Space Supporter | diff --git a/docs/v3/source/includes/resources/service_credential_bindings/_list.md.erb b/docs/v3/source/includes/resources/service_credential_bindings/_list.md.erb index c4175642ef5..fad3970829a 100644 --- a/docs/v3/source/includes/resources/service_credential_bindings/_list.md.erb +++ b/docs/v3/source/includes/resources/service_credential_bindings/_list.md.erb @@ -42,8 +42,8 @@ Name | Type | Description **service_offering_names** | _list of strings_ | Comma-delimited list of service offering names to filter by **type** | _list of strings_ | Type of credential binding to filter by. Valid values are: `app` or `key` **guids** | _list of strings_ | Comma-delimited list of service route binding 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) -**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) **include** | _list of strings_ | Optionally include a list of unique related resources in the response. Valid values are: `app`, `service_instance` **label_selector** | _string_ | A query string containing a list of [label selector](#labels-and-selectors) requirements **page** | _integer_ | Page to display; valid values are integers >= 1 @@ -51,8 +51,8 @@ Name | Type | Description **order_by** | _string_ | Value to sort by. Defaults to ascending; prepend with `-` to sort descending
Valid values are `created_at`, `updated_at`, and `name` #### Permitted roles -Role | Notes ---- | --- + | +--- | Admin | Admin Read-Only | Global Auditor | @@ -60,4 +60,4 @@ Org Manager | Space Auditor | Space Developer | Space Manager | -Space Supporter | Experimental \ No newline at end of file +Space Supporter | diff --git a/docs/v3/source/includes/resources/service_credential_bindings/_object.md.erb b/docs/v3/source/includes/resources/service_credential_bindings/_object.md.erb index a3f73152141..a477c3922f8 100644 --- a/docs/v3/source/includes/resources/service_credential_bindings/_object.md.erb +++ b/docs/v3/source/includes/resources/service_credential_bindings/_object.md.erb @@ -19,7 +19,7 @@ Name | Type | Description **guid** | _uuid_ | Unique identifier for the service credential binding **name** | _string_ | Name of the binding. `null` when it's not defined. **type** | _string_ | Either `app` or `key` -**last_operation** (*experimental*)| _[last operation object](#the-last-operation-object-for-service-credential-binding)_ | The last operation of this binding +**last_operation** | _[last operation object](#the-last-operation-object-for-service-credential-binding)_ | The last operation of this binding **created_at** | _[timestamp](#timestamps)_ | The time with zone when the object was created **updated_at** | _[timestamp](#timestamps)_ | The time with zone when the object was last updated **metadata.labels** | [_label object_](#labels) | Labels applied to the service credential binding diff --git a/docs/v3/source/includes/resources/service_credential_bindings/_parameters.md.erb b/docs/v3/source/includes/resources/service_credential_bindings/_parameters.md.erb index 57657a5960b..06fa65187be 100644 --- a/docs/v3/source/includes/resources/service_credential_bindings/_parameters.md.erb +++ b/docs/v3/source/includes/resources/service_credential_bindings/_parameters.md.erb @@ -33,9 +33,9 @@ This endpoint is not available for User-Provided Service Instances. `GET /v3/service_credential_bindings/:guid/parameters` #### Permitted roles -Role | Notes ---- | --- + | +--- | Admin | Admin Read-Only | Space Developer | -Space Supporter | Experimental \ No newline at end of file +Space Supporter | diff --git a/docs/v3/source/includes/resources/service_instances/_delete.md.erb b/docs/v3/source/includes/resources/service_instances/_delete.md.erb index ee6246ed394..fa4a6e2dabd 100644 --- a/docs/v3/source/includes/resources/service_instances/_delete.md.erb +++ b/docs/v3/source/includes/resources/service_instances/_delete.md.erb @@ -49,7 +49,7 @@ Name | Type | Description ---- | ---- | ------------ **purge** | _boolean_ | If `true`, deletes the service instance and all associated resources without any interaction with the service broker. -#### Permitted Roles +#### Permitted roles | --- | --- Admin | diff --git a/docs/v3/source/includes/resources/service_instances/_get.md.erb b/docs/v3/source/includes/resources/service_instances/_get.md.erb index a2f9de32ef6..2e817428223 100644 --- a/docs/v3/source/includes/resources/service_instances/_get.md.erb +++ b/docs/v3/source/includes/resources/service_instances/_get.md.erb @@ -56,8 +56,8 @@ service_plan.service_offering| `name`, `guid`, `description`, `documentation_url service_plan.service_offering.service_broker| `name`, `guid` #### Permitted roles -Role | Notes ---- | --- + | +--- | Admin | Admin Read-Only | Global Auditor | @@ -65,4 +65,4 @@ Org Manager | Space Auditor | Space Developer | Space Manager | -Space Supporter | Experimental \ No newline at end of file +Space Supporter | diff --git a/docs/v3/source/includes/resources/service_instances/_list.md.erb b/docs/v3/source/includes/resources/service_instances/_list.md.erb index d647cd454f6..ffda74cd2d4 100644 --- a/docs/v3/source/includes/resources/service_instances/_list.md.erb +++ b/docs/v3/source/includes/resources/service_instances/_list.md.erb @@ -40,8 +40,8 @@ Name | Type | Description **order_by** | _string_ | Value to sort by. Defaults to ascending; prepend with `-` to sort descending
Valid values are `created_at`, `updated_at`, and `name` **label_selector** | _string_ | A query string containing a list of [label selector](#labels-and-selectors) requirements **fields** | [_fields parameter_](#fields-parameter) | [_Allowed values_](#service-instances-list-fields) -**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) ##### Service Instances List Fields diff --git a/docs/v3/source/includes/resources/service_instances/_list_shared_spaces.md.erb b/docs/v3/source/includes/resources/service_instances/_list_shared_spaces.md.erb index 98e48434dfe..fbe0526fa07 100644 --- a/docs/v3/source/includes/resources/service_instances/_list_shared_spaces.md.erb +++ b/docs/v3/source/includes/resources/service_instances/_list_shared_spaces.md.erb @@ -39,8 +39,8 @@ space | `guid`, `name`, `relationships.organization` space.organization| `guid`, `name` #### Permitted roles (in the service instance's originating space) -Role | Notes ---- | --- + | +--- | Admin | Admin Read-Only | Global Auditor | @@ -48,4 +48,4 @@ Org Manager | Space Auditor | Space Developer | Space Manager | -Space Supporter | Experimental \ No newline at end of file +Space Supporter | diff --git a/docs/v3/source/includes/resources/service_instances/_update.md.erb b/docs/v3/source/includes/resources/service_instances/_update.md.erb index 0f5d302bab5..e8bddc1ae2a 100644 --- a/docs/v3/source/includes/resources/service_instances/_update.md.erb +++ b/docs/v3/source/includes/resources/service_instances/_update.md.erb @@ -35,7 +35,7 @@ curl "https://api.example.org/v3/service_instances/[guid]" \ ``` ``` -(Experimental) Example Request for Managed Service Instance Upgrade (maintenance_info update) +Example Request for Managed Service Instance Upgrade (maintenance_info update) ``` ```shell @@ -72,7 +72,7 @@ Location: https://api.example.org/v3/jobs/af5c57f6-8769-41fa-a499-2c84ed896788 ``` ``` -(Experimental) Example Request for User-Provided Service Instance +Example Request for User-Provided Service Instance ``` ```shell @@ -101,7 +101,7 @@ curl "https://api.example.org/v3/service_instances/[guid]" \ ``` ``` -(Experimental) Example Response for User-Provided Service Instance +Example Response for User-Provided Service Instance ``` ```http diff --git a/docs/v3/source/includes/resources/service_offerings/_list.md.erb b/docs/v3/source/includes/resources/service_offerings/_list.md.erb index c46040a3184..5558451d382 100644 --- a/docs/v3/source/includes/resources/service_offerings/_list.md.erb +++ b/docs/v3/source/includes/resources/service_offerings/_list.md.erb @@ -37,12 +37,12 @@ Name | Type | Description **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 **label_selector** | _string_ | A query string containing a list of [label selector](#labels-and-selectors) requirements -**fields** (*experimental*)| [_fields parameter_](#fields-parameter) | [_Allowed values_](#service-offerings-list-fields) +**fields** | [_fields parameter_](#fields-parameter) | [_Allowed values_](#service-offerings-list-fields) **page** | _integer_ | Page to display; valid values are integers >= 1 **per_page** | _integer_ | Number of results per page;
valid values are 1 through 5000 **order_by** | _string_ | Value to sort by. Defaults to ascending; prepend with `-` to sort descending
Valid values are `created_at`, `updated_at` and `name` -**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) ##### Service Offerings List Fields diff --git a/docs/v3/source/includes/resources/service_plans/_list.md.erb b/docs/v3/source/includes/resources/service_plans/_list.md.erb index 8282cddcb8c..43a964fbd5f 100644 --- a/docs/v3/source/includes/resources/service_plans/_list.md.erb +++ b/docs/v3/source/includes/resources/service_plans/_list.md.erb @@ -45,9 +45,9 @@ Name | Type | Description **per_page** | _integer_ | Number of results per page;
valid values are 1 through 5000 **order_by** | _string_ | Value to sort by. Defaults to ascending; prepend with `-` to sort descending.
Valid values are `created_at`, `updated_at`, `name` **label_selector** | _string_ | A query string containing a list of [label selector](#labels-and-selectors) requirements -**fields** (*experimental*)| [_fields parameter_](#fields-parameter) | [_Allowed values_](#service-plans-list-fields) -**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) +**fields** | [_fields parameter_](#fields-parameter) | [_Allowed values_](#service-plans-list-fields) +**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) The **organization_guids** and **space_guids** filters do not filter plans that are public. They both act on plans that are restricted to certain organizations, and to plans from space-scoped diff --git a/docs/v3/source/includes/resources/service_route_bindings/_create.md.erb b/docs/v3/source/includes/resources/service_route_bindings/_create.md.erb index 374493e9f3e..15bce7d0009 100644 --- a/docs/v3/source/includes/resources/service_route_bindings/_create.md.erb +++ b/docs/v3/source/includes/resources/service_route_bindings/_create.md.erb @@ -87,8 +87,8 @@ Name | Type | Description | #### Permitted roles -Role | Notes ---- | --- + | +--- | Admin | Space Developer | -Space Supporter | Experimental +Space Supporter | diff --git a/docs/v3/source/includes/resources/service_route_bindings/_delete.md.erb b/docs/v3/source/includes/resources/service_route_bindings/_delete.md.erb index e086934870a..2e11cdc0c80 100644 --- a/docs/v3/source/includes/resources/service_route_bindings/_delete.md.erb +++ b/docs/v3/source/includes/resources/service_route_bindings/_delete.md.erb @@ -36,9 +36,9 @@ responds with a job which can be used to track the progress of the delete operat #### Definition `DELETE /v3/service_route_bindings/:guid` -#### Permitted Roles -Role | Notes ---- | --- +#### Permitted roles + | +--- | Admin | Space Developer | -Space Supporter | Experimental \ No newline at end of file +Space Supporter | diff --git a/docs/v3/source/includes/resources/service_route_bindings/_get.md.erb b/docs/v3/source/includes/resources/service_route_bindings/_get.md.erb index 3c72719fa95..618c4919668 100644 --- a/docs/v3/source/includes/resources/service_route_bindings/_get.md.erb +++ b/docs/v3/source/includes/resources/service_route_bindings/_get.md.erb @@ -33,8 +33,8 @@ Name | Type | Description **include** | _list of strings_ | Optionally include a list of unique related resources in the response. Valid values are: `route`, `service_instance` #### Permitted roles -Role | Notes ---- | --- + | +--- | Admin | Admin Read-Only | Global Auditor | @@ -42,4 +42,4 @@ Org Manager | Space Auditor | Space Developer | Space Manager | -Space Supporter | Experimental \ No newline at end of file +Space Supporter | diff --git a/docs/v3/source/includes/resources/service_route_bindings/_list.md.erb b/docs/v3/source/includes/resources/service_route_bindings/_list.md.erb index 68ef371dcd0..3c693567093 100644 --- a/docs/v3/source/includes/resources/service_route_bindings/_list.md.erb +++ b/docs/v3/source/includes/resources/service_route_bindings/_list.md.erb @@ -36,8 +36,8 @@ Name | Type | Description **service_instance_names** | _list of strings_ | Comma-delimited list of service instance names to filter by **label_selector** | _string_ | A query string containing a list of [label selector](#labels-and-selectors) requirements **guids** | _list of strings_ | Comma-delimited list of service route binding 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) -**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) **include** | _list of strings_ | Optionally include a list of unique related resources in the response. Valid values are: `route`, `service_instance` **page** | _integer_ | Page to display; valid values are integers >= 1 **per_page** | _integer_ | Number of results per page;
valid values are 1 through 5000 @@ -45,7 +45,7 @@ Name | Type | Description #### Permitted roles | ---- | --- +--- | Admin | Admin Read-Only | Global Auditor | @@ -53,4 +53,4 @@ Org Manager | Space Auditor | Space Developer | Space Manager | -Space Supporter | Experimental +Space Supporter | diff --git a/docs/v3/source/includes/resources/service_usage_events/_delete.md.erb b/docs/v3/source/includes/resources/service_usage_events/_delete.md.erb index e05f78c7c99..7cfb0c208d7 100644 --- a/docs/v3/source/includes/resources/service_usage_events/_delete.md.erb +++ b/docs/v3/source/includes/resources/service_usage_events/_delete.md.erb @@ -24,7 +24,7 @@ Destroys all existing events. Populates new usage events, one for each existing `POST /v3/service_usage_events/actions/destructively_purge_all_and_reseed` -#### Permitted Roles +#### Permitted roles | --- | --- Admin | diff --git a/docs/v3/source/includes/resources/service_usage_events/_get.md.erb b/docs/v3/source/includes/resources/service_usage_events/_get.md.erb index 8d663658a11..37429b88800 100644 --- a/docs/v3/source/includes/resources/service_usage_events/_get.md.erb +++ b/docs/v3/source/includes/resources/service_usage_events/_get.md.erb @@ -27,7 +27,7 @@ Retrieve a service usage event. `GET /v3/service_usage_events/:guid` -#### Permitted Roles +#### Permitted roles | --- | --- Admin | diff --git a/docs/v3/source/includes/resources/service_usage_events/_list.md.erb b/docs/v3/source/includes/resources/service_usage_events/_list.md.erb index a9f9f3da8b6..405e43432a1 100644 --- a/docs/v3/source/includes/resources/service_usage_events/_list.md.erb +++ b/docs/v3/source/includes/resources/service_usage_events/_list.md.erb @@ -38,10 +38,10 @@ Name | Type | Description **guids** | _list of strings_ | Comma-delimited list of usage event guids to filter by **service_instance_types** | _list of strings_ | Comma-delimited list of service instance types to filter by; valid values are `managed_service_instance` and `user_provided_service_instance` **service_offering_guids** | _list of strings_ | Comma-delimited list of service offering 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) -**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 +#### Permitted roles | --- | --- All Roles | diff --git a/docs/v3/source/includes/resources/sidecars/_get.md.erb b/docs/v3/source/includes/resources/sidecars/_get.md.erb index f17a10674eb..67461b9b30a 100644 --- a/docs/v3/source/includes/resources/sidecars/_get.md.erb +++ b/docs/v3/source/includes/resources/sidecars/_get.md.erb @@ -26,7 +26,7 @@ Content-Type: application/json #### Permitted roles | ---- | --- +--- | Admin | Admin Read-Only | Global Auditor | @@ -34,4 +34,4 @@ Org Manager | Space Auditor | Space Developer | Space Manager | -Space Supporter | Experimental +Space Supporter | diff --git a/docs/v3/source/includes/resources/sidecars/_list_for_app.md.erb b/docs/v3/source/includes/resources/sidecars/_list_for_app.md.erb index 8de23d98362..8bbaf81389c 100644 --- a/docs/v3/source/includes/resources/sidecars/_list_for_app.md.erb +++ b/docs/v3/source/includes/resources/sidecars/_list_for_app.md.erb @@ -33,12 +33,12 @@ Name | Type | Description **page** | _integer_ | Page to display; valid values are integers >= 1 **per_page** | _integer_ | Number of results per page;
valid values are 1 through 5000 **order_by** | _string_ | Value to sort by. Defaults to ascending; prepend with `-` to sort descending.
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 | ---- | --- +--- | Admin | Admin Read-Only | Global Auditor | @@ -46,4 +46,4 @@ Org Manager | Space Auditor | Space Developer | Space Manager | -Space Supporter | Experimental +Space Supporter | diff --git a/docs/v3/source/includes/resources/sidecars/_list_for_process.md.erb b/docs/v3/source/includes/resources/sidecars/_list_for_process.md.erb index 52b48899ba4..85d6e82feec 100644 --- a/docs/v3/source/includes/resources/sidecars/_list_for_process.md.erb +++ b/docs/v3/source/includes/resources/sidecars/_list_for_process.md.erb @@ -33,8 +33,8 @@ Name | Type | Description **page** | _integer_ | Page to display; valid values are integers >= 1 **per_page** | _integer_ | Number of results per page;
valid values are 1 through 5000 **order_by** | _string_ | Value to sort by. Defaults to ascending; prepend with `-` to sort descending.
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 | @@ -46,4 +46,4 @@ Org Manager | Space Auditor | Space Developer | Space Manager | -Space Supporter | Experimental +Space Supporter | diff --git a/docs/v3/source/includes/resources/space_features/_get.md.erb b/docs/v3/source/includes/resources/space_features/_get.md.erb index cab18ceaa47..3f23c34a982 100644 --- a/docs/v3/source/includes/resources/space_features/_get.md.erb +++ b/docs/v3/source/includes/resources/space_features/_get.md.erb @@ -25,8 +25,8 @@ Content-Type: application/json `GET /v3/spaces/:guid/features/:name` #### Permitted roles - Role | Notes ---- | --- | + | +--- | Admin | Admin Read-Only | Global Auditor | @@ -34,4 +34,4 @@ Org Manager | Space Auditor | Space Developer | Space Manager | -Space Supporter | Experimental | +Space Supporter | diff --git a/docs/v3/source/includes/resources/space_features/_list.md.erb b/docs/v3/source/includes/resources/space_features/_list.md.erb index a5856c017d1..af1c75892f8 100644 --- a/docs/v3/source/includes/resources/space_features/_list.md.erb +++ b/docs/v3/source/includes/resources/space_features/_list.md.erb @@ -27,8 +27,8 @@ Content-Type: application/json `GET /v3/spaces/:guid/features` #### Permitted roles - Role | Notes ---- | --- + | +--- | Admin | Admin Read-Only | Global Auditor | @@ -36,4 +36,4 @@ Org Manager | Space Auditor | Space Developer | Space Manager | -Space Supporter | Experimental | +Space Supporter | diff --git a/docs/v3/source/includes/resources/space_quotas/_list.md.erb b/docs/v3/source/includes/resources/space_quotas/_list.md.erb index 0af7029b95b..891d24658b4 100644 --- a/docs/v3/source/includes/resources/space_quotas/_list.md.erb +++ b/docs/v3/source/includes/resources/space_quotas/_list.md.erb @@ -37,8 +37,8 @@ Name | Type | Description **page** | _integer_ | Page to display; valid values are integers >= 1 **per_page** | _integer_ | Number of results per page;
valid values are 1 through 5000 **order_by** | _string_ | Value to sort by. Defaults to ascending; prepend with `-` to sort descending.
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 diff --git a/docs/v3/source/includes/resources/spaces/_delete.md b/docs/v3/source/includes/resources/spaces/_delete.md index 016b925a939..3f6c930abea 100644 --- a/docs/v3/source/includes/resources/spaces/_delete.md +++ b/docs/v3/source/includes/resources/spaces/_delete.md @@ -27,8 +27,8 @@ Location: https://api.example.org/v3/jobs/[guid] #### Permitted roles -Role | Notes ---- | --- + | +--- | Admin | Org Manager | diff --git a/docs/v3/source/includes/resources/spaces/_get_a_space.md.erb b/docs/v3/source/includes/resources/spaces/_get_a_space.md.erb index 10763e5d124..8662a7a103b 100644 --- a/docs/v3/source/includes/resources/spaces/_get_a_space.md.erb +++ b/docs/v3/source/includes/resources/spaces/_get_a_space.md.erb @@ -35,8 +35,8 @@ Name | Type | Description #### Permitted roles - Role | Notes ---- | --- | + | +--- | Admin | Admin Read-Only | Global Auditor | @@ -44,4 +44,4 @@ Org Manager | Space Auditor | Space Developer | Space Manager | -Space Supporter | Experimental | +Space Supporter | diff --git a/docs/v3/source/includes/resources/spaces/_list.md.erb b/docs/v3/source/includes/resources/spaces/_list.md.erb index 422d133a4df..c27d4128e8a 100644 --- a/docs/v3/source/includes/resources/spaces/_list.md.erb +++ b/docs/v3/source/includes/resources/spaces/_list.md.erb @@ -38,8 +38,8 @@ Name | Type | Description **order_by** | _string_ | Value to sort by. Defaults to ascending; prepend with `-` to sort descending.
Valid values are `created_at`, `updated_at`, `name` **label_selector** | _string_ | A query string containing a list of [label selector](#labels-and-selectors) requirements **include** | _string_ | Optionally include a list of unique related resources in the response;
valid value is `organization` -**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/spaces/_list_users.md.erb b/docs/v3/source/includes/resources/spaces/_list_users.md.erb index 161551aed38..392dffae5bf 100644 --- a/docs/v3/source/includes/resources/spaces/_list_users.md.erb +++ b/docs/v3/source/includes/resources/spaces/_list_users.md.erb @@ -37,12 +37,12 @@ Name | Type | Description **per_page** | _integer_ | Number of results per page;
valid values are 1 through 5000 **order_by** | _string_ | Value to sort by. Defaults to ascending; prepend with `-` to sort descending
Valid values are `created_at` and `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 - Role | Notes ---- | --- + | +--- | Admin | Admin Read-Only | Global Auditor | @@ -50,4 +50,4 @@ Org Manager | Space Auditor | Space Developer | Space Manager | -Space Supporter | Experimental +Space Supporter | diff --git a/docs/v3/source/includes/resources/spaces/get_assigned_isolation_segment.md.erb b/docs/v3/source/includes/resources/spaces/get_assigned_isolation_segment.md.erb index 45ea8f9dc8e..e21206bb707 100644 --- a/docs/v3/source/includes/resources/spaces/get_assigned_isolation_segment.md.erb +++ b/docs/v3/source/includes/resources/spaces/get_assigned_isolation_segment.md.erb @@ -25,8 +25,8 @@ Content-Type: application/json `GET /v3/spaces/:guid/relationships/isolation_segment` #### Permitted roles - Role | Notes ---- | --- | + | +--- | Admin | Admin Read-Only | Global Auditor | @@ -34,4 +34,4 @@ Org Manager | Space Auditor | Space Developer | Space Manager | -Space Supporter | Experimental | +Space Supporter | diff --git a/docs/v3/source/includes/resources/stacks/_apps.md.erb b/docs/v3/source/includes/resources/stacks/_apps.md.erb index faa824e7f1e..11011eec10e 100644 --- a/docs/v3/source/includes/resources/stacks/_apps.md.erb +++ b/docs/v3/source/includes/resources/stacks/_apps.md.erb @@ -34,10 +34,10 @@ Name | Type | Description **per_page** | _integer_ | Number of results per page;
valid values are 1 through 5000 **order_by** | _string_ | Value to sort by. Defaults to ascending; prepend with `-` to sort descending
Valid values are `created_at`, `updated_at`, and `name` **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 -| + | --- | --- -All Roles | \ No newline at end of file +All Roles | diff --git a/docs/v3/source/includes/resources/stacks/_list.md.erb b/docs/v3/source/includes/resources/stacks/_list.md.erb index 56b48ae4756..569bdb7abb2 100644 --- a/docs/v3/source/includes/resources/stacks/_list.md.erb +++ b/docs/v3/source/includes/resources/stacks/_list.md.erb @@ -35,8 +35,8 @@ Name | Type | Description **per_page** | _integer_ | Number of results per page;
valid values are 1 through 5000 **order_by** | _string_ | Value to sort by. Defaults to ascending; prepend with `-` to sort descending
Valid values are `created_at`, `updated_at`, and `name` **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/tasks/_cancel.md.erb b/docs/v3/source/includes/resources/tasks/_cancel.md.erb index 35be8acb473..d6a80f5bec8 100644 --- a/docs/v3/source/includes/resources/tasks/_cancel.md.erb +++ b/docs/v3/source/includes/resources/tasks/_cancel.md.erb @@ -34,8 +34,8 @@ Canceling a task that is in `SUCCEEDED` or `FAILED` state will return an error. `PUT /v3/tasks/:guid/cancel` _(Deprecated)_ #### Permitted roles - Role | Notes + | --- | --- Admin | Space Developer | -Space Supporter | Experimental +Space Supporter | diff --git a/docs/v3/source/includes/resources/tasks/_get.md.erb b/docs/v3/source/includes/resources/tasks/_get.md.erb index e3c5576b0e6..3860c5cde89 100644 --- a/docs/v3/source/includes/resources/tasks/_get.md.erb +++ b/docs/v3/source/includes/resources/tasks/_get.md.erb @@ -37,4 +37,4 @@ Org Manager | `command` field redacted Space Auditor | `command` field redacted Space Developer | Space Manager | `command` field redacted -Space Supporter | Experimental, `command` field redacted +Space Supporter | `command` field redacted diff --git a/docs/v3/source/includes/resources/tasks/_list.md.erb b/docs/v3/source/includes/resources/tasks/_list.md.erb index 4eed85af40f..376d07c0de6 100644 --- a/docs/v3/source/includes/resources/tasks/_list.md.erb +++ b/docs/v3/source/includes/resources/tasks/_list.md.erb @@ -40,8 +40,8 @@ Name | Type | Description **per_page** | _integer_ | Number of results per page;
valid values are 1 through 5000 **order_by** | _string_ | Value to sort by. Defaults to ascending; prepend with `-` to sort descending.
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 | diff --git a/docs/v3/source/includes/resources/tasks/_list_for_app.md.erb b/docs/v3/source/includes/resources/tasks/_list_for_app.md.erb index 779524102a8..ab32776f2de 100644 --- a/docs/v3/source/includes/resources/tasks/_list_for_app.md.erb +++ b/docs/v3/source/includes/resources/tasks/_list_for_app.md.erb @@ -39,8 +39,8 @@ Name | Type | Description **per_page** | _integer_ | Number of results per page;
valid values are 1 through 5000 **order_by** | _string_ | Value to sort by. Defaults to ascending; prepend with `-` to sort descending.
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 Role | Notes @@ -52,4 +52,4 @@ Org Manager | `command` field redacted Space Auditor | `command` field redacted Space Developer | Space Manager | `command` field redacted -Space Supporter | Experimental, `command` field redacted +Space Supporter | `command` field redacted diff --git a/docs/v3/source/includes/resources/users/_create.md.erb b/docs/v3/source/includes/resources/users/_create.md.erb index 63163ba7b66..89066b3384c 100644 --- a/docs/v3/source/includes/resources/users/_create.md.erb +++ b/docs/v3/source/includes/resources/users/_create.md.erb @@ -44,6 +44,6 @@ Name | Type | Description #### Permitted roles -Role | Notes ------ | --- + | +----- | Admin | diff --git a/docs/v3/source/includes/resources/users/_delete.md.erb b/docs/v3/source/includes/resources/users/_delete.md.erb index 5f3c3ad0334..82706e594e2 100644 --- a/docs/v3/source/includes/resources/users/_delete.md.erb +++ b/docs/v3/source/includes/resources/users/_delete.md.erb @@ -26,7 +26,7 @@ Location: https://api.example.org/v3/jobs/[guid] #### Permitted roles -Role | Notes + | --- | --- Admin | diff --git a/docs/v3/source/includes/resources/users/_get.md.erb b/docs/v3/source/includes/resources/users/_get.md.erb index 58ca2b514af..6973e53acbd 100644 --- a/docs/v3/source/includes/resources/users/_get.md.erb +++ b/docs/v3/source/includes/resources/users/_get.md.erb @@ -36,6 +36,6 @@ Org Manager | Can only view users affiliated with their org Space Auditor | Can only view users affiliated with their org Space Developer | Can only view users affiliated with their org Space Manager | Can only view users affiliated with their org -Space Supporter | Experimental; Can only view users affiliated with their org +Space Supporter | Can only view users affiliated with their org **Note:** A user can always see themselves with this endpoint, regardless of role. diff --git a/docs/v3/source/includes/resources/users/_list.md.erb b/docs/v3/source/includes/resources/users/_list.md.erb index efef91a1b74..1d0759c0f0f 100644 --- a/docs/v3/source/includes/resources/users/_list.md.erb +++ b/docs/v3/source/includes/resources/users/_list.md.erb @@ -37,8 +37,8 @@ Name | Type | Description **per_page** | _integer_ | Number of results per page;
valid values are 1 through 5000 **order_by** | _string_ | Value to sort by. Defaults to ascending; prepend with `-` to sort descending
Valid values are `created_at` and `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 Role | Notes @@ -52,4 +52,4 @@ Org Manager | Can only view users affiliated with their org Space Auditor | Can only view users affiliated with their org Space Developer | Can only view users affiliated with their org Space Manager | Can only view users affiliated with their org -Space Supporter | Experimental; Can only view users affiliated with their org +Space Supporter | Can only view users affiliated with their org diff --git a/docs/v3/source/includes/upgrade_guide/conceptual_changes/_resource_summaries.md b/docs/v3/source/includes/upgrade_guide/conceptual_changes/_resource_summaries.md index bb7e6020ace..000fbe54166 100644 --- a/docs/v3/source/includes/upgrade_guide/conceptual_changes/_resource_summaries.md +++ b/docs/v3/source/includes/upgrade_guide/conceptual_changes/_resource_summaries.md @@ -23,11 +23,11 @@ filter by the parent resource. See below for examples of summaries in V3. Passing `include=space` will include the space resource in the response body. - To fetch all service offerings in a space use `GET /v3/service_offerings?space_guids=`. Use the - experimental `fields` parameter to include related information in the response + `fields` parameter to include related information in the response body. - To fetch all service instances in a space use `GET /v3/service_instances?space_guids=`. Use the - experimental `fields` parameter to include related information in the response + `fields` parameter to include related information in the response body. ##### Replacing the space summary response for service instances