apib2swagger 1.12.0 → 1.14.1

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.
Files changed (124) hide show
  1. package/.github/workflows/codeql-analysis.yml +71 -0
  2. package/.github/workflows/docker-publish.yml +1 -1
  3. package/.github/workflows/nodejs.yml +1 -1
  4. package/.travis.yml +2 -1
  5. package/Dockerfile +1 -1
  6. package/LICENSE +0 -0
  7. package/README.md +30 -9
  8. package/bin/apib2swagger.js +44 -18
  9. package/index.js +82 -366
  10. package/package.json +7 -4
  11. package/src/escape_json_pointer.js +0 -0
  12. package/src/mson_to_json_schema.js +12 -10
  13. package/src/parameters.js +111 -0
  14. package/src/requests.js +357 -0
  15. package/src/responses.js +186 -0
  16. package/src/util.js +125 -0
  17. package/test/input/Attributes.md +0 -0
  18. package/test/input/Issue-#15.md +0 -0
  19. package/test/input/Issue-#22.md +0 -0
  20. package/test/input/Issue-#23.md +0 -0
  21. package/test/input/Issue-#26.md +0 -0
  22. package/test/input/Issue-#29.md +0 -0
  23. package/test/input/Issue-#33.md +0 -0
  24. package/test/input/Issue-#35.md +0 -0
  25. package/test/input/Issue-#36.md +0 -0
  26. package/test/input/Issue-#38.md +0 -0
  27. package/test/input/Issue-#49.md +0 -0
  28. package/test/input/Issue-#57.md +14 -0
  29. package/test/input/OpenAPI3_Issue-#58.md +31 -0
  30. package/test/input/OpenAPI3_attributes.md +36 -0
  31. package/test/input/OpenAPI3_headers.md +74 -0
  32. package/test/input/OpenAPI3_includes.md +22 -0
  33. package/test/input/OpenAPI3_requests.md +162 -0
  34. package/test/input/OpenAPI3_responses.md +177 -0
  35. package/test/input/Schema.md +0 -0
  36. package/test/input/apiblueprint_uber.md +0 -0
  37. package/test/input/apiblueprint_valid_simple.md +0 -0
  38. package/test/input/includes/resource-request-body-2.json +3 -0
  39. package/test/input/includes/resource-request-body.json +3 -0
  40. package/test/input/includes/resource-request-schema.json +9 -0
  41. package/test/input/includes/resource-response-body-2.json +3 -0
  42. package/test/input/includes/resource-response-body.json +3 -0
  43. package/test/input/includes/resource-response-schema.json +9 -0
  44. package/test/input/schema_without_body.md +17 -0
  45. package/test/meta_schema.json +0 -0
  46. package/test/openAPI_30_schema.json +1662 -0
  47. package/test/output/01. Simplest API.json +0 -0
  48. package/test/output/01. Simplest API.ref.json +0 -0
  49. package/test/output/02. Resource and Actions.json +0 -0
  50. package/test/output/02. Resource and Actions.ref.json +0 -0
  51. package/test/output/03. Named Resource and Actions.json +0 -0
  52. package/test/output/03. Named Resource and Actions.ref.json +0 -0
  53. package/test/output/04. Grouping Resources.json +0 -0
  54. package/test/output/04. Grouping Resources.ref.json +0 -0
  55. package/test/output/05. Responses.json +0 -0
  56. package/test/output/05. Responses.ref.json +0 -0
  57. package/test/output/06. Requests.json +0 -0
  58. package/test/output/06. Requests.ref.json +0 -0
  59. package/test/output/07. Parameters.json +0 -0
  60. package/test/output/07. Parameters.ref.json +0 -0
  61. package/test/output/08. Attributes.json +0 -0
  62. package/test/output/08. Attributes.ref.json +0 -0
  63. package/test/output/09. Advanced Attributes.json +0 -0
  64. package/test/output/09. Advanced Attributes.ref.json +0 -0
  65. package/test/output/10. Data Structures.json +0 -0
  66. package/test/output/10. Data Structures.ref.json +0 -0
  67. package/test/output/11. Resource Model.json +0 -0
  68. package/test/output/11. Resource Model.ref.json +0 -0
  69. package/test/output/12. Advanced Action.json +0 -0
  70. package/test/output/12. Advanced Action.ref.json +0 -0
  71. package/test/output/13. Named Endpoints.json +0 -0
  72. package/test/output/13. Named Endpoints.ref.json +0 -0
  73. package/test/output/Attributes.json +0 -0
  74. package/test/output/Attributes.ref.json +0 -0
  75. package/test/output/Gist Fox API + Auth.json +0 -0
  76. package/test/output/Gist Fox API + Auth.ref.json +0 -0
  77. package/test/output/Issue-#15.json +0 -0
  78. package/test/output/Issue-#15.ref.json +0 -0
  79. package/test/output/Issue-#22.json +0 -0
  80. package/test/output/Issue-#22.ref.json +0 -0
  81. package/test/output/Issue-#23.json +0 -0
  82. package/test/output/Issue-#23.ref.json +0 -0
  83. package/test/output/Issue-#26.json +0 -0
  84. package/test/output/Issue-#26.ref.json +0 -0
  85. package/test/output/Issue-#29.json +0 -0
  86. package/test/output/Issue-#29.ref.json +0 -0
  87. package/test/output/Issue-#33.json +0 -0
  88. package/test/output/Issue-#33.ref.json +0 -0
  89. package/test/output/Issue-#35.json +0 -0
  90. package/test/output/Issue-#35.ref.json +0 -0
  91. package/test/output/Issue-#36.json +0 -0
  92. package/test/output/Issue-#36.ref.json +0 -0
  93. package/test/output/Issue-#38.bearer.json +0 -0
  94. package/test/output/Issue-#38.json +0 -0
  95. package/test/output/Issue-#38.ref.json +0 -0
  96. package/test/output/Issue-#49.json +0 -0
  97. package/test/output/Issue-#49.ref.json +0 -0
  98. package/test/output/Issue-#57.json +44 -0
  99. package/test/output/Issue-#57.ref.json +44 -0
  100. package/test/output/OpenAPI3_Issue-#58.json +202 -0
  101. package/test/output/OpenAPI3_Issue-#58.ref.json +163 -0
  102. package/test/output/OpenAPI3_attributes.json +199 -0
  103. package/test/output/OpenAPI3_attributes.ref.json +173 -0
  104. package/test/output/OpenAPI3_headers.json +169 -0
  105. package/test/output/OpenAPI3_headers.ref.json +169 -0
  106. package/test/output/OpenAPI3_includes.json +66 -0
  107. package/test/output/OpenAPI3_includes.ref.json +66 -0
  108. package/test/output/OpenAPI3_requests.json +326 -0
  109. package/test/output/OpenAPI3_requests.ref.json +321 -0
  110. package/test/output/OpenAPI3_responses.json +255 -0
  111. package/test/output/OpenAPI3_responses.ref.json +245 -0
  112. package/test/output/Schema.json +0 -0
  113. package/test/output/Schema.ref.json +0 -0
  114. package/test/output/apiblueprint_uber.json +0 -0
  115. package/test/output/apiblueprint_uber.ref.json +0 -0
  116. package/test/output/apiblueprint_valid_simple.json +0 -0
  117. package/test/output/apiblueprint_valid_simple.ref.json +0 -0
  118. package/test/output/schema_without_body.json +52 -0
  119. package/test/output/schema_without_body.ref.json +52 -0
  120. package/test/swagger_20_schema.json +0 -0
  121. package/test/test.js +26 -9
  122. package/test/util.test.js +151 -0
  123. package/.npmignore +0 -35
  124. package/package-lock.json +0 -2021
