@orlikfy/api-interfaces 2.0.0 → 3.0.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 +48 -0
- package/dist/api.d.ts +2 -4
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
# @orlikfy/api-interfaces
|
|
2
|
+
|
|
3
|
+
TypeScript interfaces generated from the Orlikfy backend OpenAPI specification.
|
|
4
|
+
|
|
5
|
+
## Publishing New Version
|
|
6
|
+
|
|
7
|
+
### 1. Generate Latest OpenAPI Spec
|
|
8
|
+
|
|
9
|
+
Run the server locally to ensure the latest `openapi.yaml` is generated:
|
|
10
|
+
|
|
11
|
+
```bash
|
|
12
|
+
cd server
|
|
13
|
+
npm run start:dev
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
> Note: This step will be automated in the future.
|
|
17
|
+
|
|
18
|
+
### 2. Generate TypeScript Interfaces
|
|
19
|
+
|
|
20
|
+
From the `server/` directory:
|
|
21
|
+
|
|
22
|
+
```bash
|
|
23
|
+
npm run api:generate
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
This generates TypeScript types from `openapi.yaml` into `npm-api-interfaces/src/api.ts`.
|
|
27
|
+
|
|
28
|
+
### 3. Build
|
|
29
|
+
|
|
30
|
+
From the `npm-api-interfaces/` directory:
|
|
31
|
+
|
|
32
|
+
```bash
|
|
33
|
+
npm run build
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
### 4. Update Version
|
|
37
|
+
|
|
38
|
+
Update the version in `package.json`:
|
|
39
|
+
|
|
40
|
+
```bash
|
|
41
|
+
npm version patch # or minor/major
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
### 5. Publish
|
|
45
|
+
|
|
46
|
+
```bash
|
|
47
|
+
npm publish
|
|
48
|
+
```
|
package/dist/api.d.ts
CHANGED
|
@@ -7218,13 +7218,11 @@ export interface operations {
|
|
|
7218
7218
|
};
|
|
7219
7219
|
requestBody?: never;
|
|
7220
7220
|
responses: {
|
|
7221
|
-
|
|
7221
|
+
201: {
|
|
7222
7222
|
headers: {
|
|
7223
7223
|
[name: string]: unknown;
|
|
7224
7224
|
};
|
|
7225
|
-
content
|
|
7226
|
-
"application/json": components["schemas"]["CreateReassignTokenResponseDto"];
|
|
7227
|
-
};
|
|
7225
|
+
content?: never;
|
|
7228
7226
|
};
|
|
7229
7227
|
/** @description Application Error */
|
|
7230
7228
|
500: {
|