mirrors/insomnia
1
0
Fork 0
mirror of https://github.com/Kong/insomnia synced 2024-11-08 06:39:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat(Generate Collection from Spec): add description to requests if it's available from the oas3 schema (#7734)

Browse Source 
* add description to requests if it's available from the oas3 schema

* update snapshots
This commit is contained in:
James Gatz 2024-07-18 15:28:38 +02:00 committed by GitHub
parent 44642a49e9
commit 7a5ec66641
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 114 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

113
packages/insomnia/src/utils/importers/importers/__snapshots__/index.test.ts.snap
View File

@ -1055,6 +1055,7 @@ exports[`Fixtures Import openapi3 dereferenced-input.json 1`] = `
"status": "string" "status": "string"
}", }",
}, },
"description": "",
"headers": [ "headers": [
{ {
"disabled": false, "disabled": false,
@ -1100,6 +1101,7 @@ exports[`Fixtures Import openapi3 dereferenced-input.json 1`] = `
"status": "string" "status": "string"
}", }",
}, },
"description": "",
"headers": [ "headers": [
{ {
"disabled": false, "disabled": false,
@ -1125,6 +1127,7 @@ exports[`Fixtures Import openapi3 dereferenced-input.json 1`] = `
"type": "oauth2", "type": "oauth2",
}, },
"body": {}, "body": {},
"description": "Multiple status values can be provided with comma separated strings",
"headers": [], "headers": [],
"method": "GET", "method": "GET",
"name": "Finds Pets by status", "name": "Finds Pets by status",
@ -1150,6 +1153,7 @@ exports[`Fixtures Import openapi3 dereferenced-input.json 1`] = `
"type": "oauth2", "type": "oauth2",
}, },
"body": {}, "body": {},
"description": "Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.",
"headers": [], "headers": [],
"method": "GET", "method": "GET",
"name": "Finds Pets by tags", "name": "Finds Pets by tags",
@ -1173,6 +1177,7 @@ exports[`Fixtures Import openapi3 dereferenced-input.json 1`] = `
"value": "{{ _.apiKey }}", "value": "{{ _.apiKey }}",
}, },
"body": {}, "body": {},
"description": "Returns a single pet",
"headers": [], "headers": [],
"method": "GET", "method": "GET",
"name": "Find pet by ID", "name": "Find pet by ID",
@ -1194,6 +1199,7 @@ exports[`Fixtures Import openapi3 dereferenced-input.json 1`] = `
"body": { "body": {
"mimeType": "application/x-www-form-urlencoded", "mimeType": "application/x-www-form-urlencoded",
}, },
"description": "",
"headers": [ "headers": [
{ {
"disabled": false, "disabled": false,
@ -1219,6 +1225,7 @@ exports[`Fixtures Import openapi3 dereferenced-input.json 1`] = `
"type": "oauth2", "type": "oauth2",
}, },
"body": {}, "body": {},
"description": "",
"headers": [ "headers": [
{ {
"disabled": true, "disabled": true,
@ -1246,6 +1253,7 @@ exports[`Fixtures Import openapi3 dereferenced-input.json 1`] = `
"body": { "body": {
"mimeType": "multipart/form-data", "mimeType": "multipart/form-data",
}, },
"description": "",
"headers": [ "headers": [
{ {
"disabled": false, "disabled": false,
@ -1269,6 +1277,7 @@ exports[`Fixtures Import openapi3 dereferenced-input.json 1`] = `
"value": "{{ _.apiKey }}", "value": "{{ _.apiKey }}",
}, },
"body": {}, "body": {},
"description": "Returns a map of status codes to quantities",
"headers": [], "headers": [],
"method": "GET", "method": "GET",
"name": "Returns pet inventories by status", "name": "Returns pet inventories by status",
@ -1281,6 +1290,7 @@ exports[`Fixtures Import openapi3 dereferenced-input.json 1`] = `
"_type": "request", "_type": "request",
"authentication": {}, "authentication": {},
"body": {}, "body": {},
"description": "",
"headers": [], "headers": [],
"method": "POST", "method": "POST",
"name": "Place an order for a pet", "name": "Place an order for a pet",
@ -1293,6 +1303,7 @@ exports[`Fixtures Import openapi3 dereferenced-input.json 1`] = `
"_type": "request", "_type": "request",
"authentication": {}, "authentication": {},
"body": {}, "body": {},
"description": "For valid response try integer IDs with value >= 1 and <= 10. Other values will generated exceptions",
"headers": [], "headers": [],
"method": "GET", "method": "GET",
"name": "Find purchase order by ID", "name": "Find purchase order by ID",
@ -1305,6 +1316,7 @@ exports[`Fixtures Import openapi3 dereferenced-input.json 1`] = `
"_type": "request", "_type": "request",
"authentication": {}, "authentication": {},
"body": {}, "body": {},
"description": "For valid response try integer IDs with positive integer value. Negative or non-integer values will generate API errors",
"headers": [], "headers": [],
"method": "DELETE", "method": "DELETE",
"name": "Delete purchase order by ID", "name": "Delete purchase order by ID",
@ -1317,6 +1329,7 @@ exports[`Fixtures Import openapi3 dereferenced-input.json 1`] = `
"_type": "request", "_type": "request",
"authentication": {}, "authentication": {},
"body": {}, "body": {},
"description": "This can only be done by the logged in user.",
"headers": [], "headers": [],
"method": "POST", "method": "POST",
"name": "Create user", "name": "Create user",
@ -1329,6 +1342,7 @@ exports[`Fixtures Import openapi3 dereferenced-input.json 1`] = `
"_type": "request", "_type": "request",
"authentication": {}, "authentication": {},
"body": {}, "body": {},
"description": "",
"headers": [], "headers": [],
"method": "POST", "method": "POST",
"name": "Creates list of users with given input array", "name": "Creates list of users with given input array",
@ -1341,6 +1355,7 @@ exports[`Fixtures Import openapi3 dereferenced-input.json 1`] = `
"_type": "request", "_type": "request",
"authentication": {}, "authentication": {},
"body": {}, "body": {},
"description": "",
"headers": [], "headers": [],
"method": "POST", "method": "POST",
"name": "Creates list of users with given input array", "name": "Creates list of users with given input array",
@ -1353,6 +1368,7 @@ exports[`Fixtures Import openapi3 dereferenced-input.json 1`] = `
"_type": "request", "_type": "request",
"authentication": {}, "authentication": {},
"body": {}, "body": {},
"description": "",
"headers": [], "headers": [],
"method": "GET", "method": "GET",
"name": "Logs user into the system", "name": "Logs user into the system",
@ -1376,6 +1392,7 @@ exports[`Fixtures Import openapi3 dereferenced-input.json 1`] = `
"_type": "request", "_type": "request",
"authentication": {}, "authentication": {},
"body": {}, "body": {},
"description": "",
"headers": [], "headers": [],
"method": "GET", "method": "GET",
"name": "Logs out current logged in user session", "name": "Logs out current logged in user session",
@ -1388,6 +1405,7 @@ exports[`Fixtures Import openapi3 dereferenced-input.json 1`] = `
"_type": "request", "_type": "request",
"authentication": {}, "authentication": {},
"body": {}, "body": {},
"description": "",
"headers": [], "headers": [],
"method": "GET", "method": "GET",
"name": "Get user by user name", "name": "Get user by user name",
@ -1400,6 +1418,7 @@ exports[`Fixtures Import openapi3 dereferenced-input.json 1`] = `
"_type": "request", "_type": "request",
"authentication": {}, "authentication": {},
"body": {}, "body": {},
"description": "This can only be done by the logged in user.",
"headers": [], "headers": [],
"method": "PUT", "method": "PUT",
"name": "Updated user", "name": "Updated user",
@ -1412,6 +1431,7 @@ exports[`Fixtures Import openapi3 dereferenced-input.json 1`] = `
"_type": "request", "_type": "request",
"authentication": {}, "authentication": {},
"body": {}, "body": {},
"description": "This can only be done by the logged in user.",
"headers": [], "headers": [],
"method": "DELETE", "method": "DELETE",
"name": "Delete user", "name": "Delete user",
@ -1516,6 +1536,7 @@ exports[`Fixtures Import openapi3 dereferenced-with-tags-input.json 1`] = `
"status": "string" "status": "string"
}", }",
}, },
"description": "",
"headers": [ "headers": [
{ {
"disabled": false, "disabled": false,
@ -1561,6 +1582,7 @@ exports[`Fixtures Import openapi3 dereferenced-with-tags-input.json 1`] = `
"status": "string" "status": "string"
}", }",
}, },
"description": "",
"headers": [ "headers": [
{ {
"disabled": false, "disabled": false,
@ -1586,6 +1608,7 @@ exports[`Fixtures Import openapi3 dereferenced-with-tags-input.json 1`] = `
"type": "oauth2", "type": "oauth2",
}, },
"body": {}, "body": {},
"description": "Multiple status values can be provided with comma separated strings",
"headers": [], "headers": [],
"method": "GET", "method": "GET",
"name": "Finds Pets by status", "name": "Finds Pets by status",
@ -1611,6 +1634,7 @@ exports[`Fixtures Import openapi3 dereferenced-with-tags-input.json 1`] = `
"type": "oauth2", "type": "oauth2",
}, },
"body": {}, "body": {},
"description": "Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.",
"headers": [], "headers": [],
"method": "GET", "method": "GET",
"name": "Finds Pets by tags", "name": "Finds Pets by tags",
@ -1634,6 +1658,7 @@ exports[`Fixtures Import openapi3 dereferenced-with-tags-input.json 1`] = `
"value": "{{ _.apiKey }}", "value": "{{ _.apiKey }}",
}, },
"body": {}, "body": {},
"description": "Returns a single pet",
"headers": [], "headers": [],
"method": "GET", "method": "GET",
"name": "Find pet by ID", "name": "Find pet by ID",
@ -1655,6 +1680,7 @@ exports[`Fixtures Import openapi3 dereferenced-with-tags-input.json 1`] = `
"body": { "body": {
"mimeType": "application/x-www-form-urlencoded", "mimeType": "application/x-www-form-urlencoded",
}, },
"description": "",
"headers": [ "headers": [
{ {
"disabled": false, "disabled": false,
@ -1680,6 +1706,7 @@ exports[`Fixtures Import openapi3 dereferenced-with-tags-input.json 1`] = `
"type": "oauth2", "type": "oauth2",
}, },
"body": {}, "body": {},
"description": "",
"headers": [ "headers": [
{ {
"disabled": true, "disabled": true,
@ -1707,6 +1734,7 @@ exports[`Fixtures Import openapi3 dereferenced-with-tags-input.json 1`] = `
"body": { "body": {
"mimeType": "multipart/form-data", "mimeType": "multipart/form-data",
}, },
"description": "",
"headers": [ "headers": [
{ {
"disabled": false, "disabled": false,
@ -1730,6 +1758,7 @@ exports[`Fixtures Import openapi3 dereferenced-with-tags-input.json 1`] = `
"value": "{{ _.apiKey }}", "value": "{{ _.apiKey }}",
}, },
"body": {}, "body": {},
"description": "Returns a map of status codes to quantities",
"headers": [], "headers": [],
"method": "GET", "method": "GET",
"name": "Returns pet inventories by status", "name": "Returns pet inventories by status",
@ -1742,6 +1771,7 @@ exports[`Fixtures Import openapi3 dereferenced-with-tags-input.json 1`] = `
"_type": "request", "_type": "request",
"authentication": {}, "authentication": {},
"body": {}, "body": {},
"description": "",
"headers": [], "headers": [],
"method": "POST", "method": "POST",
"name": "Place an order for a pet", "name": "Place an order for a pet",
@ -1754,6 +1784,7 @@ exports[`Fixtures Import openapi3 dereferenced-with-tags-input.json 1`] = `
"_type": "request", "_type": "request",
"authentication": {}, "authentication": {},
"body": {}, "body": {},
"description": "For valid response try integer IDs with value >= 1 and <= 10. Other values will generated exceptions",
"headers": [], "headers": [],
"method": "GET", "method": "GET",
"name": "Find purchase order by ID", "name": "Find purchase order by ID",
@ -1766,6 +1797,7 @@ exports[`Fixtures Import openapi3 dereferenced-with-tags-input.json 1`] = `
"_type": "request", "_type": "request",
"authentication": {}, "authentication": {},
"body": {}, "body": {},
"description": "For valid response try integer IDs with positive integer value. Negative or non-integer values will generate API errors",
"headers": [], "headers": [],
"method": "DELETE", "method": "DELETE",
"name": "Delete purchase order by ID", "name": "Delete purchase order by ID",
@ -1778,6 +1810,7 @@ exports[`Fixtures Import openapi3 dereferenced-with-tags-input.json 1`] = `
"_type": "request", "_type": "request",
"authentication": {}, "authentication": {},
"body": {}, "body": {},
"description": "This can only be done by the logged in user.",
"headers": [], "headers": [],
"method": "POST", "method": "POST",
"name": "Create user", "name": "Create user",
@ -1790,6 +1823,7 @@ exports[`Fixtures Import openapi3 dereferenced-with-tags-input.json 1`] = `
"_type": "request", "_type": "request",
"authentication": {}, "authentication": {},
"body": {}, "body": {},
"description": "",
"headers": [], "headers": [],
"method": "POST", "method": "POST",
"name": "Creates list of users with given input array", "name": "Creates list of users with given input array",
@ -1802,6 +1836,7 @@ exports[`Fixtures Import openapi3 dereferenced-with-tags-input.json 1`] = `
"_type": "request", "_type": "request",
"authentication": {}, "authentication": {},
"body": {}, "body": {},
"description": "",
"headers": [], "headers": [],
"method": "POST", "method": "POST",
"name": "Creates list of users with given input array", "name": "Creates list of users with given input array",
@ -1814,6 +1849,7 @@ exports[`Fixtures Import openapi3 dereferenced-with-tags-input.json 1`] = `
"_type": "request", "_type": "request",
"authentication": {}, "authentication": {},
"body": {}, "body": {},
"description": "",
"headers": [], "headers": [],
"method": "GET", "method": "GET",
"name": "Logs user into the system", "name": "Logs user into the system",
@ -1837,6 +1873,7 @@ exports[`Fixtures Import openapi3 dereferenced-with-tags-input.json 1`] = `
"_type": "request", "_type": "request",
"authentication": {}, "authentication": {},
"body": {}, "body": {},
"description": "",
"headers": [], "headers": [],
"method": "GET", "method": "GET",
"name": "Logs out current logged in user session", "name": "Logs out current logged in user session",
@ -1849,6 +1886,7 @@ exports[`Fixtures Import openapi3 dereferenced-with-tags-input.json 1`] = `
"_type": "request", "_type": "request",
"authentication": {}, "authentication": {},
"body": {}, "body": {},
"description": "",
"headers": [], "headers": [],
"method": "GET", "method": "GET",
"name": "Get user by user name", "name": "Get user by user name",
@ -1861,6 +1899,7 @@ exports[`Fixtures Import openapi3 dereferenced-with-tags-input.json 1`] = `
"_type": "request", "_type": "request",
"authentication": {}, "authentication": {},
"body": {}, "body": {},
"description": "This can only be done by the logged in user.",
"headers": [], "headers": [],
"method": "PUT", "method": "PUT",
"name": "Updated user", "name": "Updated user",
@ -1873,6 +1912,7 @@ exports[`Fixtures Import openapi3 dereferenced-with-tags-input.json 1`] = `
"_type": "request", "_type": "request",
"authentication": {}, "authentication": {},
"body": {}, "body": {},
"description": "This can only be done by the logged in user.",
"headers": [], "headers": [],
"method": "DELETE", "method": "DELETE",
"name": "Delete user", "name": "Delete user",
@ -1937,6 +1977,7 @@ exports[`Fixtures Import openapi3 endpoint-security-input.yaml 1`] = `
"_type": "request", "_type": "request",
"authentication": {}, "authentication": {},
"body": {}, "body": {},
"description": "",
"headers": [], "headers": [],
"method": "GET", "method": "GET",
"name": "/none", "name": "/none",
@ -1953,6 +1994,7 @@ exports[`Fixtures Import openapi3 endpoint-security-input.yaml 1`] = `
"username": "{{ _.httpUsername }}", "username": "{{ _.httpUsername }}",
}, },
"body": {}, "body": {},
"description": "",
"headers": [], "headers": [],
"method": "GET", "method": "GET",
"name": "/none/basic", "name": "/none/basic",
@ -1969,6 +2011,7 @@ exports[`Fixtures Import openapi3 endpoint-security-input.yaml 1`] = `
"username": "{{ _.httpUsername }}", "username": "{{ _.httpUsername }}",
}, },
"body": {}, "body": {},
"description": "",
"headers": [], "headers": [],
"method": "GET", "method": "GET",
"name": "/basic", "name": "/basic",
@ -1985,6 +2028,7 @@ exports[`Fixtures Import openapi3 endpoint-security-input.yaml 1`] = `
"type": "bearer", "type": "bearer",
}, },
"body": {}, "body": {},
"description": "",
"headers": [], "headers": [],
"method": "GET", "method": "GET",
"name": "/bearer", "name": "/bearer",
@ -1997,6 +2041,7 @@ exports[`Fixtures Import openapi3 endpoint-security-input.yaml 1`] = `
"_type": "request", "_type": "request",
"authentication": {}, "authentication": {},
"body": {}, "body": {},
"description": "",
"headers": [ "headers": [
{ {
"disabled": false, "disabled": false,
@ -2020,6 +2065,7 @@ exports[`Fixtures Import openapi3 endpoint-security-input.yaml 1`] = `
"_type": "request", "_type": "request",
"authentication": {}, "authentication": {},
"body": {}, "body": {},
"description": "",
"headers": [ "headers": [
{ {
"disabled": false, "disabled": false,
@ -2038,6 +2084,7 @@ exports[`Fixtures Import openapi3 endpoint-security-input.yaml 1`] = `
"_type": "request", "_type": "request",
"authentication": {}, "authentication": {},
"body": {}, "body": {},
"description": "",
"headers": [], "headers": [],
"method": "GET", "method": "GET",
"name": "/key/query", "name": "/key/query",
@ -2070,6 +2117,7 @@ exports[`Fixtures Import openapi3 endpoint-security-input.yaml 1`] = `
"type": "oauth2", "type": "oauth2",
}, },
"body": {}, "body": {},
"description": "",
"headers": [], "headers": [],
"method": "GET", "method": "GET",
"name": "/oauth2/authorization-code", "name": "/oauth2/authorization-code",
@ -2089,6 +2137,7 @@ exports[`Fixtures Import openapi3 endpoint-security-input.yaml 1`] = `
"type": "oauth2", "type": "oauth2",
}, },
"body": {}, "body": {},
"description": "",
"headers": [], "headers": [],
"method": "GET", "method": "GET",
"name": "/oauth2/implicit", "name": "/oauth2/implicit",
@ -2108,6 +2157,7 @@ exports[`Fixtures Import openapi3 endpoint-security-input.yaml 1`] = `
"type": "oauth2", "type": "oauth2",
}, },
"body": {}, "body": {},
"description": "",
"headers": [], "headers": [],
"method": "GET", "method": "GET",
"name": "/oauth2/client-credentials", "name": "/oauth2/client-credentials",
@ -2129,6 +2179,7 @@ exports[`Fixtures Import openapi3 endpoint-security-input.yaml 1`] = `
"username": "{{ _.oauth2Username }}", "username": "{{ _.oauth2Username }}",
}, },
"body": {}, "body": {},
"description": "",
"headers": [], "headers": [],
"method": "GET", "method": "GET",
"name": "/oauth2/password", "name": "/oauth2/password",
@ -2145,6 +2196,7 @@ exports[`Fixtures Import openapi3 endpoint-security-input.yaml 1`] = `
"username": "{{ _.httpUsername }}", "username": "{{ _.httpUsername }}",
}, },
"body": {}, "body": {},
"description": "",
"headers": [ "headers": [
{ {
"disabled": false, "disabled": false,
@ -2212,6 +2264,7 @@ exports[`Fixtures Import openapi3 example-with-server-variables-input.yaml 1`] =
"_type": "request", "_type": "request",
"authentication": {}, "authentication": {},
"body": {}, "body": {},
"description": "",
"headers": [], "headers": [],
"method": "GET", "method": "GET",
"name": "/files", "name": "/files",
@ -2262,6 +2315,7 @@ exports[`Fixtures Import openapi3 example-without-servers-input.yaml 1`] = `
"_type": "request", "_type": "request",
"authentication": {}, "authentication": {},
"body": {}, "body": {},
"description": "",
"headers": [], "headers": [],
"method": "GET", "method": "GET",
"name": "List API versions", "name": "List API versions",
@ -2274,6 +2328,7 @@ exports[`Fixtures Import openapi3 example-without-servers-input.yaml 1`] = `
"_type": "request", "_type": "request",
"authentication": {}, "authentication": {},
"body": {}, "body": {},
"description": "",
"headers": [], "headers": [],
"method": "GET", "method": "GET",
"name": "Show API version details", "name": "Show API version details",
@ -2334,6 +2389,7 @@ exports[`Fixtures Import openapi3 global-security-input.yaml 1`] = `
"username": "{{ _.httpUsername }}", "username": "{{ _.httpUsername }}",
}, },
"body": {}, "body": {},
"description": "",
"headers": [ "headers": [
{ {
"disabled": false, "disabled": false,
@ -2357,6 +2413,7 @@ exports[`Fixtures Import openapi3 global-security-input.yaml 1`] = `
"value": "{{ _.apiKeyHere }}", "value": "{{ _.apiKeyHere }}",
}, },
"body": {}, "body": {},
"description": "",
"headers": [], "headers": [],
"method": "GET", "method": "GET",
"name": "/override", "name": "/override",
@ -2418,6 +2475,7 @@ exports[`Fixtures Import openapi3 multiple-api-keys-input.yml 1`] = `
"_type": "request", "_type": "request",
"authentication": {}, "authentication": {},
"body": {}, "body": {},
"description": "",
"headers": [ "headers": [
{ {
"disabled": false, "disabled": false,
@ -2446,6 +2504,7 @@ exports[`Fixtures Import openapi3 multiple-api-keys-input.yml 1`] = `
"_type": "request", "_type": "request",
"authentication": {}, "authentication": {},
"body": {}, "body": {},
"description": "Multiple status values can be provided with comma separated strings",
"headers": [ "headers": [
{ {
"disabled": false, "disabled": false,
@ -2530,6 +2589,7 @@ exports[`Fixtures Import openapi3 oauth2-input.yaml 1`] = `
"type": "oauth2", "type": "oauth2",
}, },
"body": {}, "body": {},
"description": "",
"headers": [], "headers": [],
"method": "GET", "method": "GET",
"name": "/oauth2/authorization-code", "name": "/oauth2/authorization-code",
@ -2551,6 +2611,7 @@ exports[`Fixtures Import openapi3 oauth2-input.yaml 1`] = `
"type": "oauth2", "type": "oauth2",
}, },
"body": {}, "body": {},
"description": "",
"headers": [], "headers": [],
"method": "GET", "method": "GET",
"name": "/oauth2/authorization-code-read", "name": "/oauth2/authorization-code-read",
@ -2572,6 +2633,7 @@ exports[`Fixtures Import openapi3 oauth2-input.yaml 1`] = `
"type": "oauth2", "type": "oauth2",
}, },
"body": {}, "body": {},
"description": "",
"headers": [], "headers": [],
"method": "GET", "method": "GET",
"name": "/oauth2/authorization-code-read-write", "name": "/oauth2/authorization-code-read-write",
@ -2622,6 +2684,7 @@ exports[`Fixtures Import openapi3 path-plugin-input.yaml 1`] = `
"_type": "request", "_type": "request",
"authentication": {}, "authentication": {},
"body": {}, "body": {},
"description": "test",
"headers": [], "headers": [],
"method": "GET", "method": "GET",
"name": "/path", "name": "/path",
@ -2716,6 +2779,7 @@ exports[`Fixtures Import openapi3 petstore-input.json 1`] = `
"status": "string" "status": "string"
}", }",
}, },
"description": "",
"headers": [ "headers": [
{ {
"disabled": false, "disabled": false,
@ -2761,6 +2825,7 @@ exports[`Fixtures Import openapi3 petstore-input.json 1`] = `
"status": "string" "status": "string"
}", }",
}, },
"description": "",
"headers": [ "headers": [
{ {
"disabled": false, "disabled": false,
@ -2786,6 +2851,7 @@ exports[`Fixtures Import openapi3 petstore-input.json 1`] = `
"type": "oauth2", "type": "oauth2",
}, },
"body": {}, "body": {},
"description": "Multiple status values can be provided with comma separated strings",
"headers": [], "headers": [],
"method": "GET", "method": "GET",
"name": "Finds Pets by status", "name": "Finds Pets by status",
@ -2811,6 +2877,7 @@ exports[`Fixtures Import openapi3 petstore-input.json 1`] = `
"type": "oauth2", "type": "oauth2",
}, },
"body": {}, "body": {},
"description": "Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.",
"headers": [], "headers": [],
"method": "GET", "method": "GET",
"name": "Finds Pets by tags", "name": "Finds Pets by tags",
@ -2834,6 +2901,7 @@ exports[`Fixtures Import openapi3 petstore-input.json 1`] = `
"value": "{{ _.apiKey }}", "value": "{{ _.apiKey }}",
}, },
"body": {}, "body": {},
"description": "Returns a single pet",
"headers": [], "headers": [],
"method": "GET", "method": "GET",
"name": "Find pet by ID", "name": "Find pet by ID",
@ -2855,6 +2923,7 @@ exports[`Fixtures Import openapi3 petstore-input.json 1`] = `
"body": { "body": {
"mimeType": "application/x-www-form-urlencoded", "mimeType": "application/x-www-form-urlencoded",
}, },
"description": "",
"headers": [ "headers": [
{ {
"disabled": false, "disabled": false,
@ -2880,6 +2949,7 @@ exports[`Fixtures Import openapi3 petstore-input.json 1`] = `
"type": "oauth2", "type": "oauth2",
}, },
"body": {}, "body": {},
"description": "",
"headers": [ "headers": [
{ {
"disabled": true, "disabled": true,
@ -2907,6 +2977,7 @@ exports[`Fixtures Import openapi3 petstore-input.json 1`] = `
"body": { "body": {
"mimeType": "multipart/form-data", "mimeType": "multipart/form-data",
}, },
"description": "",
"headers": [ "headers": [
{ {
"disabled": false, "disabled": false,
@ -2930,6 +3001,7 @@ exports[`Fixtures Import openapi3 petstore-input.json 1`] = `
"value": "{{ _.apiKey }}", "value": "{{ _.apiKey }}",
}, },
"body": {}, "body": {},
"description": "Returns a map of status codes to quantities",
"headers": [], "headers": [],
"method": "GET", "method": "GET",
"name": "Returns pet inventories by status", "name": "Returns pet inventories by status",
@ -2942,6 +3014,7 @@ exports[`Fixtures Import openapi3 petstore-input.json 1`] = `
"_type": "request", "_type": "request",
"authentication": {}, "authentication": {},
"body": {}, "body": {},
"description": "",
"headers": [], "headers": [],
"method": "POST", "method": "POST",
"name": "Place an order for a pet", "name": "Place an order for a pet",
@ -2954,6 +3027,7 @@ exports[`Fixtures Import openapi3 petstore-input.json 1`] = `
"_type": "request", "_type": "request",
"authentication": {}, "authentication": {},
"body": {}, "body": {},
"description": "For valid response try integer IDs with value >= 1 and <= 10. Other values will generated exceptions",
"headers": [], "headers": [],
"method": "GET", "method": "GET",
"name": "Find purchase order by ID", "name": "Find purchase order by ID",
@ -2966,6 +3040,7 @@ exports[`Fixtures Import openapi3 petstore-input.json 1`] = `
"_type": "request", "_type": "request",
"authentication": {}, "authentication": {},
"body": {}, "body": {},
"description": "For valid response try integer IDs with positive integer value. Negative or non-integer values will generate API errors",
"headers": [], "headers": [],
"method": "DELETE", "method": "DELETE",
"name": "Delete purchase order by ID", "name": "Delete purchase order by ID",
@ -2978,6 +3053,7 @@ exports[`Fixtures Import openapi3 petstore-input.json 1`] = `
"_type": "request", "_type": "request",
"authentication": {}, "authentication": {},
"body": {}, "body": {},
"description": "This can only be done by the logged in user.",
"headers": [], "headers": [],
"method": "POST", "method": "POST",
"name": "Create user", "name": "Create user",
@ -2990,6 +3066,7 @@ exports[`Fixtures Import openapi3 petstore-input.json 1`] = `
"_type": "request", "_type": "request",
"authentication": {}, "authentication": {},
"body": {}, "body": {},
"description": "",
"headers": [], "headers": [],
"method": "POST", "method": "POST",
"name": "Creates list of users with given input array", "name": "Creates list of users with given input array",
@ -3002,6 +3079,7 @@ exports[`Fixtures Import openapi3 petstore-input.json 1`] = `
"_type": "request", "_type": "request",
"authentication": {}, "authentication": {},
"body": {}, "body": {},
"description": "",
"headers": [], "headers": [],
"method": "POST", "method": "POST",
"name": "Creates list of users with given input array", "name": "Creates list of users with given input array",
@ -3014,6 +3092,7 @@ exports[`Fixtures Import openapi3 petstore-input.json 1`] = `
"_type": "request", "_type": "request",
"authentication": {}, "authentication": {},
"body": {}, "body": {},
"description": "",
"headers": [], "headers": [],
"method": "GET", "method": "GET",
"name": "Logs user into the system", "name": "Logs user into the system",
@ -3037,6 +3116,7 @@ exports[`Fixtures Import openapi3 petstore-input.json 1`] = `
"_type": "request", "_type": "request",
"authentication": {}, "authentication": {},
"body": {}, "body": {},
"description": "",
"headers": [], "headers": [],
"method": "GET", "method": "GET",
"name": "Logs out current logged in user session", "name": "Logs out current logged in user session",
@ -3049,6 +3129,7 @@ exports[`Fixtures Import openapi3 petstore-input.json 1`] = `
"_type": "request", "_type": "request",
"authentication": {}, "authentication": {},
"body": {}, "body": {},
"description": "",
"headers": [], "headers": [],
"method": "GET", "method": "GET",
"name": "Get user by user name", "name": "Get user by user name",
@ -3061,6 +3142,7 @@ exports[`Fixtures Import openapi3 petstore-input.json 1`] = `
"_type": "request", "_type": "request",
"authentication": {}, "authentication": {},
"body": {}, "body": {},
"description": "This can only be done by the logged in user.",
"headers": [], "headers": [],
"method": "PUT", "method": "PUT",
"name": "Updated user", "name": "Updated user",
@ -3073,6 +3155,7 @@ exports[`Fixtures Import openapi3 petstore-input.json 1`] = `
"_type": "request", "_type": "request",
"authentication": {}, "authentication": {},
"body": {}, "body": {},
"description": "This can only be done by the logged in user.",
"headers": [], "headers": [],
"method": "DELETE", "method": "DELETE",
"name": "Delete user", "name": "Delete user",
@ -3123,6 +3206,7 @@ exports[`Fixtures Import openapi3 petstore-readonly-input.yml 1`] = `
"_type": "request", "_type": "request",
"authentication": {}, "authentication": {},
"body": {}, "body": {},
"description": "",
"headers": [], "headers": [],
"method": "GET", "method": "GET",
"name": "List all pets", "name": "List all pets",
@ -3147,6 +3231,7 @@ exports[`Fixtures Import openapi3 petstore-readonly-input.yml 1`] = `
"tag": "string" "tag": "string"
}", }",
}, },
"description": "",
"headers": [ "headers": [
{ {
"disabled": false, "disabled": false,
@ -3165,6 +3250,7 @@ exports[`Fixtures Import openapi3 petstore-readonly-input.yml 1`] = `
"_type": "request", "_type": "request",
"authentication": {}, "authentication": {},
"body": {}, "body": {},
"description": "",
"headers": [], "headers": [],
"method": "GET", "method": "GET",
"name": "Info for a specific pet", "name": "Info for a specific pet",
@ -3269,6 +3355,7 @@ exports[`Fixtures Import openapi3 petstore-with-tags-input.json 1`] = `
"status": "string" "status": "string"
}", }",
}, },
"description": "",
"headers": [ "headers": [
{ {
"disabled": false, "disabled": false,
@ -3314,6 +3401,7 @@ exports[`Fixtures Import openapi3 petstore-with-tags-input.json 1`] = `
"status": "string" "status": "string"
}", }",
}, },
"description": "",
"headers": [ "headers": [
{ {
"disabled": false, "disabled": false,
@ -3339,6 +3427,7 @@ exports[`Fixtures Import openapi3 petstore-with-tags-input.json 1`] = `
"type": "oauth2", "type": "oauth2",
}, },
"body": {}, "body": {},
"description": "Multiple status values can be provided with comma separated strings",
"headers": [], "headers": [],
"method": "GET", "method": "GET",
"name": "Finds Pets by status", "name": "Finds Pets by status",
@ -3364,6 +3453,7 @@ exports[`Fixtures Import openapi3 petstore-with-tags-input.json 1`] = `
"type": "oauth2", "type": "oauth2",
}, },
"body": {}, "body": {},
"description": "Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.",
"headers": [], "headers": [],
"method": "GET", "method": "GET",
"name": "Finds Pets by tags", "name": "Finds Pets by tags",
@ -3387,6 +3477,7 @@ exports[`Fixtures Import openapi3 petstore-with-tags-input.json 1`] = `
"value": "{{ _.apiKey }}", "value": "{{ _.apiKey }}",
}, },
"body": {}, "body": {},
"description": "Returns a single pet",
"headers": [], "headers": [],
"method": "GET", "method": "GET",
"name": "Find pet by ID", "name": "Find pet by ID",
@ -3408,6 +3499,7 @@ exports[`Fixtures Import openapi3 petstore-with-tags-input.json 1`] = `
"body": { "body": {
"mimeType": "application/x-www-form-urlencoded", "mimeType": "application/x-www-form-urlencoded",
}, },
"description": "",
"headers": [ "headers": [
{ {
"disabled": false, "disabled": false,
@ -3433,6 +3525,7 @@ exports[`Fixtures Import openapi3 petstore-with-tags-input.json 1`] = `
"type": "oauth2", "type": "oauth2",
}, },
"body": {}, "body": {},
"description": "",
"headers": [ "headers": [
{ {
"disabled": true, "disabled": true,
@ -3460,6 +3553,7 @@ exports[`Fixtures Import openapi3 petstore-with-tags-input.json 1`] = `
"body": { "body": {
"mimeType": "multipart/form-data", "mimeType": "multipart/form-data",
}, },
"description": "",
"headers": [ "headers": [
{ {
"disabled": false, "disabled": false,
@ -3483,6 +3577,7 @@ exports[`Fixtures Import openapi3 petstore-with-tags-input.json 1`] = `
"value": "{{ _.apiKey }}", "value": "{{ _.apiKey }}",
}, },
"body": {}, "body": {},
"description": "Returns a map of status codes to quantities",
"headers": [], "headers": [],
"method": "GET", "method": "GET",
"name": "Returns pet inventories by status", "name": "Returns pet inventories by status",
@ -3495,6 +3590,7 @@ exports[`Fixtures Import openapi3 petstore-with-tags-input.json 1`] = `
"_type": "request", "_type": "request",
"authentication": {}, "authentication": {},
"body": {}, "body": {},
"description": "",
"headers": [], "headers": [],
"method": "POST", "method": "POST",
"name": "Place an order for a pet", "name": "Place an order for a pet",
@ -3507,6 +3603,7 @@ exports[`Fixtures Import openapi3 petstore-with-tags-input.json 1`] = `
"_type": "request", "_type": "request",
"authentication": {}, "authentication": {},
"body": {}, "body": {},
"description": "For valid response try integer IDs with value >= 1 and <= 10. Other values will generated exceptions",
"headers": [], "headers": [],
"method": "GET", "method": "GET",
"name": "Find purchase order by ID", "name": "Find purchase order by ID",
@ -3519,6 +3616,7 @@ exports[`Fixtures Import openapi3 petstore-with-tags-input.json 1`] = `
"_type": "request", "_type": "request",
"authentication": {}, "authentication": {},
"body": {}, "body": {},
"description": "For valid response try integer IDs with positive integer value. Negative or non-integer values will generate API errors",
"headers": [], "headers": [],
"method": "DELETE", "method": "DELETE",
"name": "Delete purchase order by ID", "name": "Delete purchase order by ID",
@ -3531,6 +3629,7 @@ exports[`Fixtures Import openapi3 petstore-with-tags-input.json 1`] = `
"_type": "request", "_type": "request",
"authentication": {}, "authentication": {},
"body": {}, "body": {},
"description": "This can only be done by the logged in user.",
"headers": [], "headers": [],
"method": "POST", "method": "POST",
"name": "Create user", "name": "Create user",
@ -3543,6 +3642,7 @@ exports[`Fixtures Import openapi3 petstore-with-tags-input.json 1`] = `
"_type": "request", "_type": "request",
"authentication": {}, "authentication": {},
"body": {}, "body": {},
"description": "",
"headers": [], "headers": [],
"method": "POST", "method": "POST",
"name": "Creates list of users with given input array", "name": "Creates list of users with given input array",
@ -3555,6 +3655,7 @@ exports[`Fixtures Import openapi3 petstore-with-tags-input.json 1`] = `
"_type": "request", "_type": "request",
"authentication": {}, "authentication": {},
"body": {}, "body": {},
"description": "",
"headers": [], "headers": [],
"method": "POST", "method": "POST",
"name": "Creates list of users with given input array", "name": "Creates list of users with given input array",
@ -3567,6 +3668,7 @@ exports[`Fixtures Import openapi3 petstore-with-tags-input.json 1`] = `
"_type": "request", "_type": "request",
"authentication": {}, "authentication": {},
"body": {}, "body": {},
"description": "",
"headers": [], "headers": [],
"method": "GET", "method": "GET",
"name": "Logs user into the system", "name": "Logs user into the system",
@ -3590,6 +3692,7 @@ exports[`Fixtures Import openapi3 petstore-with-tags-input.json 1`] = `
"_type": "request", "_type": "request",
"authentication": {}, "authentication": {},
"body": {}, "body": {},
"description": "",
"headers": [], "headers": [],
"method": "GET", "method": "GET",
"name": "Logs out current logged in user session", "name": "Logs out current logged in user session",
@ -3602,6 +3705,7 @@ exports[`Fixtures Import openapi3 petstore-with-tags-input.json 1`] = `
"_type": "request", "_type": "request",
"authentication": {}, "authentication": {},
"body": {}, "body": {},
"description": "",
"headers": [], "headers": [],
"method": "GET", "method": "GET",
"name": "Get user by user name", "name": "Get user by user name",
@ -3614,6 +3718,7 @@ exports[`Fixtures Import openapi3 petstore-with-tags-input.json 1`] = `
"_type": "request", "_type": "request",
"authentication": {}, "authentication": {},
"body": {}, "body": {},
"description": "This can only be done by the logged in user.",
"headers": [], "headers": [],
"method": "PUT", "method": "PUT",
"name": "Updated user", "name": "Updated user",
@ -3626,6 +3731,7 @@ exports[`Fixtures Import openapi3 petstore-with-tags-input.json 1`] = `
"_type": "request", "_type": "request",
"authentication": {}, "authentication": {},
"body": {}, "body": {},
"description": "This can only be done by the logged in user.",
"headers": [], "headers": [],
"method": "DELETE", "method": "DELETE",
"name": "Delete user", "name": "Delete user",
@ -3676,6 +3782,7 @@ exports[`Fixtures Import openapi3 petstore-yml-input.yml 1`] = `
"_type": "request", "_type": "request",
"authentication": {}, "authentication": {},
"body": {}, "body": {},
"description": "",
"headers": [], "headers": [],
"method": "GET", "method": "GET",
"name": "List all pets", "name": "List all pets",
@ -3694,6 +3801,7 @@ exports[`Fixtures Import openapi3 petstore-yml-input.yml 1`] = `
"_type": "request", "_type": "request",
"authentication": {}, "authentication": {},
"body": {}, "body": {},
"description": "",
"headers": [], "headers": [],
"method": "POST", "method": "POST",
"name": "Create a pet", "name": "Create a pet",
@ -3706,6 +3814,7 @@ exports[`Fixtures Import openapi3 petstore-yml-input.yml 1`] = `
"_type": "request", "_type": "request",
"authentication": {}, "authentication": {},
"body": {}, "body": {},
"description": "",
"headers": [], "headers": [],
"method": "GET", "method": "GET",
"name": "Info for a specific pet", "name": "Info for a specific pet",
@ -3764,6 +3873,7 @@ exports[`Fixtures Import openapi3 petstore-yml-with-tags-input.yml 1`] = `
"_type": "request", "_type": "request",
"authentication": {}, "authentication": {},
"body": {}, "body": {},
"description": "",
"headers": [], "headers": [],
"method": "GET", "method": "GET",
"name": "List all pets", "name": "List all pets",
@ -3782,6 +3892,7 @@ exports[`Fixtures Import openapi3 petstore-yml-with-tags-input.yml 1`] = `
"_type": "request", "_type": "request",
"authentication": {}, "authentication": {},
"body": {}, "body": {},
"description": "",
"headers": [], "headers": [],
"method": "GET", "method": "GET",
"name": "List all pets", "name": "List all pets",
@ -3800,6 +3911,7 @@ exports[`Fixtures Import openapi3 petstore-yml-with-tags-input.yml 1`] = `
"_type": "request", "_type": "request",
"authentication": {}, "authentication": {},
"body": {}, "body": {},
"description": "",
"headers": [], "headers": [],
"method": "POST", "method": "POST",
"name": "Create a pet", "name": "Create a pet",
@ -3812,6 +3924,7 @@ exports[`Fixtures Import openapi3 petstore-yml-with-tags-input.yml 1`] = `
"_type": "request", "_type": "request",
"authentication": {}, "authentication": {},
"body": {}, "body": {},
"description": "",
"headers": [], "headers": [],
"method": "GET", "method": "GET",
"name": "Info for a specific pet", "name": "Info for a specific pet",

1
packages/insomnia/src/utils/importers/importers/openapi-3.ts
View File

@ -303,6 +303,7 @@ const importRequest = (
method: endpointSchema.method?.toUpperCase(), method: endpointSchema.method?.toUpperCase(),
url: `{{ _.base_url }}${pathWithParamsAsVariables(endpointSchema.path)}`, url: `{{ _.base_url }}${pathWithParamsAsVariables(endpointSchema.path)}`,
body: body, body: body,
description: endpointSchema.description || '',
headers: [...paramHeaders, ...securityHeaders], headers: [...paramHeaders, ...securityHeaders],
authentication: authentication as Authentication, authentication: authentication as Authentication,
parameters: [...prepareQueryParams(endpointSchema), ...securityParams], parameters: [...prepareQueryParams(endpointSchema), ...securityParams],