package/test/output/OpenAPI3_attributes.json ADDED
@@ -0,0 +1,199 @@
1
+ {
2
+ "openapi": "3.0.3",
3
+ "info": {
4
+ "title": "",
5
+ "version": "1.0.0",
6
+ "description": ""
7
+ },
8
+ "servers": [
9
+ {
10
+ "url": "https://www.testhost.com"
11
+ }
12
+ ],
13
+ "paths": {
14
+ "/object": {
15
+ "get": {
16
+ "responses": {
17
+ "200": {
18
+ "description": "OK",
19
+ "headers": {},
20
+ "content": {
21
+ "application/json": {
22
+ "schema": {
23
+ "oneOf": [
24
+ {
25
+ "type": "object",
26
+ "properties": {
27
+ "message": {
28
+ "type": "string"
29
+ }
30
+ }
31
+ },
32
+ {
33
+ "type": "object",
34
+ "properties": {
35
+ "otherMessage": {
36
+ "type": "string"
37
+ },
38
+ "someNum": {
39
+ "type": "number"
40
+ }
41
+ }
42
+ }
43
+ ]
44
+ },
45
+ "examples": {
46
+ "example1": {
47
+ "value": {
48
+ "message": ""
49
+ }
50
+ },
51
+ "example2": {
52
+ "value": {
53
+ "otherMessage": "",
54
+ "someNum": 0
55
+ }
56
+ }
57
+ }
58
+ }
59
+ }
60
+ }
61
+ },
62
+ "summary": "Some resource",
63
+ "operationId": "Some resource",
64
+ "description": "",
65
+ "tags": [],
66
+ "parameters": []
67
+ }
68
+ },
69
+ "/array/object": {
70
+ "post": {
71
+ "responses": {
72
+ "200": {
73
+ "description": "OK",
74
+ "headers": {},
75
+ "content": {
76
+ "application/json": {
77
+ "schema": {
78
+ "type": "array",
79
+ "items": {
80
+ "type": "object",
81
+ "properties": {
82
+ "path": {
83
+ "type": "string"
84
+ },
85
+ "otherMessage": {
86
+ "type": "object",
87
+ "properties": {
88
+ "otherMessage": {
89
+ "type": "string"
90
+ },
91
+ "someNum": {
92
+ "type": "number"
93
+ }
94
+ }
95
+ }
96
+ },
97
+ "required": [
98
+ "path"
99
+ ]
100
+ }
101
+ },
102
+ "example": [
103
+ {
104
+ "path": "/files",
105
+ "otherMessage": {
106
+ "otherMessage": "",
107
+ "someNum": 0
108
+ }
109
+ }
110
+ ]
111
+ }
112
+ }
113
+ }
114
+ },
115
+ "summary": "Some resource",
116
+ "operationId": "Some resource",
117
+ "description": "",
118
+ "tags": [],
119
+ "parameters": [],
120
+ "requestBody": {
121
+ "content": {
122
+ "application/json": {
123
+ "example": {
124
+ "message": ""
125
+ },
126
+ "schema": {
127
+ "type": "object",
128
+ "properties": {
129
+ "message": {
130
+ "type": "string"
131
+ }
132
+ }
133
+ }
134
+ }
135
+ }
136
+ }
137
+ }
138
+ },
139
+ "/messages": {
140
+ "get": {
141
+ "responses": {
142
+ "200": {
143
+ "description": "OK",
144
+ "headers": {},
145
+ "content": {
146
+ "application/json": {
147
+ "schema": {
148
+ "type": "array",
149
+ "items": {
150
+ "type": "object",
151
+ "properties": {
152
+ "message": {
153
+ "type": "string"
154
+ }
155
+ }
156
+ }
157
+ },
158
+ "example": [
159
+ {
160
+ "message": ""
161
+ }
162
+ ]
163
+ }
164
+ }
165
+ }
166
+ },
167
+ "summary": "Some resource",
168
+ "operationId": "Some resource",
169
+ "description": "",
170
+ "tags": [],
171
+ "parameters": []
172
+ }
173
+ }
174
+ },
175
+ "components": {
176
+ "schemas": {
177
+ "Message": {
178
+ "type": "object",
179
+ "properties": {
180
+ "message": {
181
+ "type": "string"
182
+ }
183
+ }
184
+ },
185
+ "OtherMessage": {
186
+ "type": "object",
187
+ "properties": {
188
+ "otherMessage": {
189
+ "type": "string"
190
+ },
191
+ "someNum": {
192
+ "type": "number"
193
+ }
194
+ }
195
+ }
196
+ }
197
+ },
198
+ "tags": []
199
+ }
package/test/output/OpenAPI3_attributes.ref.json ADDED
@@ -0,0 +1,173 @@
1
+ {
2
+ "openapi": "3.0.3",
3
+ "info": {
4
+ "title": "",
5
+ "version": "1.0.0",
6
+ "description": ""
7
+ },
8
+ "servers": [
9
+ {
10
+ "url": "https://www.testhost.com"
11
+ }
12
+ ],
13
+ "paths": {
14
+ "/object": {
15
+ "get": {
16
+ "responses": {
17
+ "200": {
18
+ "description": "OK",
19
+ "headers": {},
20
+ "content": {
21
+ "application/json": {
22
+ "schema": {
23
+ "oneOf": [
24
+ {
25
+ "type": "object",
26
+ "properties": {
27
+ "message": {
28
+ "type": "string"
29
+ }
30
+ }
31
+ },
32
+ {
33
+ "$ref": "#/components/schemas/OtherMessage"
34
+ }
35
+ ]
36
+ },
37
+ "examples": {
38
+ "example1": {
39
+ "value": {
40
+ "message": ""
41
+ }
42
+ },
43
+ "example2": {
44
+ "value": {
45
+ "otherMessage": "",
46
+ "someNum": 0
47
+ }
48
+ }
49
+ }
50
+ }
51
+ }
52
+ }
53
+ },
54
+ "summary": "Some resource",
55
+ "operationId": "Some resource",
56
+ "description": "",
57
+ "tags": [],
58
+ "parameters": []
59
+ }
60
+ },
61
+ "/array/object": {
62
+ "post": {
63
+ "responses": {
64
+ "200": {
65
+ "description": "OK",
66
+ "headers": {},
67
+ "content": {
68
+ "application/json": {
69
+ "schema": {
70
+ "type": "array",
71
+ "items": {
72
+ "type": "object",
73
+ "required": [
74
+ "path"
75
+ ],
76
+ "properties": {
77
+ "path": {
78
+ "type": "string"
79
+ },
80
+ "otherMessage": {
81
+ "$ref": "#/components/schemas/OtherMessage"
82
+ }
83
+ }
84
+ }
85
+ },
86
+ "example": [
87
+ {
88
+ "path": "/files",
89
+ "otherMessage": {
90
+ "otherMessage": "",
91
+ "someNum": 0
92
+ }
93
+ }
94
+ ]
95
+ }
96
+ }
97
+ }
98
+ },
99
+ "summary": "Some resource",
100
+ "operationId": "Some resource",
101
+ "description": "",
102
+ "tags": [],
103
+ "parameters": [],
104
+ "requestBody": {
105
+ "content": {
106
+ "application/json": {
107
+ "example": {
108
+ "message": ""
109
+ },
110
+ "schema": {
111
+ "$ref": "#/components/schemas/Message"
112
+ }
113
+ }
114
+ }
115
+ }
116
+ }
117
+ },
118
+ "/messages": {
119
+ "get": {
120
+ "responses": {
121
+ "200": {
122
+ "description": "OK",
123
+ "headers": {},
124
+ "content": {
125
+ "application/json": {
126
+ "schema": {
127
+ "type": "array",
128
+ "items": {
129
+ "$ref": "#/components/schemas/Message"
130
+ }
131
+ },
132
+ "example": [
133
+ {
134
+ "message": ""
135
+ }
136
+ ]
137
+ }
138
+ }
139
+ }
140
+ },
141
+ "summary": "Some resource",
142
+ "operationId": "Some resource",
143
+ "description": "",
144
+ "tags": [],
145
+ "parameters": []
146
+ }
147
+ }
148
+ },
149
+ "components": {
150
+ "schemas": {
151
+ "Message": {
152
+ "type": "object",
153
+ "properties": {
154
+ "message": {
155
+ "type": "string"
156
+ }
157
+ }
158
+ },
159
+ "OtherMessage": {
160
+ "type": "object",
161
+ "properties": {
162
+ "otherMessage": {
163
+ "type": "string"
164
+ },
165
+ "someNum": {
166
+ "type": "number"
167
+ }
168
+ }
169
+ }
170
+ }
171
+ },
172
+ "tags": []
173
+ }
package/test/output/OpenAPI3_headers.json ADDED
@@ -0,0 +1,169 @@
1
+ {
2
+ "openapi": "3.0.3",
3
+ "info": {
4
+ "title": "",
5
+ "version": "1.0.0",
6
+ "description": ""
7
+ },
8
+ "servers": [
9
+ {
10
+ "url": "https://www.testhost.com"
11
+ }
12
+ ],
13
+ "paths": {
14
+ "/some/resource": {
15
+ "post": {
16
+ "responses": {
17
+ "200": {
18
+ "description": "OK",
19
+ "headers": {},
20
+ "content": {}
21
+ }
22
+ },
23
+ "summary": "Some resource",
24
+ "operationId": "Some resource",
25
+ "description": "",
26
+ "tags": [],
27
+ "parameters": [
28
+ {
29
+ "name": "x-testhost-auth-sign",
30
+ "in": "header",
31
+ "description": "e.g. signed body",
32
+ "required": false,
33
+ "example": "signed body",
34
+ "schema": {
35
+ "type": "string"
36
+ }
37
+ },
38
+ {
39
+ "name": "Authorization",
40
+ "in": "header",
41
+ "description": "e.g. Bearer Admin",
42
+ "required": false,
43
+ "example": "Bearer Admin",
44
+ "schema": {
45
+ "type": "string"
46
+ }
47
+ },
48
+ {
49
+ "name": "Authorization",
50
+ "in": "header",
51
+ "description": "e.g. Bearer User",
52
+ "required": false,
53
+ "example": "Bearer User",
54
+ "schema": {
55
+ "type": "string"
56
+ }
57
+ }
58
+ ],
59
+ "requestBody": {
60
+ "content": {
61
+ "application/json": {
62
+ "schema": {
63
+ "type": "object",
64
+ "properties": {
65
+ "someType": {
66
+ "type": "string"
67
+ }
68
+ }
69
+ }
70
+ }
71
+ }
72
+ }
73
+ }
74
+ },
75
+ "/some/restricted/resource": {
76
+ "get": {
77
+ "responses": {
78
+ "200": {
79
+ "description": "OK",
80
+ "headers": {},
81
+ "content": {}
82
+ }
83
+ },
84
+ "summary": "Restricted resource",
85
+ "operationId": "Restricted resource",
86
+ "description": "Has a duplicate header within a single declaration",
87
+ "tags": [],
88
+ "parameters": [
89
+ {
90
+ "name": "Authorization",
91
+ "in": "header",
92
+ "description": "e.g. Bearer Admin",
93
+ "required": false,
94
+ "example": "Bearer Admin",
95
+ "schema": {
96
+ "type": "string"
97
+ }
98
+ }
99
+ ],
100
+ "requestBody": {
101
+ "content": {
102
+ "application/json": {
103
+ "schema": {
104
+ "type": "object",
105
+ "properties": {
106
+ "message1": {
107
+ "type": "string",
108
+ "description": "This is the message description "
109
+ }
110
+ }
111
+ }
112
+ }
113
+ }
114
+ }
115
+ }
116
+ },
117
+ "/additional/resource": {
118
+ "get": {
119
+ "responses": {
120
+ "200": {
121
+ "description": "OK",
122
+ "headers": {},
123
+ "content": {}
124
+ }
125
+ },
126
+ "summary": "Additional resource",
127
+ "operationId": "Additional resource",
128
+ "description": "",
129
+ "tags": [],
130
+ "parameters": [
131
+ {
132
+ "name": "x-testhost-auth-sign",
133
+ "in": "header",
134
+ "description": "e.g. signed body",
135
+ "required": false,
136
+ "example": "signed body",
137
+ "schema": {
138
+ "type": "string"
139
+ }
140
+ },
141
+ {
142
+ "name": "Authorization",
143
+ "in": "header",
144
+ "description": "e.g. Bearer Admin",
145
+ "required": false,
146
+ "example": "Bearer Admin",
147
+ "schema": {
148
+ "type": "string"
149
+ }
150
+ },
151
+ {
152
+ "name": "Authorization",
153
+ "in": "header",
154
+ "description": "e.g. Bearer User",
155
+ "required": false,
156
+ "example": "Bearer User",
157
+ "schema": {
158
+ "type": "string"
159
+ }
160
+ }
161
+ ]
162
+ }
163
+ }
164
+ },
165
+ "components": {
166
+ "schemas": {}
167
+ },
168
+ "tags": []
169
+ }