@1claw/openapi-spec 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +50 -0
- package/openapi.json +4940 -0
- package/openapi.yaml +3256 -0
- package/package.json +40 -0
package/README.md
ADDED
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
# @1claw/openapi-spec
|
|
2
|
+
|
|
3
|
+
OpenAPI 3.1.0 specification for the [1Claw Vault API](https://1claw.xyz). Use this package to generate API clients in any language.
|
|
4
|
+
|
|
5
|
+
## Install
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install @1claw/openapi-spec
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Usage
|
|
12
|
+
|
|
13
|
+
### Generate a TypeScript client
|
|
14
|
+
|
|
15
|
+
```bash
|
|
16
|
+
npx openapi-typescript node_modules/@1claw/openapi-spec/openapi.yaml -o src/1claw-types.ts
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
### Generate a Python client
|
|
20
|
+
|
|
21
|
+
```bash
|
|
22
|
+
openapi-generator generate \
|
|
23
|
+
-i node_modules/@1claw/openapi-spec/openapi.yaml \
|
|
24
|
+
-g python \
|
|
25
|
+
-o ./1claw-client
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
### Generate a Go client
|
|
29
|
+
|
|
30
|
+
```bash
|
|
31
|
+
openapi-generator generate \
|
|
32
|
+
-i node_modules/@1claw/openapi-spec/openapi.yaml \
|
|
33
|
+
-g go \
|
|
34
|
+
-o ./1claw-client
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
### Use in code
|
|
38
|
+
|
|
39
|
+
```typescript
|
|
40
|
+
import spec from "@1claw/openapi-spec/openapi.json";
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
## Included files
|
|
44
|
+
|
|
45
|
+
- `openapi.yaml` — The canonical YAML specification
|
|
46
|
+
- `openapi.json` — JSON version for tooling that prefers JSON
|
|
47
|
+
|
|
48
|
+
## License
|
|
49
|
+
|
|
50
|
+
PolyForm Noncommercial 1.0.0
|