@api-client/core 0.19.9 → 0.19.11

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 (523) hide show
  1. package/LICENSE.md +9 -63
  2. package/Testing.md +1 -1
  3. package/bin/test.ts +1 -12
  4. package/build/src/browser.d.ts +0 -15
  5. package/build/src/browser.d.ts.map +1 -1
  6. package/build/src/browser.js +0 -17
  7. package/build/src/browser.js.map +1 -1
  8. package/build/src/decorators/observed.d.ts.map +1 -1
  9. package/build/src/decorators/observed.js +91 -0
  10. package/build/src/decorators/observed.js.map +1 -1
  11. package/build/src/events/EventTypes.d.ts +0 -6
  12. package/build/src/events/EventTypes.d.ts.map +1 -1
  13. package/build/src/events/EventTypes.js +0 -2
  14. package/build/src/events/EventTypes.js.map +1 -1
  15. package/build/src/events/Events.d.ts +0 -2
  16. package/build/src/events/Events.d.ts.map +1 -1
  17. package/build/src/events/Events.js +0 -2
  18. package/build/src/events/Events.js.map +1 -1
  19. package/build/src/index.d.ts +0 -15
  20. package/build/src/index.d.ts.map +1 -1
  21. package/build/src/index.js +0 -17
  22. package/build/src/index.js.map +1 -1
  23. package/build/src/modeling/ApiModel.d.ts +21 -7
  24. package/build/src/modeling/ApiModel.d.ts.map +1 -1
  25. package/build/src/modeling/ApiModel.js +70 -29
  26. package/build/src/modeling/ApiModel.js.map +1 -1
  27. package/build/src/modeling/Bindings.d.ts +3 -3
  28. package/build/src/modeling/Bindings.d.ts.map +1 -1
  29. package/build/src/modeling/Bindings.js.map +1 -1
  30. package/build/src/modeling/DomainAssociation.d.ts +5 -5
  31. package/build/src/modeling/DomainAssociation.d.ts.map +1 -1
  32. package/build/src/modeling/DomainAssociation.js.map +1 -1
  33. package/build/src/modeling/DomainEntity.d.ts +2 -3
  34. package/build/src/modeling/DomainEntity.d.ts.map +1 -1
  35. package/build/src/modeling/DomainEntity.js +1 -1
  36. package/build/src/modeling/DomainEntity.js.map +1 -1
  37. package/build/src/modeling/DomainProperty.d.ts +2 -3
  38. package/build/src/modeling/DomainProperty.d.ts.map +1 -1
  39. package/build/src/modeling/DomainProperty.js +1 -1
  40. package/build/src/modeling/DomainProperty.js.map +1 -1
  41. package/build/src/modeling/DomainValidation.d.ts +1 -1
  42. package/build/src/modeling/DomainValidation.d.ts.map +1 -1
  43. package/build/src/modeling/DomainValidation.js.map +1 -1
  44. package/build/src/modeling/ExposedEntity.d.ts +14 -0
  45. package/build/src/modeling/ExposedEntity.d.ts.map +1 -1
  46. package/build/src/modeling/ExposedEntity.js +59 -6
  47. package/build/src/modeling/ExposedEntity.js.map +1 -1
  48. package/build/src/modeling/actions/Action.d.ts +11 -1
  49. package/build/src/modeling/actions/Action.d.ts.map +1 -1
  50. package/build/src/modeling/actions/Action.js +21 -3
  51. package/build/src/modeling/actions/Action.js.map +1 -1
  52. package/build/src/modeling/actions/CreateAction.d.ts +2 -1
  53. package/build/src/modeling/actions/CreateAction.d.ts.map +1 -1
  54. package/build/src/modeling/actions/CreateAction.js +2 -2
  55. package/build/src/modeling/actions/CreateAction.js.map +1 -1
  56. package/build/src/modeling/actions/DeleteAction.d.ts +2 -1
  57. package/build/src/modeling/actions/DeleteAction.d.ts.map +1 -1
  58. package/build/src/modeling/actions/DeleteAction.js +2 -2
  59. package/build/src/modeling/actions/DeleteAction.js.map +1 -1
  60. package/build/src/modeling/actions/ListAction.d.ts +2 -1
  61. package/build/src/modeling/actions/ListAction.d.ts.map +1 -1
  62. package/build/src/modeling/actions/ListAction.js +2 -2
  63. package/build/src/modeling/actions/ListAction.js.map +1 -1
  64. package/build/src/modeling/actions/ReadAction.d.ts +2 -1
  65. package/build/src/modeling/actions/ReadAction.d.ts.map +1 -1
  66. package/build/src/modeling/actions/ReadAction.js +2 -2
  67. package/build/src/modeling/actions/ReadAction.js.map +1 -1
  68. package/build/src/modeling/actions/SearchAction.d.ts +2 -1
  69. package/build/src/modeling/actions/SearchAction.d.ts.map +1 -1
  70. package/build/src/modeling/actions/SearchAction.js +2 -2
  71. package/build/src/modeling/actions/SearchAction.js.map +1 -1
  72. package/build/src/modeling/actions/UpdateAction.d.ts +2 -1
  73. package/build/src/modeling/actions/UpdateAction.d.ts.map +1 -1
  74. package/build/src/modeling/actions/UpdateAction.js +2 -2
  75. package/build/src/modeling/actions/UpdateAction.js.map +1 -1
  76. package/build/src/modeling/actions/index.d.ts +2 -1
  77. package/build/src/modeling/actions/index.d.ts.map +1 -1
  78. package/build/src/modeling/actions/index.js +7 -7
  79. package/build/src/modeling/actions/index.js.map +1 -1
  80. package/build/src/modeling/ai/types.d.ts +2 -2
  81. package/build/src/modeling/ai/types.d.ts.map +1 -1
  82. package/build/src/modeling/ai/types.js.map +1 -1
  83. package/build/src/{amf → modeling/amf}/DataValueGenerator.d.ts +1 -1
  84. package/build/src/modeling/amf/DataValueGenerator.d.ts.map +1 -0
  85. package/build/src/{amf → modeling/amf}/DataValueGenerator.js +2 -3
  86. package/build/src/modeling/amf/DataValueGenerator.js.map +1 -0
  87. package/build/src/modeling/amf/ShapeGenerator.d.ts +20 -20
  88. package/build/src/modeling/amf/ShapeGenerator.d.ts.map +1 -1
  89. package/build/src/modeling/amf/ShapeGenerator.js +16 -18
  90. package/build/src/modeling/amf/ShapeGenerator.js.map +1 -1
  91. package/build/src/modeling/amf/core_types.d.ts +9 -0
  92. package/build/src/modeling/amf/core_types.d.ts.map +1 -0
  93. package/build/src/modeling/amf/core_types.js +45 -0
  94. package/build/src/modeling/amf/core_types.js.map +1 -0
  95. package/build/src/modeling/index.d.ts +1 -0
  96. package/build/src/modeling/index.d.ts.map +1 -1
  97. package/build/src/modeling/index.js +1 -0
  98. package/build/src/modeling/index.js.map +1 -1
  99. package/build/src/modeling/types.d.ts +67 -0
  100. package/build/src/modeling/types.d.ts.map +1 -1
  101. package/build/src/modeling/types.js.map +1 -1
  102. package/build/src/modeling/validation/api_model_rules.d.ts +15 -0
  103. package/build/src/modeling/validation/api_model_rules.d.ts.map +1 -0
  104. package/build/src/modeling/validation/api_model_rules.js +599 -0
  105. package/build/src/modeling/validation/api_model_rules.js.map +1 -0
  106. package/build/src/modeling/validation/association_validation.d.ts.map +1 -1
  107. package/build/src/modeling/validation/association_validation.js +1 -3
  108. package/build/src/modeling/validation/association_validation.js.map +1 -1
  109. package/build/src/models/http-flows/LegacyTranslator.js +1 -1
  110. package/build/src/models/http-flows/LegacyTranslator.js.map +1 -1
  111. package/build/src/runtime/http-runner/HttpFlows.js +1 -1
  112. package/build/src/runtime/http-runner/HttpFlows.js.map +1 -1
  113. package/build/tsconfig.tsbuildinfo +1 -1
  114. package/eslint.config.js +0 -2
  115. package/package.json +27 -135
  116. package/src/decorators/observed.ts +91 -0
  117. package/src/events/EventTypes.ts +0 -2
  118. package/src/events/Events.ts +0 -2
  119. package/src/modeling/ApiModel.ts +73 -33
  120. package/src/modeling/Bindings.ts +3 -3
  121. package/src/modeling/DomainAssociation.ts +5 -5
  122. package/src/modeling/DomainEntity.ts +3 -4
  123. package/src/modeling/DomainProperty.ts +3 -4
  124. package/src/modeling/DomainValidation.ts +1 -1
  125. package/src/modeling/ExposedEntity.ts +63 -9
  126. package/src/modeling/actions/Action.ts +25 -2
  127. package/src/modeling/actions/CreateAction.ts +3 -2
  128. package/src/modeling/actions/DeleteAction.ts +3 -2
  129. package/src/modeling/actions/ListAction.ts +3 -2
  130. package/src/modeling/actions/ReadAction.ts +3 -2
  131. package/src/modeling/actions/SearchAction.ts +3 -2
  132. package/src/modeling/actions/UpdateAction.ts +3 -2
  133. package/src/modeling/ai/types.ts +2 -2
  134. package/src/{amf → modeling/amf}/DataValueGenerator.ts +3 -4
  135. package/src/modeling/amf/ShapeGenerator.ts +45 -61
  136. package/src/modeling/amf/core_types.ts +47 -0
  137. package/src/modeling/types.ts +70 -0
  138. package/src/modeling/validation/api_model_rules.ts +640 -0
  139. package/src/modeling/validation/api_model_validation_rules.md +58 -0
  140. package/src/modeling/validation/association_validation.ts +1 -3
  141. package/src/models/http-flows/LegacyTranslator.ts +1 -1
  142. package/src/runtime/http-runner/HttpFlows.ts +1 -1
  143. package/tests/unit/modeling/actions/Action.spec.ts +40 -8
  144. package/tests/unit/modeling/actions/CreateAction.spec.ts +5 -5
  145. package/tests/unit/modeling/actions/DeleteAction.spec.ts +6 -6
  146. package/tests/unit/modeling/actions/ListAction.spec.ts +7 -7
  147. package/tests/unit/modeling/actions/ReadAction.spec.ts +6 -6
  148. package/tests/unit/modeling/actions/SearchAction.spec.ts +6 -6
  149. package/tests/unit/modeling/actions/UpdateAction.spec.ts +6 -6
  150. package/tests/unit/{amf → modeling/amf}/data_value_generator.spec.ts +2 -2
  151. package/tests/unit/modeling/amf/shape_generator.spec.ts +146 -167
  152. package/tests/unit/modeling/api_model.spec.ts +190 -13
  153. package/tests/unit/modeling/api_model_expose_entity.spec.ts +43 -19
  154. package/tests/unit/modeling/api_model_remove_entity.spec.ts +6 -6
  155. package/tests/unit/modeling/domain_asociation.spec.ts +13 -13
  156. package/tests/unit/modeling/exposed_entity.spec.ts +123 -3
  157. package/tests/unit/modeling/exposed_entity_actions.spec.ts +41 -18
  158. package/tests/unit/modeling/exposed_entity_setter_validation.spec.ts +1 -1
  159. package/tests/unit/modeling/rules/restoring_rules.spec.ts +9 -5
  160. package/tests/unit/modeling/validation/api_model_rules.spec.ts +324 -0
  161. package/tests/unit/runtime/runners/http_assertion_runner.spec.ts +1 -1
  162. package/tests/unit/runtime/runners/http_flow_runner.spec.ts +1 -1
  163. package/tests/unit/runtime/runners/project_runner.spec.ts +1 -1
  164. package/tests/unit/runtime/runners/request_runner.spec.ts +1 -1
  165. package/tests/unit/runtime/runners/serial_runner.spec.ts +1 -1
  166. package/tsconfig.browser.json +1 -1
  167. package/tsconfig.node.json +1 -1
  168. package/bin/test-web.ts +0 -6
  169. package/build/src/amf/AmfMixin.d.ts +0 -396
  170. package/build/src/amf/AmfMixin.d.ts.map +0 -1
  171. package/build/src/amf/AmfMixin.js +0 -1138
  172. package/build/src/amf/AmfMixin.js.map +0 -1
  173. package/build/src/amf/AmfSerializer.d.ts +0 -137
  174. package/build/src/amf/AmfSerializer.d.ts.map +0 -1
  175. package/build/src/amf/AmfSerializer.js +0 -1947
  176. package/build/src/amf/AmfSerializer.js.map +0 -1
  177. package/build/src/amf/AmfTypes.d.ts +0 -25
  178. package/build/src/amf/AmfTypes.d.ts.map +0 -1
  179. package/build/src/amf/AmfTypes.js +0 -143
  180. package/build/src/amf/AmfTypes.js.map +0 -1
  181. package/build/src/amf/ApiExampleGenerator.d.ts +0 -40
  182. package/build/src/amf/ApiExampleGenerator.d.ts.map +0 -1
  183. package/build/src/amf/ApiExampleGenerator.js +0 -112
  184. package/build/src/amf/ApiExampleGenerator.js.map +0 -1
  185. package/build/src/amf/ApiMonacoSchemaGenerator.d.ts +0 -68
  186. package/build/src/amf/ApiMonacoSchemaGenerator.d.ts.map +0 -1
  187. package/build/src/amf/ApiMonacoSchemaGenerator.js +0 -248
  188. package/build/src/amf/ApiMonacoSchemaGenerator.js.map +0 -1
  189. package/build/src/amf/ApiSchemaGenerator.d.ts +0 -56
  190. package/build/src/amf/ApiSchemaGenerator.d.ts.map +0 -1
  191. package/build/src/amf/ApiSchemaGenerator.js +0 -94
  192. package/build/src/amf/ApiSchemaGenerator.js.map +0 -1
  193. package/build/src/amf/ApiSchemaValues.d.ts +0 -111
  194. package/build/src/amf/ApiSchemaValues.d.ts.map +0 -1
  195. package/build/src/amf/ApiSchemaValues.js +0 -463
  196. package/build/src/amf/ApiSchemaValues.js.map +0 -1
  197. package/build/src/amf/DataValueGenerator.d.ts.map +0 -1
  198. package/build/src/amf/DataValueGenerator.js.map +0 -1
  199. package/build/src/amf/Parsing.d.ts +0 -48
  200. package/build/src/amf/Parsing.d.ts.map +0 -1
  201. package/build/src/amf/Parsing.js +0 -2
  202. package/build/src/amf/Parsing.js.map +0 -1
  203. package/build/src/amf/Utils.d.ts +0 -37
  204. package/build/src/amf/Utils.d.ts.map +0 -1
  205. package/build/src/amf/Utils.js +0 -169
  206. package/build/src/amf/Utils.js.map +0 -1
  207. package/build/src/amf/data-node/DataNodeBase.d.ts +0 -34
  208. package/build/src/amf/data-node/DataNodeBase.d.ts.map +0 -1
  209. package/build/src/amf/data-node/DataNodeBase.js +0 -77
  210. package/build/src/amf/data-node/DataNodeBase.js.map +0 -1
  211. package/build/src/amf/data-node/JsonDataNodeGenerator.d.ts +0 -15
  212. package/build/src/amf/data-node/JsonDataNodeGenerator.d.ts.map +0 -1
  213. package/build/src/amf/data-node/JsonDataNodeGenerator.js +0 -23
  214. package/build/src/amf/data-node/JsonDataNodeGenerator.js.map +0 -1
  215. package/build/src/amf/data-node/UrlEncodedDataNodeGenerator.d.ts +0 -14
  216. package/build/src/amf/data-node/UrlEncodedDataNodeGenerator.d.ts.map +0 -1
  217. package/build/src/amf/data-node/UrlEncodedDataNodeGenerator.js +0 -48
  218. package/build/src/amf/data-node/UrlEncodedDataNodeGenerator.js.map +0 -1
  219. package/build/src/amf/data-node/XmlDataNodeGenerator.d.ts +0 -22
  220. package/build/src/amf/data-node/XmlDataNodeGenerator.d.ts.map +0 -1
  221. package/build/src/amf/data-node/XmlDataNodeGenerator.js +0 -34
  222. package/build/src/amf/data-node/XmlDataNodeGenerator.js.map +0 -1
  223. package/build/src/amf/definitions/Amf.d.ts +0 -363
  224. package/build/src/amf/definitions/Amf.d.ts.map +0 -1
  225. package/build/src/amf/definitions/Amf.js +0 -3
  226. package/build/src/amf/definitions/Amf.js.map +0 -1
  227. package/build/src/amf/definitions/Api.d.ts +0 -383
  228. package/build/src/amf/definitions/Api.d.ts.map +0 -1
  229. package/build/src/amf/definitions/Api.js +0 -2
  230. package/build/src/amf/definitions/Api.js.map +0 -1
  231. package/build/src/amf/definitions/Base.d.ts +0 -12
  232. package/build/src/amf/definitions/Base.d.ts.map +0 -1
  233. package/build/src/amf/definitions/Base.js +0 -2
  234. package/build/src/amf/definitions/Base.js.map +0 -1
  235. package/build/src/amf/definitions/Namespace.d.ts +0 -327
  236. package/build/src/amf/definitions/Namespace.d.ts.map +0 -1
  237. package/build/src/amf/definitions/Namespace.js +0 -346
  238. package/build/src/amf/definitions/Namespace.js.map +0 -1
  239. package/build/src/amf/definitions/Shapes.d.ts +0 -312
  240. package/build/src/amf/definitions/Shapes.d.ts.map +0 -1
  241. package/build/src/amf/definitions/Shapes.js +0 -87
  242. package/build/src/amf/definitions/Shapes.js.map +0 -1
  243. package/build/src/amf/models/AmfDataNode.d.ts +0 -67
  244. package/build/src/amf/models/AmfDataNode.d.ts.map +0 -1
  245. package/build/src/amf/models/AmfDataNode.js +0 -192
  246. package/build/src/amf/models/AmfDataNode.js.map +0 -1
  247. package/build/src/amf/shape/ShapeBase.d.ts +0 -74
  248. package/build/src/amf/shape/ShapeBase.d.ts.map +0 -1
  249. package/build/src/amf/shape/ShapeBase.js +0 -93
  250. package/build/src/amf/shape/ShapeBase.js.map +0 -1
  251. package/build/src/amf/shape/ShapeJsonSchemaGenerator.d.ts +0 -47
  252. package/build/src/amf/shape/ShapeJsonSchemaGenerator.d.ts.map +0 -1
  253. package/build/src/amf/shape/ShapeJsonSchemaGenerator.js +0 -420
  254. package/build/src/amf/shape/ShapeJsonSchemaGenerator.js.map +0 -1
  255. package/build/src/amf/shape/ShapeXmlSchemaGenerator.d.ts +0 -85
  256. package/build/src/amf/shape/ShapeXmlSchemaGenerator.d.ts.map +0 -1
  257. package/build/src/amf/shape/ShapeXmlSchemaGenerator.js +0 -852
  258. package/build/src/amf/shape/ShapeXmlSchemaGenerator.js.map +0 -1
  259. package/build/src/events/amf/AmfEventTypes.d.ts +0 -7
  260. package/build/src/events/amf/AmfEventTypes.d.ts.map +0 -1
  261. package/build/src/events/amf/AmfEventTypes.js +0 -7
  262. package/build/src/events/amf/AmfEventTypes.js.map +0 -1
  263. package/build/src/events/amf/AmfEvents.d.ts +0 -34
  264. package/build/src/events/amf/AmfEvents.d.ts.map +0 -1
  265. package/build/src/events/amf/AmfEvents.js +0 -63
  266. package/build/src/events/amf/AmfEvents.js.map +0 -1
  267. package/build/src/mocking/RandExp.d.ts +0 -55
  268. package/build/src/mocking/RandExp.d.ts.map +0 -1
  269. package/build/src/mocking/RandExp.js +0 -302
  270. package/build/src/mocking/RandExp.js.map +0 -1
  271. package/build/src/mocking/lib/ret.d.ts +0 -16
  272. package/build/src/mocking/lib/ret.d.ts.map +0 -1
  273. package/build/src/mocking/lib/ret.js +0 -284
  274. package/build/src/mocking/lib/ret.js.map +0 -1
  275. package/data/apis/APIC-187/APIC-187.raml +0 -21
  276. package/data/apis/APIC-187/dataType.raml +0 -132
  277. package/data/apis/APIC-187/example.raml +0 -84
  278. package/data/apis/APIC-188/APIC-188.raml +0 -21
  279. package/data/apis/APIC-188/dataType.raml +0 -132
  280. package/data/apis/APIC-188/example.raml +0 -84
  281. package/data/apis/APIC-233/APIC-233.raml +0 -15
  282. package/data/apis/APIC-391/APIC-391.raml +0 -44
  283. package/data/apis/APIC-391/examples/post-body-request-example.raml +0 -7
  284. package/data/apis/APIC-483/APIC-483.raml +0 -16
  285. package/data/apis/APIC-483/example/list-of-bank-succ.json +0 -32
  286. package/data/apis/APIC-483/schema/response-retrieve-list-bank.json +0 -68
  287. package/data/apis/APIC-487/APIC-487.raml +0 -36
  288. package/data/apis/APIC-655/APIC-655.raml +0 -44
  289. package/data/apis/APIC-655/delivery.json +0 -12
  290. package/data/apis/APIC-689/APIC-689.raml +0 -20
  291. package/data/apis/APIC-690/APIC-690.raml +0 -17
  292. package/data/apis/APIC-690/datatypes/Address.raml +0 -10
  293. package/data/apis/APIC-690/datatypes/Customer.raml +0 -17
  294. package/data/apis/APIC-690/examples/CustomerExample2.raml +0 -17
  295. package/data/apis/APIC-690/examples/CustomersExample.raml +0 -34
  296. package/data/apis/SE-10469/Purchase-Order-oagis-id-dd32f9c6c01048a19e15c423c9c741ae.json +0 -1383
  297. package/data/apis/SE-10469/SE-10469.raml +0 -11
  298. package/data/apis/SE-13092/Examples/PersonExample.raml +0 -7
  299. package/data/apis/SE-13092/SE-13092.raml +0 -37
  300. package/data/apis/SE-13092/datatypes/Address.raml +0 -5
  301. package/data/apis/SE-13092/datatypes/InlineType.raml +0 -5
  302. package/data/apis/SE-13092/datatypes/Person.raml +0 -15
  303. package/data/apis/SE-22063/SE-22063.raml +0 -14
  304. package/data/apis/SE-22063/stock.raml +0 -41
  305. package/data/apis/amf-helper-api/amf-helper-api.raml +0 -1024
  306. package/data/apis/amf-helper-api/examples/comment-example.json +0 -42
  307. package/data/apis/amf-helper-api/examples/commentCreateRequest-example.json +0 -7
  308. package/data/apis/amf-helper-api/examples/commentList-example.json +0 -48
  309. package/data/apis/amf-helper-api/examples/person.json +0 -14
  310. package/data/apis/amf-helper-api/examples/person.raml +0 -13
  311. package/data/apis/amf-helper-api/examples/person.xml +0 -14
  312. package/data/apis/amf-helper-api/libraries/comment-lib.raml +0 -143
  313. package/data/apis/amf-helper-api/library.raml +0 -7
  314. package/data/apis/amf-helper-api/schemas/person.json +0 -104
  315. package/data/apis/amf-helper-api/schemas/person.xsd +0 -26
  316. package/data/apis/amf-helper-api/traits/file.raml +0 -33
  317. package/data/apis/amf-helper-api/traits/pagination.raml +0 -80
  318. package/data/apis/amf-helper-api/traits/results.raml +0 -19
  319. package/data/apis/amf-helper-api/traits/visibility.raml +0 -14
  320. package/data/apis/amf-helper-api/types/app-person.raml +0 -101
  321. package/data/apis/amf-helper-api/types/dimensions.raml +0 -24
  322. package/data/apis/amf-helper-api/types/external-type.raml +0 -7
  323. package/data/apis/amf-helper-api/types/image.raml +0 -23
  324. package/data/apis/amf-helper-api/types/product.raml +0 -52
  325. package/data/apis/amf-helper-api/types/resource.raml +0 -11
  326. package/data/apis/amf-helper-api/types/standard-request.raml +0 -50
  327. package/data/apis/amf-helper-api/types/user.raml +0 -37
  328. package/data/apis/arc-demo-api/arc-demo-api.raml +0 -468
  329. package/data/apis/arc-demo-api/examples/e400.xml +0 -4
  330. package/data/apis/arc-demo-api/examples/e401.xml +0 -4
  331. package/data/apis/arc-demo-api/examples/e404.xml +0 -4
  332. package/data/apis/arc-demo-api/examples/image.xml +0 -5
  333. package/data/apis/arc-demo-api/examples/messages-example.json +0 -22
  334. package/data/apis/arc-demo-api/examples/messages-sent-example.json +0 -15
  335. package/data/apis/arc-demo-api/examples/person.json +0 -14
  336. package/data/apis/arc-demo-api/examples/person.url.encoded +0 -1
  337. package/data/apis/arc-demo-api/examples/person.xml +0 -14
  338. package/data/apis/arc-demo-api/examples/product.xml +0 -9
  339. package/data/apis/arc-demo-api/library.raml +0 -36
  340. package/data/apis/arc-demo-api/resourceTypes/app-person.raml +0 -49
  341. package/data/apis/arc-demo-api/resourceTypes/example-types.raml +0 -45
  342. package/data/apis/arc-demo-api/resourceTypes/image.raml +0 -23
  343. package/data/apis/arc-demo-api/resourceTypes/message-sent-type.raml +0 -23
  344. package/data/apis/arc-demo-api/resourceTypes/message-type.raml +0 -33
  345. package/data/apis/arc-demo-api/resourceTypes/product.raml +0 -52
  346. package/data/apis/arc-demo-api/resourceTypes/resource.raml +0 -11
  347. package/data/apis/arc-demo-api/schemas/error-response.xsd +0 -11
  348. package/data/apis/arc-demo-api/schemas/image.xsd +0 -11
  349. package/data/apis/arc-demo-api/schemas/person.json +0 -104
  350. package/data/apis/arc-demo-api/schemas/person.xsd +0 -26
  351. package/data/apis/arc-demo-api/schemas/product.xsd +0 -17
  352. package/data/apis/arc-demo-api/securitySchemes/basic.raml +0 -5
  353. package/data/apis/arc-demo-api/securitySchemes/oauth_2_0.raml +0 -29
  354. package/data/apis/arc-demo-api/securitySchemes/x-custom.raml +0 -26
  355. package/data/apis/arc-demo-api/traits/adminable.raml +0 -23
  356. package/data/apis/arc-demo-api/traits/pagination.raml +0 -83
  357. package/data/apis/arc-demo-api/traits/rate-limited.raml +0 -9
  358. package/data/apis/async-api/async-api.yaml +0 -96
  359. package/data/apis/example-generator-api/contact-email-example.raml +0 -6
  360. package/data/apis/example-generator-api/contact-example.raml +0 -5
  361. package/data/apis/example-generator-api/contact-fax-example.raml +0 -5
  362. package/data/apis/example-generator-api/contact-website-example.raml +0 -2
  363. package/data/apis/example-generator-api/example-1.raml +0 -6
  364. package/data/apis/example-generator-api/example-2.raml +0 -9
  365. package/data/apis/example-generator-api/example-3.raml +0 -4
  366. package/data/apis/example-generator-api/example-4.raml +0 -2
  367. package/data/apis/example-generator-api/example-5.raml +0 -4
  368. package/data/apis/example-generator-api/example-6.raml +0 -2
  369. package/data/apis/example-generator-api/example-7.raml +0 -5
  370. package/data/apis/example-generator-api/example-generator-api.raml +0 -423
  371. package/data/apis/example-generator-api/example.json +0 -14
  372. package/data/apis/example-generator-api/example.xml +0 -15
  373. package/data/apis/example-generator-api/example.xsd +0 -26
  374. package/data/apis/example-generator-api/examples/employee.raml +0 -7
  375. package/data/apis/example-generator-api/examples/employees.raml +0 -7
  376. package/data/apis/example-generator-api/linked-named-example.raml +0 -21
  377. package/data/apis/example-generator-api/named-example-with-link.raml +0 -5
  378. package/data/apis/example-generator-api/named-example.raml +0 -9
  379. package/data/apis/example-generator-api/user-json-example.raml +0 -17
  380. package/data/apis/example-generator-api/user-raml-example.raml +0 -37
  381. package/data/apis/example-generator-api/user.json +0 -8
  382. package/data/apis/example-generator-api/user.raml +0 -18
  383. package/data/apis/example-generator-api/users-json-example.raml +0 -17
  384. package/data/apis/example-generator-api/users-raml-example.raml +0 -32
  385. package/data/apis/example-generator-api/users.json +0 -8
  386. package/data/apis/expanded-api/expanded-api.raml +0 -8
  387. package/data/apis/flattened-api/flattened-api.raml +0 -8
  388. package/data/apis/multiple-servers/multiple-servers.yaml +0 -112
  389. package/data/apis/oas-3-api/oas-3-api.yaml +0 -356
  390. package/data/apis/oas-date/oas-date.yaml +0 -28
  391. package/data/apis/oas-types/oas-types.yaml +0 -159
  392. package/data/apis/oas-unions/oas-unions.yaml +0 -75
  393. package/data/apis/petstore/petstore.yaml +0 -954
  394. package/data/apis/raml-date/raml-date.raml +0 -28
  395. package/data/apis/recursive/recursive.raml +0 -14
  396. package/data/apis/schema-api/examples/person.json +0 -14
  397. package/data/apis/schema-api/examples/person.raml +0 -14
  398. package/data/apis/schema-api/examples/person.url.encoded +0 -1
  399. package/data/apis/schema-api/examples/person.xml +0 -14
  400. package/data/apis/schema-api/library/demo-types.raml +0 -43
  401. package/data/apis/schema-api/schema-api.raml +0 -656
  402. package/data/apis/schema-api/schemas/person.json +0 -104
  403. package/data/apis/schema-api/schemas/person.xsd +0 -26
  404. package/data/apis/schema-api/types/DemoPerson.raml +0 -67
  405. package/data/apis/secured-api/oauth-2-custom-settings.raml +0 -143
  406. package/data/apis/secured-api/oauth2-header-delivery.raml +0 -13
  407. package/data/apis/secured-api/oauth2-no-delivery.raml +0 -8
  408. package/data/apis/secured-api/oauth2-no-grants.raml +0 -12
  409. package/data/apis/secured-api/oauth2-pkce.raml +0 -13
  410. package/data/apis/secured-api/oauth2-query-delivery.raml +0 -13
  411. package/data/apis/secured-api/oauth_1_0.raml +0 -8
  412. package/data/apis/secured-api/oauth_1_0_no-settings.raml +0 -3
  413. package/data/apis/secured-api/oauth_1_0_no-signature.raml +0 -7
  414. package/data/apis/secured-api/oauth_1_0_signature.raml +0 -8
  415. package/data/apis/secured-api/passthrough-querystring.raml +0 -16
  416. package/data/apis/secured-api/passthrough.raml +0 -24
  417. package/data/apis/secured-api/secured-api.raml +0 -231
  418. package/data/apis/secured-api/x-custom.raml +0 -33
  419. package/data/apis/secured-api/x-other.raml +0 -29
  420. package/data/apis/secured-api/x-query-string.raml +0 -16
  421. package/data/apis/tracked-examples/datatypes/employee.raml +0 -5
  422. package/data/apis/tracked-examples/examples/employee.raml +0 -4
  423. package/data/apis/tracked-examples/examples/employees.raml +0 -8
  424. package/data/apis/tracked-examples/tracked-to-linked.raml +0 -28
  425. package/data/model.js +0 -129
  426. package/data/models/APIC-187.json +0 -11416
  427. package/data/models/APIC-188.json +0 -11416
  428. package/data/models/APIC-233.json +0 -539
  429. package/data/models/APIC-391.json +0 -1903
  430. package/data/models/APIC-483.json +0 -3110
  431. package/data/models/APIC-487.json +0 -1225
  432. package/data/models/APIC-655.json +0 -3145
  433. package/data/models/APIC-689.json +0 -797
  434. package/data/models/APIC-690.json +0 -5992
  435. package/data/models/SE-10469.json +0 -22898
  436. package/data/models/SE-13092.json +0 -2769
  437. package/data/models/SE-22063.json +0 -2314
  438. package/data/models/amf-helper-api.json +0 -84457
  439. package/data/models/arc-demo-api.json +0 -52041
  440. package/data/models/async-api.json +0 -3227
  441. package/data/models/example-generator-api.json +0 -45209
  442. package/data/models/expanded-api.json +0 -251
  443. package/data/models/flattened-api.json +0 -251
  444. package/data/models/multiple-servers.json +0 -2769
  445. package/data/models/oas-3-api.json +0 -10590
  446. package/data/models/oas-date.json +0 -637
  447. package/data/models/oas-types.json +0 -5352
  448. package/data/models/oas-unions.json +0 -1935
  449. package/data/models/petstore.json +0 -27712
  450. package/data/models/raml-date.json +0 -1114
  451. package/data/models/recursive.json +0 -610
  452. package/data/models/schema-api.json +0 -35527
  453. package/data/models/secured-api.json +0 -21071
  454. package/data/models/tracked-to-linked.json +0 -1914
  455. package/src/amf/AmfMixin.ts +0 -1726
  456. package/src/amf/AmfSerializer.ts +0 -2358
  457. package/src/amf/AmfTypes.ts +0 -147
  458. package/src/amf/ApiExampleGenerator.ts +0 -122
  459. package/src/amf/ApiMonacoSchemaGenerator.ts +0 -332
  460. package/src/amf/ApiSchemaGenerator.ts +0 -115
  461. package/src/amf/ApiSchemaValues.ts +0 -509
  462. package/src/amf/Parsing.ts +0 -50
  463. package/src/amf/Utils.ts +0 -172
  464. package/src/amf/data-node/DataNodeBase.ts +0 -83
  465. package/src/amf/data-node/JsonDataNodeGenerator.ts +0 -24
  466. package/src/amf/data-node/README.md +0 -3
  467. package/src/amf/data-node/UrlEncodedDataNodeGenerator.ts +0 -49
  468. package/src/amf/data-node/XmlDataNodeGenerator.ts +0 -46
  469. package/src/amf/definitions/Amf.ts +0 -440
  470. package/src/amf/definitions/Api.ts +0 -445
  471. package/src/amf/definitions/Base.ts +0 -13
  472. package/src/amf/definitions/Namespace.ts +0 -357
  473. package/src/amf/definitions/Shapes.ts +0 -438
  474. package/src/amf/models/AmfDataNode.ts +0 -210
  475. package/src/amf/shape/README.md +0 -4
  476. package/src/amf/shape/ShapeBase.ts +0 -174
  477. package/src/amf/shape/ShapeJsonSchemaGenerator.ts +0 -457
  478. package/src/amf/shape/ShapeXmlSchemaGenerator.ts +0 -933
  479. package/src/events/amf/AmfEventTypes.ts +0 -6
  480. package/src/events/amf/AmfEvents.ts +0 -78
  481. package/src/mocking/RandExp.ts +0 -335
  482. package/src/mocking/lib/ret.ts +0 -279
  483. package/tests/unit/amf/APIC-187.spec.ts +0 -41
  484. package/tests/unit/amf/APIC-188.spec.ts +0 -30
  485. package/tests/unit/amf/APIC-233.spec.ts +0 -32
  486. package/tests/unit/amf/APIC-391.spec.ts +0 -39
  487. package/tests/unit/amf/APIC-487.spec.ts +0 -44
  488. package/tests/unit/amf/APIC-655.spec.ts +0 -41
  489. package/tests/unit/amf/APIC-689.spec.ts +0 -28
  490. package/tests/unit/amf/APIC-690.spec.ts +0 -93
  491. package/tests/unit/amf/AmfLoader.ts +0 -538
  492. package/tests/unit/amf/AmfMixin.spec.ts +0 -1707
  493. package/tests/unit/amf/ApiExampleGenerator.spec.ts +0 -250
  494. package/tests/unit/amf/ApiMonacoSchemaGenerator.spec.ts +0 -183
  495. package/tests/unit/amf/ApiSchemaValues.spec.ts +0 -602
  496. package/tests/unit/amf/Namepsace.spec.ts +0 -494
  497. package/tests/unit/amf/SE-10469.spec.ts +0 -35
  498. package/tests/unit/amf/SE-13092.spec.ts +0 -64
  499. package/tests/unit/amf/SE-22063.spec.ts +0 -45
  500. package/tests/unit/amf/raml-examples.spec.ts +0 -43
  501. package/tests/unit/amf/schema_gen_array.spec.ts +0 -199
  502. package/tests/unit/amf/schema_gen_oas.spec.ts +0 -140
  503. package/tests/unit/amf/schema_gen_object.spec.ts +0 -279
  504. package/tests/unit/amf/schema_gen_scalar.spec.ts +0 -143
  505. package/tests/unit/amf/schema_gen_union.spec.ts +0 -401
  506. package/tests/unit/amf/schema_gen_unknown.spec.ts +0 -42
  507. package/tests/unit/amf/schema_gen_xml.spec.ts +0 -726
  508. package/tests/unit/amf/serializer/APIC-483.spec.ts +0 -36
  509. package/tests/unit/amf/serializer/Anotations.spec.ts +0 -50
  510. package/tests/unit/amf/serializer/Api.spec.ts +0 -210
  511. package/tests/unit/amf/serializer/Documentation.spec.ts +0 -52
  512. package/tests/unit/amf/serializer/Endpoints.spec.ts +0 -172
  513. package/tests/unit/amf/serializer/Operations.spec.ts +0 -330
  514. package/tests/unit/amf/serializer/Parameters.spec.ts +0 -149
  515. package/tests/unit/amf/serializer/PayloadExamples.spec.ts +0 -152
  516. package/tests/unit/amf/serializer/Security.spec.ts +0 -626
  517. package/tests/unit/amf/serializer/Server.spec.ts +0 -78
  518. package/tests/unit/amf/serializer/Shapes.spec.ts +0 -304
  519. package/tests/unit/amf/serializer/SourceMaps.spec.ts +0 -52
  520. package/tests/unit/amf/shapes/ShapeXmlSchemaGenerator.spec.ts +0 -28
  521. package/tests/unit/amf/tracked-to-linked.spec.ts +0 -90
  522. package/tests/unit/amf/xml-data-processing.spec.ts +0 -217
  523. package/tests/unit/events/amf.spec.ts +0 -151
