Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
description: Package object that needs to be created
description: Package object that needs to be created or copied. When copying (source_guid query parameter is provided), only relationships.app is required. When creating a new package, type and relationships.app are required.
required: true
content:
application/json:
Expand All @@ -7,7 +7,7 @@ content:
properties:
type:
type: string
description: Type of the package; valid values are bits or docker
description: Type of the package; valid values are bits or docker. Required when creating a new package (when source_guid is not provided). Not required when copying a package (when source_guid is provided).
enum:
- bits
- docker
Expand Down Expand Up @@ -35,6 +35,5 @@ content:
metadata:
$ref: '../schemas/Metadata.yaml'
required:
- type
- relationships
description: Request schema for creating a package
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
description: Service broker object that needs to be updated
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: Name of the service broker
url:
type: string
description: URL of the service broker
authentication:
type: object
description: Credentials used to authenticate against the service broker
properties:
type:
type: string
enum: [basic]
description: Authentication type
credentials:
type: object
description: Authentication credentials
properties:
username:
type: string
description: Username for basic authentication
password:
type: string
description: Password for basic authentication
required:
- username
- password
required:
- type
- credentials
metadata:
$ref: '../schemas/Metadata.yaml'
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
description: Service plan visibility object that needs to be created
required: true
content:
application/json:
schema:
type: object
properties:
type:
type: string
enum: [public, admin, organization]
description: Denotes the visibility of the plan
organizations:
type: array
items:
type: object
properties:
guid:
type: string
format: uuid
required:
- guid
description: Desired list of organizations GUIDs where the plan will be accessible; required if type is organization
required:
- type
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
description: Service plan visibility object that needs to be updated
required: true
content:
application/json:
schema:
type: object
properties:
type:
type: string
enum: [public, admin, organization]
description: Denotes the visibility of the plan
organizations:
type: array
items:
type: object
properties:
guid:
type: string
format: uuid
required:
- guid
description: Desired list of organizations GUIDs where the plan will be accessible; required if type is organization
required:
- type
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
description: Sidecar object that needs to be updated
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: Human-readable name for the sidecar
command:
type: string
description: The command used to start the sidecar
process_types:
type: array
items:
type: string
description: A list of process types the sidecar applies to
memory_in_mb:
type: integer
description: Reserved memory for sidecar
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
description: Stack object that needs to be created
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: Name of the stack; must be unique and no longer than 250 characters
maxLength: 250
description:
type: [string, "null"]
description: Description of the stack; must no longer than 250 characters
maxLength: 250
metadata:
$ref: '../schemas/Metadata.yaml'
required:
- name
5 changes: 5 additions & 0 deletions apis/cf/latest/components/responses/BadGateway.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
description: Bad Gateway
content:
application/json:
schema:
$ref: '../schemas/Error.yaml'
20 changes: 20 additions & 0 deletions apis/cf/latest/components/responses/Conflict.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
description: Conflict
content:
application/json:
schema:
type: object
properties:
errors:
type: array
items:
type: object
properties:
code:
type: integer
example: 10008
title:
type: string
example: "CF-ResourceConflict"
detail:
type: string
example: "The resource could not be updated due to a conflict"
20 changes: 20 additions & 0 deletions apis/cf/latest/components/responses/TooManyRequests.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
description: Too Many Requests
content:
application/json:
schema:
type: object
properties:
errors:
type: array
items:
type: object
properties:
code:
type: integer
example: 10008
title:
type: string
example: "CF-RateLimitExceeded"
detail:
type: string
example: "Rate limit exceeded"
113 changes: 37 additions & 76 deletions apis/cf/latest/components/schemas/AppCredentialBinding.yaml
Original file line number Diff line number Diff line change
@@ -1,80 +1,41 @@
type: object
properties:
guid:
type: string
format: uuid
description: Unique identifier for the app credential binding
created_at:
type: string
format: date-time
description: The time with zone when the object was created
updated_at:
type: string
format: date-time
description: The time with zone when the object was last updated
type:
type: string
enum:
- app
description: Type of credential binding
name:
type: string
description: Name of the credential binding
last_operation:
type: object
properties:
allOf:
- $ref: './BaseSchema.yaml'
- properties:
type:
type: string
description: Type of the last operation
enum:
- create
- delete
state:
type: string
description: State of the last operation
enum:
- initial
- in progress
- succeeded
- failed
description:
type: string
description: A textual explanation associated with this state
created_at:
type: string
format: date-time
description: When the last operation was created
updated_at:
type: string
format: date-time
description: When the last operation was last updated
relationships:
type: object
properties:
app:
$ref: './RelationshipToOne.yaml'
service_instance:
$ref: './RelationshipToOne.yaml'
description: Relationships for the credential binding
links:
type: object
properties:
self:
$ref: './Link.yaml'
details:
$ref: './Link.yaml'
app:
$ref: './Link.yaml'
service_instance:
$ref: './Link.yaml'
parameters:
$ref: './Link.yaml'
metadata:
$ref: './Metadata.yaml'
required:
- guid
- created_at
- updated_at
- type
- relationships
- links
- app
description: Type of credential binding
name:
type: [string, "null"]
description: Name of the credential binding
last_operation:
$ref: './ServiceCredentialBindingLastOperation.yaml'
relationships:
type: object
properties:
app:
$ref: './RelationshipToOne.yaml'
service_instance:
$ref: './RelationshipToOne.yaml'
description: Relationships for the credential binding
links:
type: object
properties:
self:
$ref: './Link.yaml'
details:
$ref: './Link.yaml'
app:
$ref: './Link.yaml'
service_instance:
$ref: './Link.yaml'
parameters:
$ref: './Link.yaml'
metadata:
$ref: './Metadata.yaml'
required:
- type
- relationships
- links
2 changes: 1 addition & 1 deletion apis/cf/latest/components/schemas/AppEnvironment.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ properties:
type: object
description: User-defined environment variables
additionalProperties:
type: string
type: [string, "null"]
system_env_json:
type: object
description: System environment variables including VCAP_SERVICES
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ properties:
type: object
description: Environment variables
additionalProperties:
type: string
type: [string, "null"]
links:
type: object
properties:
Expand Down
2 changes: 1 addition & 1 deletion apis/cf/latest/components/schemas/AppFeature.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ properties:
type: string
description: The name of the app feature
description:
type: string
type: [string, "null"]
description: The description of the app feature
enabled:
type: boolean
Expand Down
Loading