rclone-openapi 1.0.23 → 1.72.1
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 +93 -0
- package/openapi.json +5 -1
- package/openapi.yaml +4 -1
- package/package.json +1 -1
- package/types.d.ts +1 -0
package/README.md
ADDED
|
@@ -0,0 +1,93 @@
|
|
|
1
|
+
# Rclone OpenAPI
|
|
2
|
+
|
|
3
|
+
[](https://www.npmjs.com/package/rclone-openapi)
|
|
4
|
+
[](https://www.npmjs.com/package/rclone-openapi)
|
|
5
|
+
[](LICENSE)
|
|
6
|
+
|
|
7
|
+
OpenAPI 3.1 specification for the [**Rclone RC API**](https://rclone.org/rc/).
|
|
8
|
+
|
|
9
|
+
## Installation
|
|
10
|
+
|
|
11
|
+
```bash
|
|
12
|
+
npm install rclone-openapi
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Usage
|
|
16
|
+
|
|
17
|
+
### Import the OpenAPI Schema
|
|
18
|
+
|
|
19
|
+
```javascript
|
|
20
|
+
// ESM
|
|
21
|
+
import schema from 'rclone-openapi';
|
|
22
|
+
|
|
23
|
+
// CommonJS
|
|
24
|
+
const schema = require('rclone-openapi');
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
Or import directly:
|
|
28
|
+
|
|
29
|
+
```javascript
|
|
30
|
+
import schema from 'rclone-openapi/openapi.json';
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
The YAML version is also available at **`openapi.yaml`**.
|
|
34
|
+
|
|
35
|
+
### TypeScript Types
|
|
36
|
+
|
|
37
|
+
This package includes auto-generated TypeScript types for the Rclone RC API:
|
|
38
|
+
|
|
39
|
+
```typescript
|
|
40
|
+
import type { paths, operations, components } from 'rclone-openapi';
|
|
41
|
+
|
|
42
|
+
// Example: Type for the /config/listremotes response
|
|
43
|
+
type ListRemotesResponse = paths['/config/listremotes']['post']['responses']['200']['content']['application/json'];
|
|
44
|
+
|
|
45
|
+
// Example: Type for operations
|
|
46
|
+
type CopyFileParams = operations['operationsCopyfile']['parameters']['query'];
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
Works great with API clients like [**openapi-fetch**](https://openapi-ts.dev/openapi-fetch/):
|
|
50
|
+
|
|
51
|
+
```typescript
|
|
52
|
+
import createClient from 'openapi-fetch';
|
|
53
|
+
import type { paths } from 'rclone-openapi';
|
|
54
|
+
|
|
55
|
+
const client = createClient<paths>({ baseUrl: 'http://localhost:5572' });
|
|
56
|
+
|
|
57
|
+
const { data, error } = await client.POST('/config/listremotes');
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
## Files
|
|
61
|
+
|
|
62
|
+
| File | Description |
|
|
63
|
+
|------|-------------|
|
|
64
|
+
| **`openapi.json`** | OpenAPI 3.1 specification (JSON) |
|
|
65
|
+
| **`openapi.yaml`** | OpenAPI 3.1 specification (YAML) |
|
|
66
|
+
| **`types.d.ts`** | TypeScript type definitions |
|
|
67
|
+
|
|
68
|
+
## Development
|
|
69
|
+
|
|
70
|
+
Generate the JSON schema and TypeScript types from the YAML source:
|
|
71
|
+
|
|
72
|
+
```bash
|
|
73
|
+
npm run gen # Generate both JSON and types
|
|
74
|
+
npm run gen:json # Generate JSON only
|
|
75
|
+
npm run gen:types # Generate TypeScript types only
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
## Related
|
|
79
|
+
|
|
80
|
+
- [**Rclone SDK**](https://github.com/rclone-ui/rclone-sdk) — Ready-to-use client built on this spec (supports Rust and Javascript/Typescript)
|
|
81
|
+
- [**Rclone** RC API Documentation](https://rclone.org/rc/)
|
|
82
|
+
- [**Rclone**](https://rclone.org/) — Cloud storage sync tool
|
|
83
|
+
|
|
84
|
+
## License
|
|
85
|
+
|
|
86
|
+
MIT
|
|
87
|
+
|
|
88
|
+
<br />
|
|
89
|
+
<br />
|
|
90
|
+
|
|
91
|
+
<div align="center">
|
|
92
|
+
<sub>Made with ☁️ for the rclone community</sub>
|
|
93
|
+
</div>
|
package/openapi.json
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
"openapi": "3.1.0",
|
|
3
3
|
"info": {
|
|
4
4
|
"title": "Rclone RC API",
|
|
5
|
-
"version": "
|
|
5
|
+
"version": "1.72.1",
|
|
6
6
|
"description": "Full OpenAPI specification for the Rclone RC API.",
|
|
7
7
|
"contact": {
|
|
8
8
|
"name": "GitHub Repository",
|
|
@@ -5978,9 +5978,13 @@
|
|
|
5978
5978
|
"schema": {
|
|
5979
5979
|
"type": "object",
|
|
5980
5980
|
"required": [
|
|
5981
|
+
"name",
|
|
5981
5982
|
"type"
|
|
5982
5983
|
],
|
|
5983
5984
|
"properties": {
|
|
5985
|
+
"name": {
|
|
5986
|
+
"type": "string"
|
|
5987
|
+
},
|
|
5984
5988
|
"type": {
|
|
5985
5989
|
"type": "string"
|
|
5986
5990
|
},
|
package/openapi.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
openapi: 3.1.0
|
|
2
2
|
info:
|
|
3
3
|
title: Rclone RC API
|
|
4
|
-
version:
|
|
4
|
+
version: 1.72.1
|
|
5
5
|
description: "Full OpenAPI specification for the Rclone RC API."
|
|
6
6
|
contact:
|
|
7
7
|
name: GitHub Repository
|
|
@@ -3507,8 +3507,11 @@ components:
|
|
|
3507
3507
|
schema:
|
|
3508
3508
|
type: object
|
|
3509
3509
|
required:
|
|
3510
|
+
- name
|
|
3510
3511
|
- type
|
|
3511
3512
|
properties:
|
|
3513
|
+
name:
|
|
3514
|
+
type: string
|
|
3512
3515
|
type:
|
|
3513
3516
|
type: string
|
|
3514
3517
|
provider:
|
package/package.json
CHANGED