Skip to content

Commit c3dc3a4

Browse files
committed
chore(dependencies): update dependencies
1 parent 3e73d33 commit c3dc3a4

7 files changed

+2994
-6611
lines changed

API.md

+3-6
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,10 @@
11
# API
2-
<a name="module_openapi-ts-sdk-builder"></a>
2+
<a name="generateSDKFromOpenAPI"></a>
33

4-
## openapi-ts-sdk-builder
5-
<a name="module_openapi-ts-sdk-builder..generateSDKFromOpenAPI"></a>
6-
7-
### openapi-ts-sdk-builder~generateSDKFromOpenAPI(openAPIContent, options) ⇒ <code>Promise.&lt;string&gt;</code>
4+
## generateSDKFromOpenAPI(openAPIContent, options) ⇒ <code>Promise.&lt;string&gt;</code>
85
Build a JS SDK from an OpenAPI file
96

10-
**Kind**: inner method of [<code>openapi-ts-sdk-builder</code>](#module_openapi-ts-sdk-builder)
7+
**Kind**: global function
118
**Returns**: <code>Promise.&lt;string&gt;</code> - The SDK JS code
129

1310
| Param | Type | Description |

ARCHITECTURE.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,12 @@
55
[//]: # ( )
66
# Architecture Notes
77

8+
## Summary
89

10+
1. [Generating the SDK](#1-generating-the-sdk)
911

10-
## Generating the SDK
12+
13+
## 1. Generating the SDK
1114

1215
Most SDK from API generator are very opinionated on how the
1316
users will use it. We wanted to have a very simple API to

README.md

+13-11
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,6 @@
1010
[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/nfroidure/openapi-ts-sdk-builder/blob/master/LICENSE)
1111
[![Build status](https://travis-ci.com/nfroidure/openapi-ts-sdk-builder.svg?branch=master)](https://travis-ci.com/github/nfroidure/openapi-ts-sdk-builder)
1212
[![Coverage Status](https://coveralls.io/repos/github/nfroidure/openapi-ts-sdk-builder/badge.svg?branch=master)](https://coveralls.io/github/nfroidure/openapi-ts-sdk-builder?branch=master)
13-
[![NPM version](https://badge.fury.io/js/openapi-ts-sdk-builder.svg)](https://npmjs.org/package/openapi-ts-sdk-builder)
14-
[![Dependency Status](https://david-dm.org/nfroidure/openapi-ts-sdk-builder.svg)](https://david-dm.org/nfroidure/openapi-ts-sdk-builder)
15-
[![devDependency Status](https://david-dm.org/nfroidure/openapi-ts-sdk-builder/dev-status.svg)](https://david-dm.org/nfroidure/openapi-ts-sdk-builder#info=devDependencies)
16-
[![Package Quality](https://npm.packagequality.com/shield/openapi-ts-sdk-builder.svg)](https://packagequality.com/#?package=openapi-ts-sdk-builder)
1713

1814

1915
[//]: # (::contents:start)
@@ -64,8 +60,17 @@ In your code:
6460
```js
6561
import API from './myapi.openapi.json';
6662

67-
// Just use the API then
63+
// Use the API
6864
await API.getPing();
65+
66+
// Generate URIs only use the API then
67+
await APIURIBuilders.buildGetPingURI({ /*...*/ });
68+
69+
// To know which medthod is used by an endpoint
70+
await APIMethods.getPing; // => get
71+
72+
// Generate a complete endpoint input
73+
await APIInputBuilders.buildGetPingInput({ /*...*/ });
6974
```
7075

7176
You can also safely operate on the API by doing so:
@@ -155,15 +160,12 @@ export default function useAPISWR<T extends Handler<any, any>>(
155160
[//]: # (::contents:end)
156161

157162
# API
158-
<a name="module_openapi-ts-sdk-builder"></a>
159-
160-
## openapi-ts-sdk-builder
161-
<a name="module_openapi-ts-sdk-builder..generateSDKFromOpenAPI"></a>
163+
<a name="generateSDKFromOpenAPI"></a>
162164

163-
### openapi-ts-sdk-builder~generateSDKFromOpenAPI(openAPIContent, options) ⇒ <code>Promise.&lt;string&gt;</code>
165+
## generateSDKFromOpenAPI(openAPIContent, options) ⇒ <code>Promise.&lt;string&gt;</code>
164166
Build a JS SDK from an OpenAPI file
165167

166-
**Kind**: inner method of [<code>openapi-ts-sdk-builder</code>](#module_openapi-ts-sdk-builder)
168+
**Kind**: global function
167169
**Returns**: <code>Promise.&lt;string&gt;</code> - The SDK JS code
168170

169171
| Param | Type | Description |

0 commit comments

Comments
 (0)