Skip to content
This repository was archived by the owner on Aug 25, 2026. It is now read-only.

Commit db83046

Browse files
Add curated examples, fix lint errors, and update schemas
- Add curated examples from ccng/docs to our latest components - Fix schema lint errors and app links warnings - Remove trailing quote for router group description markdown Co-authored-by: Cursor <cursoragent@cursor.com>
1 parent 4da09ec commit db83046

67 files changed

Lines changed: 9366 additions & 4825 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎apis/cf/latest/components/requestBodies/AppCreateRequestBody.yaml‎

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,19 +14,28 @@ content:
1414
additionalProperties:
1515
type: string
1616
lifecycle:
17-
$ref: '../schemas/Lifecycle.yaml'
17+
$ref: ../schemas/Lifecycle.yaml
1818
description: Provides the lifecycle object for the application
1919
relationships:
2020
type: object
2121
properties:
2222
space:
23-
$ref: '../schemas/RelationshipToOne.yaml'
23+
$ref: ../schemas/RelationshipToOne.yaml
2424
description: A relationship to a space
2525
required:
2626
- space
2727
metadata:
28-
$ref: '../schemas/Metadata.yaml'
28+
$ref: ../schemas/Metadata.yaml
2929
required:
3030
- name
3131
- relationships
3232
description: Request schema for creating an app
33+
examples:
34+
default:
35+
summary: default
36+
value:
37+
name: my_app
38+
relationships:
39+
space:
40+
data:
41+
guid: 123e4567-e89b-12d3-a456-426614174000

‎apis/cf/latest/components/requestBodies/AppUpdateRequestBody.yaml‎

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,18 @@ content:
1414
additionalProperties:
1515
type: string
1616
lifecycle:
17-
$ref: '../schemas/Lifecycle.yaml'
17+
$ref: ../schemas/Lifecycle.yaml
1818
description: Lifecycle to be used when updating the app; note `data` is a required field in lifecycle if lifecycle is updated. `type` may NOT be changed from its current value.
1919
metadata:
20-
$ref: '../schemas/Metadata.yaml'
20+
$ref: ../schemas/Metadata.yaml
2121
description: Request schema for updating an app
22+
examples:
23+
default:
24+
summary: default
25+
value:
26+
name: my_app
27+
lifecycle:
28+
type: buildpack
29+
data:
30+
buildpacks:
31+
- java_buildpack

‎apis/cf/latest/components/requestBodies/BuildpackCreateRequestBody.yaml‎

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,16 @@ content:
2424
type: boolean
2525
description: Whether or not the buildpack is locked to prevent updating the bits
2626
metadata:
27-
$ref: '../schemas/Metadata.yaml'
27+
$ref: ../schemas/Metadata.yaml
2828
required:
2929
- name
3030
description: Request schema for creating a buildpack
31+
examples:
32+
default:
33+
summary: default
34+
value:
35+
name: ruby_buildpack
36+
position: 42
37+
enabled: true
38+
locked: false
39+
stack: windows64

‎apis/cf/latest/components/requestBodies/BuildpackUpdateRequestBody.yaml‎

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,5 +21,14 @@ content:
2121
type: string
2222
description: The name of the stack that the buildpack will use
2323
metadata:
24-
$ref: '../schemas/Metadata.yaml'
24+
$ref: ../schemas/Metadata.yaml
2525
description: Request schema for updating a buildpack
26+
examples:
27+
default:
28+
summary: default
29+
value:
30+
name: ruby_buildpack
31+
position: 42
32+
enabled: true
33+
locked: false
34+
stack: windows64

‎apis/cf/latest/components/requestBodies/DomainCreateRequestBody.yaml‎

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,15 +19,21 @@ content:
1919
guid:
2020
type: string
2121
format: uuid
22-
description: "The desired router group guid. _note: creates a `tcp` domain; cannot be used when `internal` is set to `true` or domain is scoped to an org_\""
22+
description: 'The desired router group guid. _note: creates a `tcp` domain; cannot be used when `internal` is set to `true` or domain is scoped to an org_'
2323
relationships:
2424
type: object
2525
properties:
2626
organization:
27-
$ref: '../schemas/RelationshipToOne.yaml'
27+
$ref: ../schemas/RelationshipToOne.yaml
2828
description: A relationship to the organization the domain will be scoped to; _note cannot be used when `internal` is set to `true` or domain is associated with a router group_
2929
shared_organizations:
30-
$ref: '../schemas/RelationshipToMany.yaml'
30+
$ref: ../schemas/RelationshipToMany.yaml
3131
description: A relationship to organizations the domain will be shared with _Note cannot be used without an organization relationship_
3232
metadata:
33-
$ref: '../schemas/Metadata.yaml'
33+
$ref: ../schemas/Metadata.yaml
34+
examples:
35+
default:
36+
summary: default
37+
value:
38+
name: example.com
39+
internal: false

