Skip to content

Commit 0488c81

Browse files
committed
Updated README.md with current status.
1 parent bf43088 commit 0488c81

File tree

1 file changed

+20
-3
lines changed

1 file changed

+20
-3
lines changed

README.md

Lines changed: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,23 @@
22

33
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.
44

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+
522
## Overview
623

724
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
95112
# Go SDK for CAPI 3.181.0
96113
./bin/gen --version=3.181.0 --language=go
97114

98-
# Ruby SDK for CAPI 3.181.0
115+
# Ruby SDK for CAPI 3.181.0
99116
./bin/gen --version=3.181.0 --language=ruby
100117
```
101118

@@ -153,7 +170,7 @@ The specification covers all Cloud Foundry v3 resources:
153170
- Applications, Processes, Builds, Droplets, Packages
154171
- Revisions, Deployments, Tasks, Sidecars
155172

156-
### Routing & Networking
173+
### Routing & Networking
157174
- Routes, Domains, Route Destinations
158175
- Security Groups, Route Mappings (deprecated)
159176

@@ -233,4 +250,4 @@ This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENS
233250
- Cloud Foundry Foundation
234251
- Cloud Foundry CAPI Team
235252
- OpenAPI Initiative
236-
- Community Contributors
253+
- Community Contributors

0 commit comments

Comments
 (0)