@@ -37,15 +37,22 @@ This repository contains a comprehensive OpenAPI specification that fully descri
37
37
cd capi-openapi-spec
38
38
```
39
39
40
- 2 . ** Generate the unified OpenAPI specification**
40
+ 2 . ** Install dependencies**
41
+ ``` bash
42
+ make deps
43
+ ```
44
+
45
+ 3 . ** Generate the unified OpenAPI specification**
41
46
``` bash
42
47
make gen-openapi-spec
43
48
```
44
49
This creates ` capi/3.195.0.openapi.yaml ` and ` capi/3.195.0.openapi.json `
45
50
46
- 3 . ** Generate a client SDK** (example for Go)
51
+ 4 . ** Generate a client SDK** (example for Go)
47
52
``` bash
48
53
make gen-go-client
54
+ # Or for any language:
55
+ make gen-sdk LANGUAGE=python VERSION=3.195.0
49
56
```
50
57
51
58
## SDK Generation
@@ -54,7 +61,14 @@ The `bin/gen` script provides a flexible way to generate SDKs for different lang
54
61
55
62
### Usage
56
63
``` bash
64
+ # Generate SDK
57
65
./bin/gen --version=VERSION --language=LANGUAGE [--output= PATH]
66
+
67
+ # Prepare specifications (download and create YAML files)
68
+ ./bin/gen prepare --version=VERSION
69
+
70
+ # Merge YAML files into unified OpenAPI spec
71
+ ./bin/gen merge --version=VERSION
58
72
```
59
73
60
74
### Examples
@@ -178,8 +192,8 @@ capi/
178
192
├── 3.195.0.openapi.yaml (generated)
179
193
└── 3.195.0.openapi.json (generated)
180
194
bin/
181
- ├── capi-openapi (main processing script)
182
- └── gen (SDK generation script)
195
+ ├── gen (main processing script for prepare, merge, and SDK generation )
196
+ └── validate (OpenAPI spec validation script)
183
197
sdk/
184
198
└── VERSION/
185
199
└── LANGUAGE/ (generated SDKs)
0 commit comments