‎apis/cf/latest/components/requestBodies/DropletCreateRequestBody.yaml‎

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,26 @@ content:
99
type: object
1010
properties:
1111
app:
12-
$ref: '../schemas/RelationshipToOne.yaml'
12+
$ref: ../schemas/RelationshipToOne.yaml
1313
description: App to create droplet for
1414
required:
1515
- app
1616
process_types:
1717
type: object
1818
description: Process names and start commands for the droplet
1919
metadata:
20-
$ref: '../schemas/Metadata.yaml'
20+
$ref: ../schemas/Metadata.yaml
2121
required:
2222
- relationships
2323
description: Request schema for creating a droplet
24+
examples:
25+
default:
26+
summary: default
27+
value:
28+
relationships:
29+
app:
30+
data:
31+
guid: 123e4567-e89b-12d3-a456-426614174000
32+
process_types:
33+
rake: bundle exec rake
34+
web: bundle exec rackup config.ru -p $PORT

‎apis/cf/latest/components/requestBodies/IsolationSegmentCreate.yaml‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,11 @@ content:
88
type: string
99
description: Name of the isolation segment; isolation segment names must be unique across the entire system, and case is ignored when checking for uniqueness
1010
metadata:
11-
$ref: '../schemas/Metadata.yaml'
11+
$ref: ../schemas/Metadata.yaml
1212
required:
1313
- name
14+
examples:
15+
default:
16+
summary: default
17+
value:
18+
name: my_segment

‎apis/cf/latest/components/requestBodies/OrganizationCreateRequestBody.yaml‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,12 @@ content:
1212
type: boolean
1313
description: Whether an organization is suspended or not
1414
metadata:
15-
$ref: '../schemas/Metadata.yaml'
15+
$ref: ../schemas/Metadata.yaml
1616
required:
1717
- name
1818
description: Request schema for creating an organization
19+
examples:
20+
default:
21+
summary: default
22+
value:
23+
name: my-organization

‎apis/cf/latest/components/requestBodies/OrganizationQuotaCreateRequestBody.yaml‎

Lines changed: 37 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -13,19 +13,29 @@ content:
1313
description: Quotas that affect applications and application sub-resources
1414
properties:
1515
per_process_memory_in_mb:
16-
type: [integer, "null"]
16+
type:
17+
- integer
18+
- 'null'
1719
description: Maximum memory for a single process or task
1820
total_memory_in_mb:
19-
type: [integer, "null"]
21+
type:
22+
- integer
23+
- 'null'
2024
description: Total memory allowed for all the started processes and running tasks in an organization
2125
total_instances:
22-
type: [integer, "null"]
26+
type:
27+
- integer
28+
- 'null'
2329
description: Total instances of all the started processes allowed in an organization
2430
log_rate_limit_in_bytes_per_second:
25-
type: [integer, "null"]
31+
type:
32+
- integer
33+
- 'null'
2634
description: Total log rate limit allowed for all the started processes and running tasks in an organization
2735
per_app_tasks:
28-
type: [integer, "null"]
36+
type:
37+
- integer
38+
- 'null'
2939
description: Maximum number of running tasks in an organization
3040
services:
3141
type: object
@@ -35,36 +45,51 @@ content:
3545
type: boolean
3646
description: Specifies whether instances of paid service plans can be created
3747
total_service_instances:
38-
type: [integer, "null"]
48+
type:
49+
- integer
50+
- 'null'
3951
description: Total number of service instances allowed in an organization
4052
total_service_keys:
41-
type: [integer, "null"]
53+
type:
54+
- integer
55+
- 'null'
4256
description: Total number of service keys allowed in an organization
4357
routes:
4458
type: object
4559
description: Quotas that affect routes
4660
properties:
4761
total_routes:
48-
type: [integer, "null"]
62+
type:
63+
- integer
64+
- 'null'
4965
description: Total number of routes allowed in an organization
5066
total_reserved_ports:
51-
type: [integer, "null"]
67+
type:
68+
- integer
69+
- 'null'
5270
description: Total number of ports that are reservable by routes in an organization
5371
domains:
5472
type: object
5573
description: Quotas that affect domains
5674
properties:
5775
total_domains:
58-
type: [integer, "null"]
76+
type:
77+
- integer
78+
- 'null'
5979
description: Total number of domains that can be scoped to an organization
6080
relationships:
6181
type: object
6282
properties:
6383
organizations:
64-
$ref: '../schemas/RelationshipToMany.yaml'
84+
$ref: ../schemas/RelationshipToMany.yaml
6585
description: A relationship to the organizations where the quota is applied
6686
metadata:
67-
$ref: '../schemas/Metadata.yaml'
87+
$ref: ../schemas/Metadata.yaml
6888
required:
6989
- name
7090
description: Request schema for creating an organization quota
91+
examples:
92+
default:
93+
summary: default
94+
value:
95+
name: production

‎apis/cf/latest/components/requestBodies/OrganizationUpdateRequestBody.yaml‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,5 +12,10 @@ content:
1212
type: boolean
1313
description: Whether an organization is suspended or not
1414
metadata:
15-
$ref: '../schemas/Metadata.yaml'
15+
$ref: ../schemas/Metadata.yaml
1616
description: Request schema for updating an organization
17+
examples:
18+
default:
19+
summary: default
20+
value:
21+
name: my-organization

0 commit comments

Comments
 (0)