openapi-sync 2.1.7 → 2.1.9
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 +7 -2
- package/db.json +1 -1
- package/dist/Openapi-sync/index.js +1 -0
- package/dist/helpers.js +17 -1
- package/dist/index.js +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,5 +1,3 @@
|
|
|
1
|
-
# OpenAPI Sync - Comprehensive Documentation
|
|
2
|
-
|
|
3
1
|
[](https://www.npmjs.com/package/openapi-sync)
|
|
4
2
|
[](https://github.com/akintomiwa-fisayo/openapi-sync/blob/main/LICENSE)
|
|
5
3
|
|
|
@@ -351,6 +349,8 @@ src/api/
|
|
|
351
349
|
|
|
352
350
|
### Generated Endpoints
|
|
353
351
|
|
|
352
|
+
When `endpoints.value.type` is set to `"string"`
|
|
353
|
+
|
|
354
354
|
#### String Format (Default)
|
|
355
355
|
|
|
356
356
|
````typescript
|
|
@@ -386,11 +386,14 @@ export const addPet = "/pet";
|
|
|
386
386
|
|
|
387
387
|
#### Object Format
|
|
388
388
|
|
|
389
|
+
When `endpoints.value.type` is set to `"object"`, each endpoint is generated as an object containing metadata:
|
|
390
|
+
|
|
389
391
|
````typescript
|
|
390
392
|
// endpoints.ts (with type: "object")
|
|
391
393
|
/**
|
|
392
394
|
* **Method**: `POST`
|
|
393
395
|
* **Summary**: Add a new pet to the store
|
|
396
|
+
* **Tags**: [pet]
|
|
394
397
|
* **DTO**:
|
|
395
398
|
* ```typescript
|
|
396
399
|
* {
|
|
@@ -404,12 +407,14 @@ export const addPet = {
|
|
|
404
407
|
method: "POST",
|
|
405
408
|
operationId: "addPet",
|
|
406
409
|
url: "/pet",
|
|
410
|
+
tags: ["pet"],
|
|
407
411
|
};
|
|
408
412
|
|
|
409
413
|
export const getPetById = {
|
|
410
414
|
method: "GET",
|
|
411
415
|
operationId: "getPetById",
|
|
412
416
|
url: (petId: string) => `/pet/${petId}`,
|
|
417
|
+
tags: ["pet"],
|
|
413
418
|
};
|
|
414
419
|
````
|
|
415
420
|
|