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

Commit 7ce8c1d

Browse files
Change services endpoints docs capitalisation to be consistent with the
rest of the documentation [#171356816](https://www.pivotaltracker.com/story/show/171356816)
1 parent 1032050 commit 7ce8c1d

30 files changed

Lines changed: 125 additions & 125 deletions

docs/v3/source/includes/concepts/_fields.md.erb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Developers may choose to use the `fields` feature to reduce the number of API ca
1010
query param can be used with a single resource or a list of resources.
1111

1212
The fields query parameter may also grant visibility to parts of resources where the whole resource is not visible.
13-
For instance, the name of an Organization may be retrieved with fields, where the whole Organization resource may
13+
For instance, the name of an organization may be retrieved with fields, where the whole organization resource may
1414
not be visible.
1515

1616
### Fields parameter

docs/v3/source/includes/experimental_resources/service_bindings/_create.md.erb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ Name | Type | Description
5151
---- | ---- | -----------
5252
**type** | _string_ | Service binding type. Valid value is `app`.
5353
**relationships.app** | [_to-one relationship_](#to-one-relationships) | A relationship to an app.
54-
**relationships.service_instance** | [_to-one relationship_](#to-one-relationships) | A relationship to a service_instance.
54+
**relationships.service_instance** | [_to-one relationship_](#to-one-relationships) | A relationship to a service instance.
5555

5656
#### Optional parameters
5757

docs/v3/source/includes/experimental_resources/service_bindings/_object.md.erb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
### The service binding object
22

33
```
4-
Example Service Binding object
4+
Example service binding object
55
```
66
```json
77
<%= yield_content :single_service_binding %>

docs/v3/source/includes/experimental_resources/service_instances/_credentials.md.erb

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
### Get Credentials for a User-Provided Service Instance
1+
### Get credentials for a user-provided service instance
22

33
```
44
Example Request
@@ -21,8 +21,8 @@ Content-Type: application/json
2121
<%= yield_content :user_provided_service_instance_credentials %>
2222
```
2323

24-
Retrieves the credentials for a User-Provided Service Instance.
25-
This endpoint is not available for Managed Service Instances.
24+
Retrieves the credentials for a user-provided service instance.
25+
This endpoint is not available for managed service instances.
2626

2727
#### Definition
2828
`GET /v3/service_instances/:guid/credentials`

docs/v3/source/includes/experimental_resources/service_instances/_get.md.erb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
### Get a Service Instance
1+
### Get a service instance
22

33
```
44
Example Request

docs/v3/source/includes/experimental_resources/service_instances/_parameters.md.erb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
### Get Parameters for a Managed Service Instance
1+
### Get parameters for a managed service instance
22

33
```
44
Example Request

docs/v3/source/includes/resources/service_brokers/_jobs.md.erb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
### Service Broker Jobs
1+
### Service broker jobs
22

33
CRUD operations for service brokers are asynchronous. `create`, `update` and `delete` endpoints include a job URL in the `Location` header of the HTTP response.
44

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ Location: https://api.example.org/v3/jobs/af5c57f6-8769-41fa-a499-2c84ed896788
3939
This endpoint updates a broker and creates a job to synchronize the service offerings and service plans with those in the broker's catalog.
4040
The `Location` header refers to the created job which syncs the broker with the catalog. See [_Service broker jobs_](#service-broker-jobs) for more information and limitations.
4141

42-
Service Brokers that are in the process of being synchronized or deleted cannot be updated.
42+
Service brokers that are in the process of being synchronized or deleted cannot be updated.
4343

4444
#### Definition
4545
`PATCH /v3/service_brokers/[guid]`

docs/v3/source/includes/resources/service_instances/_object.md.erb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Name | Type | Description
2525
**syslog_drain_url** _(experimental)_| _string_ | URL to which logs for bound applications will be streamed. Only shown when type is `user-provided`.
2626
**route_service_url** _(experimental)_| _string_ | URL to which requests for bound routes will be forwarded. Only shown when type is `user-provided`.
2727
**maintenance_info** _(experimental)_| _[maintenance_info object](#the-maintenance-info-object-for-service-instances)_ | Information about the version of this service instance. Only shown when type is `managed`.
28-
**upgrade_available** _(experimental)_| _bool_ | Whether or not an upgrade of this Service Instance is available on the current Service Plan. Details are available in the maintenance_info object. Only shown when type is `managed`.
28+
**upgrade_available** _(experimental)_| _bool_ | Whether or not an upgrade of this service instance is available on the current Service Plan. Details are available in the maintenance_info object. Only shown when type is `managed`.
2929
**dashboard_url** _(experimental)_| _string_ | The URL to the service instance dashboard (or null if there is none). Only shown when type is `managed`.
3030
**last_operation** _(experimental)_| _[last operation object](#the-last-operation-object-for-service-instances)_ | The last operation of this service instance. Only shown when type is `managed`.
3131
**relationships.service_plan** | [_to-one relationship_](#to-one-relationships) | The service plan the service instance relates to. Only shown when type is `managed`.
@@ -39,7 +39,7 @@ Name | Type | Description
3939

4040
Name | Type | Description
4141
---- | ---- | -----------
42-
**version** | _string_ | The current semantic version of this Service Instance. Comparing this version with the version of the Service Plan can be used to determine whether or not this Service Instance is up to date with the Service Plan.
42+
**version** | _string_ | The current semantic version of this service instance. Comparing this version with the version of the Service Plan can be used to determine whether or not this service instance is up to date with the Service Plan.
4343
**description** | _string_ | A textual explanation associated with this version.
4444

4545

docs/v3/source/includes/resources/service_offerings/_delete.md.erb

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,12 +18,12 @@ Example Response
1818
HTTP/1.1 204 No Content
1919
```
2020

21-
This endpoint deletes a Service Offering. This is typically used to remove orphan Service Offerings from the Cloud
22-
Foundry database when they have been removed from the Service Broker catalog, or when the Service Broker has been
21+
This endpoint deletes a service offering. This is typically used to remove orphan service offerings from the Cloud
22+
Foundry database when they have been removed from the service broker catalog, or when the service broker has been
2323
removed.
2424

25-
Note that this operation only affects the Cloud Foundry database, and no attempt is made to contact the Service
26-
Broker.
25+
Note that this operation only affects the Cloud Foundry database, and no attempt is made to contact the service
26+
broker.
2727

2828
#### Definition
2929
`DELETE /v3/service_offerings/:guid`

0 commit comments

Comments
 (0)