Skip to content

Document case sensitivity of name fields in API docs #5079

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
philippthun wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Document case sensitivity of name fields in API docs #5079

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion db/migrations/20130131184954_new_initial_schema.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@
create_table :frameworks do
VCAP::Migration.common(self)

String :name, null: false, case_insenstive: true
String :name, null: false
String :description, null: false
String :internal_info, null: false, size: 2048

Expand Down
2 changes: 1 addition & 1 deletion db/migrations/20130219194917_create_stacks_table.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
create_table :stacks do
VCAP::Migration.common(self)

String :name, null: false, case_insenstive: true
String :name, null: false
String :description, null: false

index :name, unique: true
Expand Down
2 changes: 1 addition & 1 deletion db/migrations/20141008205150_create_lockings.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
change do
create_table :lockings do
primary_key :id
String :name, null: false, case_insenstive: true
String :name, null: false
index :name, unique: true
end
end
Expand Down
2 changes: 1 addition & 1 deletion docs/v3/source/includes/resources/apps/_create.md.erb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ Content-Type: application/json

Name | Type | Description
---- | ---- | -----------
**name** | _string_ | Name of the app
**name** | _string_ | Name of the app; must be unique within the space (case-insensitive)
**relationships.space** | [_to-one relationship_](#to-one-relationships) | A relationship to a space

#### Optional parameters
Expand Down
4 changes: 2 additions & 2 deletions docs/v3/source/includes/resources/apps/_list.md.erb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,10 @@ Retrieve all apps the user has access to.
Name | Type | Description
---- | ---- | ------------
**guids** | _list of strings_ | Comma-delimited list of app guids to filter by
**names** | _list of strings_ | Comma-delimited list of app names to filter by
**names** | _list of strings_ | Comma-delimited list of app names to filter by (case-insensitive)
**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
**stacks** | _list of strings_ | Comma-delimited list of stack names to filter by
**stacks** | _list of strings_ | Comma-delimited list of stack names to filter by (case-sensitive)
**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`, `name`, `state`
Expand Down
2 changes: 1 addition & 1 deletion docs/v3/source/includes/resources/buildpacks/_create.md.erb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Content-Type: application/json

Name | Type | Description
------- | ------- | -----------
**name** | _string_ | Name of the buildpack
**name** | _string_ | Name of the buildpack; must be unique per stack (case-sensitive)

#### Optional parameters

Expand Down
4 changes: 2 additions & 2 deletions docs/v3/source/includes/resources/buildpacks/_list.md.erb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,8 @@ Name | Type | Description
---- | ---- | ------------
**page** | _integer_ | Page to display; valid values are integers >= 1
**per_page** | _integer_ | Number of results per page; <br>valid values are 1 through 5000
**names** | _list of strings_ | Comma-delimited list of buildpack names to filter by
**stacks**| _list of strings_ | Comma-delimited list of stack names to filter by
**names** | _list of strings_ | Comma-delimited list of buildpack names to filter by (case-sensitive)
**stacks**| _list of strings_ | Comma-delimited list of stack names to filter by (case-sensitive)
**lifecycle**| _string_ | Type of buildpack. Valid values are `buildpack` and `cnb`
**order_by** | _string_ | Value to sort by; defaults to ascending. Prepend with `-` to sort descending. <br>Valid values are `created_at`, `updated_at`, `lifecycle`, and `position`
**label_selector** | _string_ | A query string containing a list of [label selector](#labels-and-selectors) requirements
Expand Down
2 changes: 1 addition & 1 deletion docs/v3/source/includes/resources/domains/_create.md.erb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Content-Type: application/json

Name | Type | Description
------- | ------- | -----------
**name** | _string_ | Name of the domain
**name** | _string_ | Name of the domain; must be unique (case-insensitive)

#### Optional parameters

Expand Down
2 changes: 1 addition & 1 deletion docs/v3/source/includes/resources/domains/_list.md.erb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Retrieve all domains the user has access to.
| Name | Type | Description
| ------------ | --------- | -----------
| **guids** | _list of strings_ | Comma-delimited list of guids to filter by
| **names** | _list of strings_ | Comma-delimited list of domain names to filter by
| **names** | _list of strings_ | Comma-delimited list of domain names to filter by (case-insensitive)
| **organization_guids** | _list of strings_ | Comma-delimited list of owning organization guids to filter by
| **page** | _integer_ | Page to display; valid values are integers >= 1
| **per_page** | _integer_ | Number of results per page; <br>valid values are 1 through 5000
Expand Down
16 changes: 8 additions & 8 deletions docs/v3/source/includes/resources/domains/_list_domains_for_an_org.md.erb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,15 +32,15 @@ To retrieve the default domain for an organization, use the [get default domain]

#### Query parameters

| Name | Type | Description |
| ------------ | --------- | ----------- |
| **guids** | _list of strings_ | Comma-delimited list of guids to filter by |
| **names** | _list of strings_ | Comma-delimited list of domain names to filter by |
| **organization_guids** | _list of strings_ | Comma-delimited list of owning organization guids to filter by |
| **page** | _integer_ | Page to display; valid values are integers >= 1 |
| **per_page** | _integer_ | Number of results per page; <br>valid values are 1 through 5000 |
| Name | Type | Description
| ------------ | --------- | -----------
| **guids** | _list of strings_ | Comma-delimited list of guids to filter by
| **names** | _list of strings_ | Comma-delimited list of domain names to filter by (case-insensitive)
| **organization_guids** | _list of strings_ | Comma-delimited list of owning organization guids to filter by
| **page** | _integer_ | Page to display; valid values are integers >= 1
| **per_page** | _integer_ | Number of results per page; <br>valid values are 1 through 5000
| **order_by** | _string_ | Value to sort by. Defaults to ascending; prepend with `-` to sort descending<br>Valid values are `created_at`, `updated_at`
| **label_selector** | _string_ | A query string containing a list of [label selector](#labels-and-selectors) requirements |
| **label_selector** | _string_ | A query string containing a list of [label selector](#labels-and-selectors) requirements

#### Permitted roles

Expand Down
2 changes: 1 addition & 1 deletion docs/v3/source/includes/resources/isolation_segments/_create.md.erb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Content-Type: application/json

Name | Type | Description
---- | ---- | -----------
**name** | _string_ | Name of the isolation segment; isolation segment names must be unique across the entire system, and case is ignored when checking for uniqueness
**name** | _string_ | Name of the isolation segment; must be unique (case-insensitive)
**metadata.labels** | [_label object_](#labels) | Labels applied to the isolation segment
**metadata.annotations** | [_annotation object_](#annotations) | Annotations applied to the isolation segment

Expand Down
2 changes: 1 addition & 1 deletion docs/v3/source/includes/resources/isolation_segments/_list.md.erb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Retrieves all isolation segments to which the user has access. For admin, this
Name | Type | Description
---- | ---- | ------------
**guids** | _list of strings_ | Comma-delimited list of isolation segment guids to filter by
**names** | _list of strings_ | Comma-delimited list of isolation segment names to filter by
**names** | _list of strings_ | Comma-delimited list of isolation segment names to filter by (case-insensitive)
**organization_guids** | _list of strings_ | Comma-delimited list of organization guids to filter by
**page** | _integer_ | Page to display; valid values are integers >= 1
**per_page** | _integer_ | Number of results per page; <br>valid values are 1 through 5000
Expand Down
2 changes: 1 addition & 1 deletion docs/v3/source/includes/resources/organization_quotas/_create.md.erb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ To create an organization quota you must be an admin.

Name | Type | Description
---- | ---- | -----------
**name** | _string_ | Name of the quota
**name** | _string_ | Name of the quota (case-insensitive)

#### Optional parameters
Name | Type | Description | Default |
Expand Down
2 changes: 1 addition & 1 deletion docs/v3/source/includes/resources/organization_quotas/_list.md.erb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ This endpoint lists all organization quota resources.
Name | Type | Description
---- | ---- | -----------
**guids** | _list of strings_ | Comma-delimited list of organization quota guids to filter by
**names** | _list of strings_ | Comma-delimited list of organization quota names to filter by
**names** | _list of strings_ | Comma-delimited list of organization quota names to filter by (case-insensitive)
**organization_guids** | _list of strings_ | Comma-delimited list of organization guids to filter by
**page** | _integer_ | Page to display; valid values are integers >= 1
**per_page** | _integer_ | Number of results per page; <br>valid values are 1 through 5000
Expand Down
2 changes: 1 addition & 1 deletion docs/v3/source/includes/resources/organizations/_create.md.erb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Content-Type: application/json

Name | Type | Description
---- | ---- | -----------
**name** | _string_ | Organization name |
**name** | _string_ | Organization name; must be unique (case-insensitive) |

#### Optional parameters

Expand Down
2 changes: 1 addition & 1 deletion docs/v3/source/includes/resources/organizations/_list.md.erb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Retrieve all organizations the user has access to.

Name | Type | Description
---- | ---- | ------------
**names** | _list of strings_ | Comma-delimited list of organization names to filter by
**names** | _list of strings_ | Comma-delimited list of organization names to filter by (case-insensitive)
**guids** | _list of strings_ | Comma-delimited list of organization guids to filter by
**page** | _integer_ | Page to display; valid values are integers >= 1
**per_page** | _integer_ | Number of results per page; <br>valid values are 1 through 5000
Expand Down
2 changes: 1 addition & 1 deletion docs/v3/source/includes/resources/organizations/_list_for_isolation_segment.md.erb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Retrieve the organizations entitled to the isolation segment. Return only the or

Name | Type | Description
---- | ---- | ------------
**names** | _list of strings_ | Comma-delimited list of organization names to filter by
**names** | _list of strings_ | Comma-delimited list of organization names to filter by (case-insensitive)
**guids** | _list of strings_ | Comma-delimited list of organization guids to filter by
**page** | _integer_ | Page to display; valid values are integers >= 1
**per_page** | _integer_ | Number of results per page; <br>valid values are 1 through 5000
Expand Down
2 changes: 1 addition & 1 deletion docs/v3/source/includes/resources/security_groups/_create.md.erb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ Content-Type: application/json

Name | Type | Description
---- | ---- | -----------
**name** | _string_ | Name of the security group
**name** | _string_ | Name of the security group; must be unique (case-sensitive)

#### Optional parameters

Expand Down
2 changes: 1 addition & 1 deletion docs/v3/source/includes/resources/security_groups/_list.md.erb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Content-Type: application/json
Name | Type | Description
---- | ---- | -----------
**guids** | _list of strings_ | Comma-delimited list of security group guids to filter by
**names** | _list of strings_ | Comma-delimited list of security group names to filter by
**names** | _list of strings_ | Comma-delimited list of security group names to filter by (case-sensitive)
**globally_enabled_running** | _boolean_ | If true, only include the security groups that are enabled for running
**globally_enabled_staging** | _boolean_ | If true, only include the security groups that are enabled for staging
**running_space_guids** | _list of strings_ | Comma-delimited list of space guids to filter by
Expand Down
2 changes: 1 addition & 1 deletion docs/v3/source/includes/resources/security_groups/_list_running_security_groups.md.erb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ This endpoint returns security groups that are enabled for running globally or a
Name | Type | Description
---- | ---- | -----------
**guids** | _list of strings_ | Comma-delimited list of security group guids to filter by
**names** | _list of strings_ | Comma-delimited list of security group names to filter by
**names** | _list of strings_ | Comma-delimited list of security group names to filter by (case-sensitive)
**page** | _integer_ | Page to display; valid values are integers >= 1
**per_page** | _integer_ | Number of results per page; <br>valid values are 1 through 5000
**order_by** | _string_ | Value to sort by. Defaults to ascending; prepend with `-` to sort descending. <br>Valid values are `created_at`, `updated_at`
Expand Down
2 changes: 1 addition & 1 deletion docs/v3/source/includes/resources/security_groups/_list_staging_security_groups.md.erb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ This endpoint returns security groups that are enabled for staging globally or a
Name | Type | Description
---- | ---- | -----------
**guids** | _list of strings_ | Comma-delimited list of security group guids to filter by
**names** | _list of strings_ | Comma-delimited list of security group names to filter by
**names** | _list of strings_ | Comma-delimited list of security group names to filter by (case-sensitive)
**page** | _integer_ | Page to display; valid values are integers >= 1
**per_page** | _integer_ | Number of results per page; <br>valid values are 1 through 5000
**order_by** | _string_ | Value to sort by. Defaults to ascending; prepend with `-` to sort descending. <br>Valid values are `created_at`, `updated_at`
Expand Down
2 changes: 1 addition & 1 deletion docs/v3/source/includes/resources/service_brokers/_create.md.erb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ The `Location` header refers to the created job which syncs the broker with the

Name | Type | Description
---- | ---- | -----------
**name** | _string_ | Name of the service broker
**name** | _string_ | Name of the service broker; must be unique (case-sensitive)
**url** | _string_ | URL of the service broker
**authentication** | [_authentication_](#the-authentication-object) | Credentials used to authenticate against the service broker

Expand Down
2 changes: 1 addition & 1 deletion docs/v3/source/includes/resources/service_brokers/_list.md.erb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ This endpoint retrieves the service brokers the user has access to.

Name | Type | Description
---- | ---- | ------------
**names** | _list of strings_ | Comma-delimited list of service broker names to filter by
**names** | _list of strings_ | Comma-delimited list of service broker names to filter by (case-sensitive)
**page** | _integer_ | Page to display; valid values are integers >= 1
**per_page** | _integer_ | Number of results per page; <br>valid values are 1 through 5000
**space_guids** | _list of strings_ | Comma-delimited list of space GUIDs to filter by
Expand Down
10 changes: 5 additions & 5 deletions docs/v3/source/includes/resources/service_credential_bindings/_list.md.erb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,15 +31,15 @@ This endpoint retrieves the service credential bindings the user has access to.

Name | Type | Description
---- | ---- | ------------
**names** | _list of strings_ | Comma-delimited list of service credential binding names to filter by
**names** | _list of strings_ | Comma-delimited list of service credential binding names to filter by (case-sensitive)
**service_instance_guids** | _list of strings_ | Comma-delimited list of service instance guids to filter by
**service_instance_names** | _list of strings_ | Comma-delimited list of service instance names to filter by
**service_instance_names** | _list of strings_ | Comma-delimited list of service instance names to filter by (case-sensitive)
**app_guids** | _list of strings_ | Comma-delimited list of app guids to filter by
**app_names** | _strings_ | Comma-delimited list of app names to filter by
**app_names** | _strings_ | Comma-delimited list of app names to filter by (case-insensitive)
**service_plan_guids** | _list of strings_ | Comma-delimited list of service plan guids to filter by
**service_plan_names** | _list of strings_ | Comma-delimited list of service plan names to filter by
**service_plan_names** | _list of strings_ | Comma-delimited list of service plan names to filter by (case-insensitive)
**service_offering_guids** | _list of strings_ | Comma-delimited list of service offering guids to filter by
**service_offering_names** | _list of strings_ | Comma-delimited list of service offering names to filter by
**service_offering_names** | _list of strings_ | Comma-delimited list of service offering names to filter by (case-insensitive)
**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** | _[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)
Expand Down
4 changes: 2 additions & 2 deletions docs/v3/source/includes/resources/service_instances/_create.md.erb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ accordingly to cases outlined in the [OSBAPI specification](https://github.com/o
Name | Type | Description
---- | ---- | -----------
**type** | _string_ | Must be `managed`
**name** | _string_ | Name of the service instance
**name** | _string_ | Name of the service instance; must be unique within the space (case-sensitive)
**relationships.space** | [_to-one relationship_](#to-one-relationships) | The space in which to create the service instance
**relationships.service_plan** | [_to-one relationship_](#to-one-relationships) | The service plan from which to create the service instance

Expand All @@ -131,7 +131,7 @@ Name | Type | Description |
Name | Type | Description
---- | ---- | -----------
**type** | _string_ | Must be `user-provided`
**name** | _string_ | Name of the service instance
**name** | _string_ | Name of the service instance; must be unique within the space (case-sensitive)
**relationships.space** | [_to-one relationship_](#to-one-relationships) | The space in which to create the service instance

#### Optional parameters for user-provided service instance
Expand Down
4 changes: 2 additions & 2 deletions docs/v3/source/includes/resources/service_instances/_list.md.erb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,13 +29,13 @@ This endpoint retrieves the service instances the user has access to, including

Name | Type | Description
---- | ---- | ------------
**names** | _list of strings_ | Comma-delimited list of service instance names to filter by
**names** | _list of strings_ | Comma-delimited list of service instance names to filter by (case-sensitive)
**guids** | _list of strings_ | Comma-delimited list of service instance guids to filter by
**type** | _string_ | Filter by type; valid values are `managed` and `user-provided`
**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
**service_plan_guids** | _list of strings_ | Comma-delimited list of service plan guids to filter by
**service_plan_names** | _list of strings_ | Comma-delimited list of service plan names to filter by
**service_plan_names** | _list of strings_ | Comma-delimited list of service plan names to filter by (case-insensitive)
**page** | _integer_ | Page to display; valid values are integers >= 1
**per_page** | _integer_ | Number of results per page; <br>valid values are 1 through 5000
**order_by** | _string_ | Value to sort by. Defaults to ascending; prepend with `-` to sort descending<br>Valid values are `created_at`, `updated_at`, and `name`
Expand Down
4 changes: 2 additions & 2 deletions docs/v3/source/includes/resources/service_offerings/_list.md.erb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,11 @@ This endpoint retrieves the service offerings the user has access to.

Name | Type | Description
---- | ---- | ------------
**names** | _list of strings_ | Comma-delimited list of names to filter by
**names** | _list of strings_ | Comma-delimited list of names to filter by (case-insensitive)
**available** | _boolean_ | Filter by the `available` property; valid values are `true` or `false`
**broker_catalog_ids** | _list of strings_ | Comma-delimited list of IDs provided by the service broker for the service offering to filter by
**service_broker_guids** | _list of strings_ | Comma-delimited list of service broker GUIDs to filter by
**service_broker_names** | _list of strings_ | Comma-delimited list of service broker names to filter by
**service_broker_names** | _list of strings_ | Comma-delimited list of service broker names to filter by (case-sensitive)
**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
Expand Down
Loading
Loading