Skip to content

Commit 6d0c2c1

Browse files
authored
tools: upgrade openapi-postman to v5 (#2118)
1 parent 7fcd42b commit 6d0c2c1

File tree

3 files changed

+294
-148
lines changed

3 files changed

+294
-148
lines changed

package.json

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,11 @@
66
"generate": "python3 ./regen_openapi.py"
77
},
88
"devDependencies": {
9-
"axios": "^0.30.0",
10-
"openapi-to-postmanv2": "^3.1.0",
9+
"axios": "^1.0",
10+
"openapi-to-postmanv2": "^5.4.1",
1111
"semver": "^7.5.2"
12+
},
13+
"resolutions": {
14+
"js-yaml": "4.1.1"
1215
}
1316
}

tools/update_postman.js

Lines changed: 19 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,51 +1,55 @@
1+
const axios = require("axios");
2+
const Converter = require("openapi-to-postmanv2");
13

2-
const axios = require('axios');
3-
const Converter = require('openapi-to-postmanv2');
4-
5-
const POSTMAN_COLLECTION_ID = '15964941-fdc9fd1f-d7bc-4f7e-b5ce-9189dbcbb81d';
4+
const POSTMAN_COLLECTION_ID =
5+
process.env.POSTMAN_COLLECTION_ID ||
6+
"15964941-fdc9fd1f-d7bc-4f7e-b5ce-9189dbcbb81d";
67
const POSTMAN_API_KEY = process.env.POSTMAN_API_KEY;
78

8-
const openapiUrl = 'https://api.svix.com/api/v1/openapi.json';
9+
const openapiUrl = "https://api.svix.com/api/v1/openapi.json";
910

1011
const conversionOptions = {
11-
'folderStrategy': 'tags'
12+
folderStrategy: "tags",
1213
};
1314

14-
const error = function(msg) {
15+
const error = function (msg) {
1516
console.error(msg);
1617
process.exit(1);
1718
};
1819

1920
const update_collection = async (collection) => {
20-
const res = await axios.put(
21+
await axios.put(
2122
`https://api.getpostman.com/collections/${POSTMAN_COLLECTION_ID}`,
2223
{
23-
"collection": collection
24+
collection: collection,
2425
},
2526
{
26-
headers: { "x-api-key": POSTMAN_API_KEY }
27+
headers: { "x-api-key": POSTMAN_API_KEY },
28+
validateStatus: function (status) {
29+
return status < 300;
30+
},
2731
},
2832
);
2933
};
3034

3135
(async () => {
3236
try {
33-
3437
const res = await axios.get(openapiUrl);
3538
const openapiData = res.data;
3639

3740
let collection;
38-
Converter.convert({ type: 'json', data: openapiData },
39-
conversionOptions, (err, conversionResult) => {
41+
Converter.convert(
42+
{ type: "json", data: openapiData },
43+
conversionOptions,
44+
(_err, conversionResult) => {
4045
if (!conversionResult.result) {
4146
error(`Could not convert: ${conversionResult.reason}`);
4247
}
4348
collection = conversionResult.output[0].data;
44-
}
49+
},
4550
);
4651

4752
await update_collection(collection);
48-
4953
} catch (e) {
5054
if (e.response !== undefined) {
5155
error(e.response);

0 commit comments

Comments
 (0)