From 8afe4698d2868d526f00fcb06ffa1268f3865744 Mon Sep 17 00:00:00 2001 From: Will Gant Date: Wed, 9 Jun 2021 12:59:18 +0100 Subject: [PATCH] Use a consistent format for roles table notes Also adds missing table headers for roles tables that have notes, as the absence of these prevents the second column from rendering. --- .../source/includes/resources/service_brokers/_delete.md.erb | 4 ++-- docs/v3/source/includes/resources/service_brokers/_get.md.erb | 4 ++-- .../v3/source/includes/resources/service_brokers/_list.md.erb | 4 ++-- .../source/includes/resources/service_brokers/_update.md.erb | 4 ++-- .../includes/resources/service_offerings/_delete.md.erb | 4 ++-- .../includes/resources/service_offerings/_update.md.erb | 4 ++-- .../v3/source/includes/resources/service_plans/_delete.md.erb | 4 ++-- .../v3/source/includes/resources/service_plans/_update.md.erb | 4 ++-- docs/v3/source/includes/resources/space_features/_get.md.erb | 2 +- docs/v3/source/includes/resources/space_features/_list.md.erb | 2 +- docs/v3/source/includes/resources/spaces/_get_a_space.md.erb | 2 +- .../resources/spaces/get_assigned_isolation_segment.md.erb | 2 +- 12 files changed, 20 insertions(+), 20 deletions(-) diff --git a/docs/v3/source/includes/resources/service_brokers/_delete.md.erb b/docs/v3/source/includes/resources/service_brokers/_delete.md.erb index 89803e670ca..7e91a15cb54 100644 --- a/docs/v3/source/includes/resources/service_brokers/_delete.md.erb +++ b/docs/v3/source/includes/resources/service_brokers/_delete.md.erb @@ -26,8 +26,8 @@ This endpoint creates a job to delete an existing service broker. The `Location` `DELETE /v3/service_brokers/:guid` #### Permitted roles - | +Role | Notes --- | --- Admin | -Space Developer (only space-scoped brokers) | +Space Developer | Only space-scoped brokers | 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 c155e31604d..2322bf1221b 100644 --- a/docs/v3/source/includes/resources/service_brokers/_get.md.erb +++ b/docs/v3/source/includes/resources/service_brokers/_get.md.erb @@ -27,9 +27,9 @@ This endpoint retrieves the service broker by GUID. `GET /v3/service_brokers/:guid` #### Permitted roles - | +Role | Notes --- | --- Admin | Admin Read-Only | Global Auditor | -Space Developer (only space-scoped brokers) | +Space Developer | 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 d7ce2e0afd0..cb8675d257a 100644 --- a/docs/v3/source/includes/resources/service_brokers/_list.md.erb +++ b/docs/v3/source/includes/resources/service_brokers/_list.md.erb @@ -40,9 +40,9 @@ Name | Type | Description **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) #### Permitted roles - | +Role | Notes --- | --- Admin | Admin Read-Only | Global Auditor | -Space Developer (only space-scoped brokers) | +Space Developer | Only space-scoped brokers diff --git a/docs/v3/source/includes/resources/service_brokers/_update.md.erb b/docs/v3/source/includes/resources/service_brokers/_update.md.erb index c71d6e2b99b..c68f4340ae0 100644 --- a/docs/v3/source/includes/resources/service_brokers/_update.md.erb +++ b/docs/v3/source/includes/resources/service_brokers/_update.md.erb @@ -80,7 +80,7 @@ Name | Type | Description <%= yield_content :service_broker_credentials_object %> #### Permitted roles - | +Role | Notes --- | --- Admin | -Space Developer (only space-scoped brokers) | +Space Developer | Only space-scoped brokers diff --git a/docs/v3/source/includes/resources/service_offerings/_delete.md.erb b/docs/v3/source/includes/resources/service_offerings/_delete.md.erb index 0a847335893..16ee9221cae 100644 --- a/docs/v3/source/includes/resources/service_offerings/_delete.md.erb +++ b/docs/v3/source/includes/resources/service_offerings/_delete.md.erb @@ -35,7 +35,7 @@ Name | Type | Description **purge** | _boolean_ | If `true`, any service plans, instances, and bindings associated with this service offering will also be deleted #### Permitted roles - | +Role | Notes --- | --- Admin | -Space Developer (only service offerings from space-scoped brokers) | +Space Developer | Only service offerings from space-scoped brokers diff --git a/docs/v3/source/includes/resources/service_offerings/_update.md.erb b/docs/v3/source/includes/resources/service_offerings/_update.md.erb index e84857d419b..4efff01f91b 100644 --- a/docs/v3/source/includes/resources/service_offerings/_update.md.erb +++ b/docs/v3/source/includes/resources/service_offerings/_update.md.erb @@ -41,8 +41,8 @@ Name | Type | Description **metadata.annotations** | [_annotation object_](#annotations) | Annotations applied to the service offering #### Permitted roles - | +Role | Notes --- | --- Admin | -Space Developer (only for service offerings from space-scoped brokers) | +Space Developer | Only for service offerings from space-scoped brokers diff --git a/docs/v3/source/includes/resources/service_plans/_delete.md.erb b/docs/v3/source/includes/resources/service_plans/_delete.md.erb index 23ca2539e58..802c8cde34d 100644 --- a/docs/v3/source/includes/resources/service_plans/_delete.md.erb +++ b/docs/v3/source/includes/resources/service_plans/_delete.md.erb @@ -25,7 +25,7 @@ are no longer provided by the service broker. `DELETE /v3/service_plans/:guid` #### Permitted roles - | +Role | Notes --- | --- Admin | -Space Developer (only service plans from space-scoped brokers) | +Space Developer | Only service plans from space-scoped brokers diff --git a/docs/v3/source/includes/resources/service_plans/_update.md.erb b/docs/v3/source/includes/resources/service_plans/_update.md.erb index d02baaac83c..09063e25cbe 100644 --- a/docs/v3/source/includes/resources/service_plans/_update.md.erb +++ b/docs/v3/source/includes/resources/service_plans/_update.md.erb @@ -41,8 +41,8 @@ Name | Type | Description **metadata.annotations** | [_annotation object_](#annotations) | Annotations applied to the service plan #### Permitted roles - | +Role | Notes --- | --- Admin | -Space Developer (only for service plans from space-scoped brokers) | +Space Developer | Only for service plans from space-scoped brokers 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 77ecaad697e..845018ea121 100644 --- a/docs/v3/source/includes/resources/space_features/_get.md.erb +++ b/docs/v3/source/includes/resources/space_features/_get.md.erb @@ -25,7 +25,7 @@ Content-Type: application/json `GET /v3/spaces/:guid/features/:name` #### Permitted roles -Role | Notes | + Roles | Notes --- | --- | Admin | Admin Read-Only | 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 97a5ee2ec1c..a1774323888 100644 --- a/docs/v3/source/includes/resources/space_features/_list.md.erb +++ b/docs/v3/source/includes/resources/space_features/_list.md.erb @@ -27,7 +27,7 @@ Content-Type: application/json `GET /v3/spaces/:guid/features` #### Permitted roles -Role | Notes | + Roles | Notes --- | --- Admin | Admin Read-Only | 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 d56cd5b6c15..4ea2f2c9d54 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,7 +35,7 @@ Name | Type | Description #### Permitted roles -Role | Notes | + Roles | Notes --- | --- | Admin | Admin Read-Only | 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 208ecc5341a..9764881fb35 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,7 +25,7 @@ Content-Type: application/json `GET /v3/spaces/:guid/relationships/isolation_segment` #### Permitted roles -Role | Notes | + Roles | Notes --- | --- | Admin | Admin Read-Only |