@@ -1,22 +0,0 @@
1
- [
2
- {
3
- "from": {
4
- "uid": "a7917e3c-4abf-11e7-a919-92ebcb67fe33",
5
- "name": "Pawel Psztyc",
6
- "email": "bea3d5e8-4abf-11e7-a919-92ebcb67fe33-em-vbc@domain.com"
7
- },
8
- "message": "This is an example message. Hello.",
9
- "timestamp": 1496757380,
10
- "attachements": [
11
- "https://attc.domain.com/01332c24-4ac0-11e7-a919-92ebcb67fe33"
12
- ]
13
- }, {
14
- "from": {
15
- "uid": "15e64d90-4ac0-11e7-a919-92ebcb67fe33",
16
- "name": "John Doe",
17
- "email": "220ce9bc-4abf-11e7-a919-92ebcb67fe33-oa-vbc@domain.com"
18
- },
19
- "message": "Howdy?",
20
- "timestamp": 1496757498
21
- }
22
- ]
@@ -1,15 +0,0 @@
1
- [
2
- {
3
- "email": "bea3d5e8-4abf-11e7-a919-92ebcb67fe33-em-vbc@domain.com",
4
- "message": "This is an example message. Hello.",
5
- "timestamp": 1496757380,
6
- "attachements": [
7
- "https://attc.domain.com/01332c24-4ac0-11e7-a919-92ebcb67fe33"
8
- ]
9
- }, {
10
- "email": "220ce9bc-4abf-11e7-a919-92ebcb67fe33-oa-vbc@domain.com",
11
- "message": "Howdy?",
12
- "timestamp": 1496757498,
13
- "important": true
14
- }
15
- ]
@@ -1,14 +0,0 @@
1
- {
2
- "id": "R34fg663H9KW9MMSKISI",
3
- "name": "Pawel Psztyc",
4
- "birthday": "1983-10-20",
5
- "gender": "male",
6
- "url": "https://domain.com/profile/pawel.psztyc",
7
- "image": {
8
- "url": "https://domain.com/profile/pawel.psztyc/image",
9
- "thumb": "https://domain.com/profile/pawel.psztyc/image/thumb"
10
- },
11
- "tagline": "Some text about me.",
12
- "language": "en_GB",
13
- "etag": "W\\244m4n5kj3gbn2nj4k4n4"
14
- }
@@ -1 +0,0 @@
1
- id=R34fg663H9KW9MMSKISI&name=Pawel%20Psztyc&birthday=1983-10-20&gender=male&url=https%3A%2F%2Fdomain.com%2Fprofile%2Fpawel.psztyc&tagline=Some%20text%20about%20me.&language=en_GB&etag=W\244m4n5kj3gbn2nj4k4n4
@@ -1,14 +0,0 @@
1
- <?xml version="1.0" encoding="UTF-8"?>
2
- <resource error="false" type="AppPerson">
3
- <id>Qawer63J73HJ6khjswuqyq62382jG21s</id>
4
- <name>John Smith</name>
5
- <birthday>1990-10-12</birthday>
6
- <gender>male</gender>
7
- <url>https://www.domain.com/people/Qawer63J73HJ6khjswuqyq62382jG21s</url>
8
- <image>
9
- <url>https://www.domain.com/people/Qawer63J73HJ6khjswuqyq62382jG21s/image</url>
10
- <thumb>https://www.domain.com/people/Qawer63J73HJ6khjswuqyq62382jG21s/image/thumb</thumb>
11
- </image>
12
- <tagline>Hi, I'm John!</tagline>
13
- <language>en_US</language>
14
- </resource>
@@ -1,9 +0,0 @@
1
- <?xml version="1.0" encoding="UTF-8"?>
2
- <resource error="false" type="Product">
3
- <id>f2f7933a-a9ce-11e6-80f5-76304dec7eb7</id>
4
- <name>Acme product - mentol flavor, 500 ml.</name>
5
- <quantity>500</quantity>
6
- <unit>ml</unit>
7
- <upc>042100005264</upc>
8
- <available>true</available>
9
- </resource>
@@ -1,36 +0,0 @@
1
- #%RAML 1.0 Library
2
- usage: This is a Library raml
3
-
4
- types:
5
- TypeFromLibray:
6
- properties:
7
- age: number
8
- securitySchemes:
9
- oauthLib:
10
- type: OAuth 2.0
11
- describedBy:
12
- queryParameters:
13
- access_token:
14
- type: string
15
- description: Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.
16
- required: false
17
- headers:
18
- authorization:
19
- type: string
20
- example: ya.2453vfDb3cJHisdf.*&H
21
- description: Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
22
- required: false
23
- responses:
24
- 401:
25
- description: Bad or expired token. This can happen if the user or Dropbox revoked or expired an access token. To fix, re-authenticate the user.
26
- body:
27
- application/json:
28
- 403:
29
- description: Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.
30
- body:
31
- application/json:
32
- settings:
33
- accessTokenUri: http://api.domain.com/oauth2/token
34
- authorizationUri: http://api.domain.com/oauth2/auth
35
- authorizationGrants: ["authorization_code", "implicit"]
36
- scopes: ["profile", "email"]
@@ -1,49 +0,0 @@
1
- #%RAML 1.0 DataType
2
-
3
- displayName: A person resource
4
- description: |
5
- An object representing a person in the API.
6
- This object will be used in all methods returning a Person or list of people.
7
-
8
- type: !include resource.raml
9
- example:
10
- id: "R34fg663H9KW9MMSKISI"
11
- name: "Pawel Psztyc"
12
- birthday: "1983-10-20"
13
- gender: male
14
- url: "https://domain.com/profile/pawel.psztyc"
15
- image:
16
- url: https://domain.com/profile/pawel.psztyc/image
17
- thumb: https://domain.com/profile/pawel.psztyc/image/thumb
18
- tagline: Some text about me.
19
- language: en_GB
20
- etag: "W\\244m4n5kj3gbn2nj4k4n4"
21
- properties:
22
- id:
23
- description: A unique identifier for a person. It is a 32 bit string containing alphanumeric characters.
24
- name:
25
- required: true
26
- example: John Smith
27
- description: Person full name. The input will be rejected if this property is not set while creating new object.
28
- type: string
29
- pattern: "[0-9a-zA-Z ]+"
30
- birthday:
31
- type: string
32
- description: The person's date of birth, represented as YYYY-MM-DD.
33
- gender?:
34
- type: string
35
- description: |
36
- The person's gender. Possible values includes, but are not limited to, the following values:
37
- * "male" - Male gender.
38
- * "female" - Female gender.
39
- * "other" - Other.
40
- url:
41
- type: string
42
- description: The URL of this person's profile.
43
- image: !include image.raml
44
- tagline:
45
- type: string
46
- description: The brief description (tagline) of this person.
47
- language:
48
- type: string
49
- description: The user's preferred language for rendering.
@@ -1,45 +0,0 @@
1
- #%RAML 1.0 Library
2
-
3
- types:
4
- Org:
5
- description: Represents an organization unit.
6
- type: object
7
- properties:
8
- onCall: Alertable # inherits all properties from type `Alertable`
9
- Head: Manager # inherits all properties from type `Manager`
10
- Person:
11
- type: object
12
- properties:
13
- firstname: string
14
- lastname: string
15
- title?: string
16
- kind: string # may be used to differenciate between classes that extend from `Person`
17
- example:
18
- firstname: Pawel
19
- lastname: Psztyc
20
- title: Mr.
21
- kind: Manager
22
- Phone:
23
- type: string
24
- pattern: "^[0-9|-]+$" # defines pattern for the content of type `Phone`
25
- Manager:
26
- type: Person # inherits all properties from type `Person`
27
- properties:
28
- reports: Person[] # inherits all properties from type `Person`; array type where `[]` is a shortcut
29
- phone: Phone
30
- kind:
31
- type: string
32
- enum: [AcmeManager]
33
- Admin:
34
- type: Person # inherits all properties from type `Person`
35
- properties:
36
- kind:
37
- type: string
38
- enum: [AcmeAdmin]
39
- clearanceLevel:
40
- enum: [ low, high ]
41
- AlertableAdmin:
42
- type: Admin # inherits all properties from type `Admin`
43
- properties:
44
- phone: Phone # inherits all properties from type `Phone`; uses shortcut syntax
45
- Alertable: Manager | AlertableAdmin # union type; either a `Manager` or `AlertableAdmin`
@@ -1,23 +0,0 @@
1
- #%RAML 1.0 DataType
2
-
3
- description: |
4
- An image object representing an image object strored in the file store.
5
- The image can be only included in the response. It has no effect if the Image appear in the
6
- request. Endpoint handles image creation on it's own and clients can't process images
7
- except of sending image data.
8
-
9
- type: object
10
- properties:
11
- url:
12
- type: string
13
- description: |
14
- The URL of the image.
15
- To resize the image and crop it to a square, append the query string **?sz=x**, where x is the dimension in pixels of each side.
16
- thumb:
17
- type: string
18
- displayName: Thumbnail
19
- description: |
20
- An URL to the thumbnail of the image. Thumbnails are 60x60px cropped images of the original image.
21
- example:
22
- url: https://domain.com/profile/pawel.psztyc/image
23
- thumb: https://domain.com/profile/pawel.psztyc/image/thumb
@@ -1,23 +0,0 @@
1
- #%RAML 1.0 DataType
2
-
3
- type: object
4
- description: |
5
- Message sent by a user object. This represents a message in user's sent folder.
6
- properties:
7
- email:
8
- type: string
9
- description: Receiver email address. It's a virtual email address assigned to this user. Messages sent to this address will be rerouted to user's original address.
10
- message:
11
- type: string
12
- description: Message body
13
- timestamp:
14
- type: integer
15
- description: Message sent timestamp as a Uxin timestamp.
16
- attachements:
17
- type: string[]
18
- description: List of URLs to the attachments
19
- required: false
20
- important:
21
- type: boolean
22
- description: True if the message should be marked as an important.
23
- required: false
@@ -1,33 +0,0 @@
1
- #%RAML 1.0 DataType
2
-
3
- type: object
4
- description: An user message object.
5
- properties:
6
- from:
7
- type: object
8
- description: Object representing sender of the message.
9
- required: false
10
- properties:
11
- uid:
12
- type: string
13
- description: User ID.
14
- name:
15
- type: string
16
- description: User full name
17
- email:
18
- type: string
19
- description: User emaill address to be used to return the message. It's a virtual email address assigned to this user. Messages sent to this address will be rerouted to user's original address.
20
- message:
21
- type: string
22
- description: Message body
23
- timestamp:
24
- type: integer
25
- description: Message sent timestamp as a Uxin timestamp.
26
- attachements:
27
- type: string[]
28
- description: List of URLs to the attachments
29
- required: false
30
- important:
31
- type: boolean
32
- description: True if the message should be marked as an important.
33
- required: false
@@ -1,52 +0,0 @@
1
- #%RAML 1.0 DataType
2
-
3
- displayName: A product resource
4
- description: A single product representing an item in the store.
5
- type: !include resource.raml
6
- properties:
7
- id:
8
- description: |
9
- Product id. It is a UUID of the database record.
10
- __This property will be ignored when creating an object.__
11
- It will be available when the product is stored in the datastore.
12
- pattern: "[0-9a-zA-Z-]+"
13
- name:
14
- type: string
15
- description: Product name
16
- example: Acme product - mentol flavor, 500 ml.
17
- required: true
18
- quantity:
19
- type: number
20
- description: |
21
- The quantity of the product in the one unit of measurement.
22
- See `unit` property for more information.
23
- example: 500
24
- required: true
25
- unit:
26
- type: string
27
- description: The unit of measuremet for the quantity property.
28
- example: ml
29
- required: true
30
- upc:
31
- type: string
32
- pattern: "[0-9]{12,12}"
33
- description: |
34
- The Universal Produc Code. It consists of 12 numerical digits. However, because of the
35
- integer precision limitation in JavaScript it is represented as a string.
36
- example: "042100005264"
37
- required: true
38
- available:
39
- type: boolean
40
- description: |
41
- Product current availability in the store.
42
- Product may be not available but the users still can order it with later delivery date.
43
- required: true
44
- example: true
45
- example:
46
- id: we2322-4f4f4f-f4f4ff-f4f4ff4
47
- name: Acme Product
48
- quantity: 200
49
- unit: ml
50
- upc: "123456789101"
51
- available: true
52
- etag: "Wsd3deef3rgrgf4r"
@@ -1,11 +0,0 @@
1
- #%RAML 1.0 DataType
2
-
3
- description: |
4
- Common properties for all resources returned by the API.
5
- type: object
6
- properties:
7
- etag:
8
- type: string
9
- description: |
10
- ETag of this resource for caching purposes.
11
- __This property will be ignored when creating an object.__
@@ -1,11 +0,0 @@
1
- <?xml version="1.0" encoding="UTF-8"?>
2
- <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" attributeFormDefault="unqualified">
3
- <xs:element name="resource">
4
- <xs:complexType>
5
- <xs:sequence>
6
- <xs:element name="message" type="xs:string"></xs:element>
7
- </xs:sequence>
8
- <xs:attribute name="error" type="xs:boolean" use="required"/>
9
- </xs:complexType>
10
- </xs:element>
11
- </xs:schema>
@@ -1,11 +0,0 @@
1
- <?xml version="1.0" encoding="UTF-8"?>
2
- <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" attributeFormDefault="unqualified">
3
- <xs:element name="image">
4
- <xs:complexType>
5
- <xs:sequence>
6
- <xs:element name="url" type="xs:string"></xs:element>
7
- <xs:element name="thumb" type="xs:string"></xs:element>
8
- </xs:sequence>
9
- </xs:complexType>
10
- </xs:element>
11
- </xs:schema>
@@ -1,104 +0,0 @@
1
- {
2
- "$id": "http://example.com/example.json",
3
- "type": "object",
4
- "definitions": {},
5
- "$schema": "http://json-schema.org/draft-07/schema#",
6
- "properties": {
7
- "id": {
8
- "$id": "/properties/id",
9
- "type": "string",
10
- "title": "The Id Schema ",
11
- "default": "",
12
- "examples": [
13
- "R34fg663H9KW9MMSKISI"
14
- ]
15
- },
16
- "name": {
17
- "$id": "/properties/name",
18
- "type": "string",
19
- "title": "The Name Schema ",
20
- "default": "",
21
- "examples": [
22
- "Pawel Psztyc"
23
- ]
24
- },
25
- "birthday": {
26
- "$id": "/properties/birthday",
27
- "type": "string",
28
- "title": "The Birthday Schema ",
29
- "default": "",
30
- "examples": [
31
- "1983-10-20"
32
- ]
33
- },
34
- "gender": {
35
- "$id": "/properties/gender",
36
- "type": "string",
37
- "title": "The Gender Schema ",
38
- "default": "",
39
- "examples": [
40
- "male"
41
- ]
42
- },
43
- "url": {
44
- "$id": "/properties/url",
45
- "type": "string",
46
- "title": "The Url Schema ",
47
- "default": "",
48
- "examples": [
49
- "https://domain.com/profile/pawel.psztyc"
50
- ]
51
- },
52
- "image": {
53
- "$id": "/properties/image",
54
- "type": "object",
55
- "properties": {
56
- "url": {
57
- "$id": "/properties/image/properties/url",
58
- "type": "string",
59
- "title": "The Url Schema ",
60
- "default": "",
61
- "examples": [
62
- "https://domain.com/profile/pawel.psztyc/image"
63
- ]
64
- },
65
- "thumb": {
66
- "$id": "/properties/image/properties/thumb",
67
- "type": "string",
68
- "title": "The Thumb Schema ",
69
- "default": "",
70
- "examples": [
71
- "https://domain.com/profile/pawel.psztyc/image/thumb"
72
- ]
73
- }
74
- }
75
- },
76
- "tagline": {
77
- "$id": "/properties/tagline",
78
- "type": "string",
79
- "title": "The Tagline Schema ",
80
- "default": "",
81
- "examples": [
82
- "Some text about me."
83
- ]
84
- },
85
- "language": {
86
- "$id": "/properties/language",
87
- "type": "string",
88
- "title": "The Language Schema ",
89
- "default": "",
90
- "examples": [
91
- "en_GB"
92
- ]
93
- },
94
- "etag": {
95
- "$id": "/properties/etag",
96
- "type": "string",
97
- "title": "The Etag Schema ",
98
- "default": "",
99
- "examples": [
100
- "W\\244m4n5kj3gbn2nj4k4n4"
101
- ]
102
- }
103
- }
104
- }
@@ -1,26 +0,0 @@
1
- <?xml version="1.0" encoding="UTF-8"?>
2
- <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" attributeFormDefault="unqualified">
3
- <xs:element name="resource">
4
- <xs:complexType>
5
- <xs:sequence>
6
- <xs:element name="id" type="xs:string"></xs:element>
7
- <xs:element name="name" type="xs:string"></xs:element>
8
- <xs:element name="birthday" type="xs:date"></xs:element>
9
- <xs:element name="gender" type="xs:string"></xs:element>
10
- <xs:element name="url" type="xs:string"></xs:element>
11
- <xs:element name="image">
12
- <xs:complexType>
13
- <xs:sequence>
14
- <xs:element name="url" type="xs:string"></xs:element>
15
- <xs:element name="thumb" type="xs:string"></xs:element>
16
- </xs:sequence>
17
- </xs:complexType>
18
- </xs:element>
19
- <xs:element name="tagline" type="xs:string"></xs:element>
20
- <xs:element name="language" type="xs:string"></xs:element>
21
- </xs:sequence>
22
- <xs:attribute name="error" type="xs:boolean" use="required"></xs:attribute>
23
- <xs:attribute name="type" type="xs:string" use="required"></xs:attribute>
24
- </xs:complexType>
25
- </xs:element>
26
- </xs:schema>
@@ -1,17 +0,0 @@
1
- <?xml version="1.0" encoding="UTF-8"?>
2
- <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" attributeFormDefault="unqualified">
3
- <xs:element name="resource">
4
- <xs:complexType>
5
- <xs:sequence>
6
- <xs:element name="id" type="xs:string"></xs:element>
7
- <xs:element name="name" type="xs:string"></xs:element>
8
- <xs:element name="quantity" type="xs:double"></xs:element>
9
- <xs:element name="unit" type="xs:string"></xs:element>
10
- <xs:element name="upc" type="xs:string"></xs:element>
11
- <xs:element name="available" type="xs:string"></xs:element>
12
- </xs:sequence>
13
- <xs:attribute name="error" type="xs:string"></xs:attribute>
14
- <xs:attribute name="type" type="xs:string"></xs:attribute>
15
- </xs:complexType>
16
- </xs:element>
17
- </xs:schema>
@@ -1,5 +0,0 @@
1
- #%RAML 1.0 SecurityScheme
2
-
3
- description: |
4
- This API supports Basic Authentication for staging environment.
5
- type: Basic Authentication
@@ -1,29 +0,0 @@
1
- #%RAML 1.0 SecurityScheme
2
- type: OAuth 2.0
3
- description: This API supports OAuth 2.0 for authenticating all API requests.
4
- describedBy:
5
- queryParameters:
6
- access_token:
7
- type: string
8
- description: Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.
9
- required: false
10
- headers:
11
- authorization:
12
- type: string
13
- example: ya.2453vfDb3cJHisdf.*&H
14
- description: Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
15
- required: false
16
- responses:
17
- 401:
18
- description: Bad or expired token. This can happen if the user or Dropbox revoked or expired an access token. To fix, re-authenticate the user.
19
- body:
20
- application/json:
21
- 403:
22
- description: Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.
23
- body:
24
- application/json:
25
- settings:
26
- accessTokenUri: http://api.domain.com/oauth2/token
27
- authorizationUri: http://api.domain.com/oauth2/auth
28
- authorizationGrants: ["authorization_code", "implicit"]
29
- scopes: ["profile", "email"]
@@ -1,26 +0,0 @@
1
- #%RAML 1.0 SecurityScheme
2
-
3
- description: |
4
- A custom security scheme for authenticating requests.
5
- type: x-custom
6
- describedBy:
7
- headers:
8
- SpecialToken:
9
- description: |
10
- Used to send a custom token.
11
- type: string
12
- queryParameters:
13
- debugToken:
14
- description: Select one of available values to run the request in the debug mode with selected level.
15
- enum: [Info, Log, Warning, Error, Critical]
16
- type: string
17
- required: false
18
- booleanToken:
19
- description: Just to test boolean values.
20
- type: boolean
21
- default: true
22
- responses:
23
- 401:
24
- description: |
25
- Bad token.
26
- 403:
@@ -1,23 +0,0 @@
1
- #%RAML 1.0 Trait
2
-
3
- #displayName: Adminable
4
- description: Use this to mark a resource that can be changed only by users with admin level.
5
-
6
- usage: |
7
- Some resources can be changed only by users with Admin clerance level. This resources will be
8
- marked with the header `X-Admin-Resource` when requesting it. It means that every attemp to
9
- update the resource by non-admin user will result with 401 response.
10
-
11
- responses:
12
- 200:
13
- headers:
14
- X-Amin-Resource:
15
- displayName: Admin resource mark header
16
- type: boolean
17
- default: false
18
- description: This header is not set if the resource can be changed by non-admin users.
19
- 401:
20
- description: |
21
- The 401 response will be returned when trying to update the resource with
22
- non-admin clerance level. Resources that requires admin privileges are marked with
23
- `X-Admin-Resource` header when getting the resource.