@product-live/api-sdk 3.1.2 → 3.1.4
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 +36 -0
- package/dist/index.d.mts +637 -609
- package/dist/index.d.ts +637 -609
- package/dist/index.js +689 -641
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +695 -647
- package/dist/index.mjs.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -2,6 +2,42 @@
|
|
|
2
2
|
|
|
3
3
|
This sdk aims at simplifying access to the Product-Live public API.
|
|
4
4
|
|
|
5
|
+
## Generation
|
|
6
|
+
|
|
7
|
+
The following section describe the necessary steps to generate and publish a new version of the sdk. All action are performed through the github web interface.
|
|
8
|
+
|
|
9
|
+
### Generation
|
|
10
|
+
|
|
11
|
+
A new version of the sdk can be generated through the github action [Generate sdk](https://github.com/Product-Live/sdk-typescript/actions/workflows/generate-sdk.yaml). This action will generate the necessary code on a new branch and open a PR for verification. A dry publication is performed to ensure basic npm compliance.
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
**Note that running the same action multiple times will result in as many branches and PR being opened, that should be closed manually.**
|
|
16
|
+
|
|
17
|
+
**OPTIONS:**
|
|
18
|
+
- "OpenApi specification location": url for the targeted API. The default value is the production API and should be used in most cases.
|
|
19
|
+
- "Should perform a dry run": if checked, the changes will not be committed. This option may be used to test generation beforehand.
|
|
20
|
+
|
|
21
|
+
### PR validation
|
|
22
|
+
|
|
23
|
+
The pull request opened should be reviewed, and merged once validated.
|
|
24
|
+
|
|
25
|
+
### Release creation
|
|
26
|
+
|
|
27
|
+
The preparation of a new release is handled automatically by release-please. A PR is created and maintained whenever the main branch is updated.\
|
|
28
|
+
Once ready to publish the new version, said PR should be merged. All necessary actions are then handled automatically.
|
|
29
|
+
|
|
30
|
+
### Publication
|
|
31
|
+
|
|
32
|
+
Once a new release is created, it should then be published through the [Publish sdk](https://github.com/Product-Live/sdk-typescript/actions/workflows/publish.yaml) github action. Except in some edge cases, it should be executed on the 'main' branch.\
|
|
33
|
+
This action will build and publish the sdk to npm repository.
|
|
34
|
+
|
|
35
|
+
|
|
36
|
+
|
|
37
|
+
**OPTIONS:**
|
|
38
|
+
- "dry run": if checked, performs a test publication without the actual upload. This may be used to test publication
|
|
39
|
+
|
|
40
|
+
|
|
5
41
|
## Installing
|
|
6
42
|
|
|
7
43
|
Install the library with the following command:
|