Skip to content

Commit

Permalink
Merge pull request #2322 from sap-contributions/docs-table-columns
Browse files Browse the repository at this point in the history 
Use a consistent format for roles table notes in API docs
  • Loading branch information
@sweinstein22
sweinstein22 authored Jun 10, 2021
2 parents 2e5b0f7 + 7898d43 commit 4dcc0d8
Show file tree
Hide file tree
Showing 16 changed files with 24 additions and 24 deletions.
2 changes: 1 addition & 1 deletion docs/v3/source/includes/resources/domains/_get.md.erb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Content-Type: application/json

#### Permitted roles

Roles | Notes
Role | Notes
--- | ---
Admin |
Admin Read-Only |
Expand Down
2 changes: 1 addition & 1 deletion docs/v3/source/includes/resources/organizations/_get_default_domain.md.erb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Retrieve the default domain for a given organization.
`GET /v3/organizations/:guid/domains/default`

#### Permitted roles
Roles | Notes
Role | Notes
--- | ---
Admin |
Admin Read-Only |
Expand Down
4 changes: 2 additions & 2 deletions docs/v3/source/includes/resources/service_brokers/_delete.md.erb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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 |

4 changes: 2 additions & 2 deletions docs/v3/source/includes/resources/service_brokers/_get.md.erb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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)
4 changes: 2 additions & 2 deletions docs/v3/source/includes/resources/service_brokers/_list.md.erb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
4 changes: 2 additions & 2 deletions docs/v3/source/includes/resources/service_brokers/_update.md.erb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
4 changes: 2 additions & 2 deletions docs/v3/source/includes/resources/service_offerings/_delete.md.erb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
4 changes: 2 additions & 2 deletions docs/v3/source/includes/resources/service_offerings/_update.md.erb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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

4 changes: 2 additions & 2 deletions docs/v3/source/includes/resources/service_plans/_delete.md.erb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
4 changes: 2 additions & 2 deletions docs/v3/source/includes/resources/service_plans/_update.md.erb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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

2 changes: 1 addition & 1 deletion docs/v3/source/includes/resources/space_features/_get.md.erb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Content-Type: application/json
`GET /v3/spaces/:guid/features/:name`

#### Permitted roles
Role | Notes |
Role | Notes
--- | --- |
Admin |
Admin Read-Only |
Expand Down
2 changes: 1 addition & 1 deletion docs/v3/source/includes/resources/space_features/_list.md.erb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Content-Type: application/json
`GET /v3/spaces/:guid/features`

#### Permitted roles
Role | Notes |
Role | Notes
--- | ---
Admin |
Admin Read-Only |
Expand Down
2 changes: 1 addition & 1 deletion docs/v3/source/includes/resources/spaces/_get_a_space.md.erb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Name | Type | Description


#### Permitted roles
Role | Notes |
Role | Notes
--- | --- |
Admin |
Admin Read-Only |
Expand Down
2 changes: 1 addition & 1 deletion docs/v3/source/includes/resources/spaces/get_assigned_isolation_segment.md.erb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Content-Type: application/json
`GET /v3/spaces/:guid/relationships/isolation_segment`

#### Permitted roles
Role | Notes |
Role | Notes
--- | --- |
Admin |
Admin Read-Only |
Expand Down
2 changes: 1 addition & 1 deletion docs/v3/source/includes/resources/users/_get.md.erb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Content-Type: application/json
`GET /v3/users/:guid`

#### Permitted roles
Roles | Notes
Role | Notes
--- | ---
Admin |
Admin Read-Only |
Expand Down
2 changes: 1 addition & 1 deletion docs/v3/source/includes/resources/users/_list.md.erb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ 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
Roles | Notes
Role | Notes
--- | ---
Admin Read-Only |
Admin |
Expand Down

0 comments on commit 4dcc0d8

Please sign in to comment.