|
2 | 2 |
|
3 | 3 | A complete OpenAPI 3.0.0 specification for the Cloud Foundry Cloud Controller API (CAPI) v3.195.0, providing 100% coverage of all API endpoints, resources, and operations.
|
4 | 4 |
|
| 5 | +## Status |
| 6 | + |
| 7 | +This treats the upstream Cloud Foundry API v3 as the source of truth: |
| 8 | +https://v3-apidocs.cloudfoundry.org/version/3.195.0/index.html#deprecated-endpoints |
| 9 | + |
| 10 | +The api docs are fetched from the versioned url into the ./data directory and |
| 11 | +then processed into the OpenAPI YAML files in ./capi/3.195.0. |
| 12 | + |
| 13 | +Currently the process of carving up the API html file into the individual YAML files is done manually, |
| 14 | +the goal is to automate this part of the process in the future. |
| 15 | + |
| 16 | +Once this has been parsed into the OpenAPI .yml files in ./capi/3.195.0 they are then |
| 17 | +merged into ./capi/3.195.0.openapi.yaml and .capi/3.195.0.openapi.json files. |
| 18 | + |
| 19 | +From there the OpenAPI specification can be used to generate client SDKs, documentation, etc... |
| 20 | + |
| 21 | + |
5 | 22 | ## Overview
|
6 | 23 |
|
7 | 24 | This repository contains a comprehensive OpenAPI specification that fully describes the Cloud Foundry v3 API. The specification is organized into modular YAML files for maintainability and can be used to:
|
@@ -95,7 +112,7 @@ The `bin/gen` script provides a flexible way to generate SDKs for different lang
|
95 | 112 | # Go SDK for CAPI 3.181.0
|
96 | 113 | ./bin/gen --version=3.181.0 --language=go
|
97 | 114 |
|
98 |
| -# Ruby SDK for CAPI 3.181.0 |
| 115 | +# Ruby SDK for CAPI 3.181.0 |
99 | 116 | ./bin/gen --version=3.181.0 --language=ruby
|
100 | 117 | ```
|
101 | 118 |
|
@@ -153,7 +170,7 @@ The specification covers all Cloud Foundry v3 resources:
|
153 | 170 | - Applications, Processes, Builds, Droplets, Packages
|
154 | 171 | - Revisions, Deployments, Tasks, Sidecars
|
155 | 172 |
|
156 |
| -### Routing & Networking |
| 173 | +### Routing & Networking |
157 | 174 | - Routes, Domains, Route Destinations
|
158 | 175 | - Security Groups, Route Mappings (deprecated)
|
159 | 176 |
|
@@ -233,4 +250,4 @@ This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENS
|
233 | 250 | - Cloud Foundry Foundation
|
234 | 251 | - Cloud Foundry CAPI Team
|
235 | 252 | - OpenAPI Initiative
|
236 |
| -- Community Contributors |
| 253 | +- Community Contributors |
0 commit comments