@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,24 +0,0 @@
1
- #%RAML 1.0 DataType
2
-
3
- description: |
4
- A dimmensions of an object like image.
5
-
6
- type: object
7
- properties:
8
- width:
9
- type: number
10
- description: |
11
- Width of the shape.
12
- height:
13
- type: number
14
- description: |
15
- Height of the shape.
16
- unit?:
17
- type: string
18
- default: px
19
- description: |
20
- A unit that describes the dimension. It can be, for example, `px` for
21
- pixels, `pt` for points, `%` for percentage.
22
- example:
23
- width: 200
24
- height: 160
@@ -1,7 +0,0 @@
1
- #%RAML 1.0 DataType
2
- description: |
3
- An external data-type
4
- type: object
5
- properties:
6
- prop1:
7
- type: string
@@ -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,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: "W\\sd3deef3rgrgf4r"
@@ -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,50 +0,0 @@
1
- #%RAML 1.0 ResourceType
2
-
3
- get:
4
- queryParameters:
5
- access_token:
6
- type: string
7
- required: false
8
- description: |
9
- OAuth 2.0 token for the current user.
10
- One possible way to provide an OAuth 2.0 token.
11
- callback:
12
- type: string
13
- required: false
14
- description: |
15
- Name of the JavaScript callback function that handles the response.
16
- Used in JavaScript JSON-P requests.
17
- fields:
18
- type: string
19
- required: false
20
- description: |
21
- Selector specifying a subset of fields to include in the response.
22
- For more information, see the partial response section in the Performance Tips document.
23
- Use for better performance.
24
- key:
25
- type: string
26
- required: false
27
- description: |
28
- Required unless you provide an OAuth 2.0 token.
29
- Your API key identifies your project and provides you with API access, quota, and reports.
30
- Obtain your project's API key from the Google API Console.
31
- prettyPrint:
32
- type: boolean
33
- required: false
34
- description: |
35
- Returns response with indentations and line breaks.
36
- When this is false, it can reduce the response payload size, which might lead to better performance in some environments.
37
- default: true
38
- quotaUser:
39
- type: string
40
- required: false
41
- description: |
42
- Alternative to `userIp`.
43
- Lets you enforce per-user quotas from a server-side application even in cases when the user's IP address is unknown. This can occur, for example, with applications that run cron jobs on App Engine on a user's behalf.
44
- You can choose any arbitrary string that uniquely identifies a user, but it is limited to 40 characters.
45
- Overrides userIp if both are provided.
46
- userIp:
47
- type: string
48
- required: false
49
- description: |
50
- IP address of the end user for whom the API call is being made. Lets you enforce per-user quotas when calling the API from a server-side application.
@@ -1,37 +0,0 @@
1
- #%RAML 1.0 DataType
2
-
3
- displayName: User
4
- type: object
5
- description: A representation of a user in Google Drive.
6
- properties:
7
- kind:
8
- type: string
9
- description: This is always drive#user.
10
- enum: [drive#user]
11
- default: drive#user
12
- displayName:
13
- type: string
14
- required: false
15
- description: A plain text displayable name for this user.
16
- picture:
17
- type: object
18
- description: The user's profile picture.
19
- required: false
20
- properties:
21
- url:
22
- type: string
23
- required: false
24
- description: A URL that points to a profile picture of this user.
25
- isAuthenticatedUser:
26
- type: boolean
27
- required: false
28
- description: Whether this user is the same as the authenticated user for whom the request was made.
29
- example: false
30
- permissionId:
31
- type: string
32
- required: false
33
- description: The user's ID as visible in the permissions collection.
34
- emailAddress:
35
- type: string
36
- required: false
37
- description: The email address of the user.
@@ -1,468 +0,0 @@
1
- #%RAML 1.0
2
- title: API body demo
3
- version: v1
4
- baseUri: http://{instance}.domain.com/
5
-
6
- mediaType: [application/json, application/xml]
7
- protocols: [HTTP, HTTPS]
8
-
9
- description: |
10
- This is a description of demo API.
11
-
12
- This is **markdown**.
13
-
14
- baseUriParameters:
15
- instance:
16
- description: |
17
- The execution environments. Can be one of:
18
- - development
19
- - staging
20
- - qa
21
- - production
22
- type: string
23
- enum: [development, staging, qa, production]
24
- pattern: (development|staging|qa|production)
25
- default: production
26
- annotationTypes:
27
- deprecated: string
28
- annotationTest: nil
29
- clearanceLevel:
30
- properties:
31
- level:
32
- enum: [ low, medium, high ]
33
- required: true
34
- signature:
35
- pattern: "\\d{3}-\\w{12}"
36
- required: true
37
- uses:
38
- ExampleType: resourceTypes/example-types.raml
39
- myLib: library.raml
40
- types:
41
- Image: !include resourceTypes/image.raml
42
- Resource: !include resourceTypes/resource.raml
43
- AppPerson: !include resourceTypes/app-person.raml
44
- Product: !include resourceTypes/product.raml
45
- ErrorResource:
46
- description: A response that is errored
47
- type: object
48
- properties:
49
- error:
50
- type: boolean
51
- required: true
52
- example: true
53
- default: true
54
- description: Indicate that the response is errored.
55
- message:
56
- type: string
57
- description: The error message associated with the error.
58
- required: true
59
- Feature:
60
- description: A feature to test enum values in the URI parameters.
61
- type: string
62
- enum:
63
- - A
64
- - B
65
- - C
66
-
67
- resourceTypes:
68
- ResourceNotFound:
69
- get:
70
- responses:
71
- 404:
72
- body:
73
- application/json:
74
- displayName: Not found response
75
- type: ErrorResource
76
- application/xml:
77
- displayName: Not found response
78
- type: !include schemas/error-response.xsd
79
- example: !include examples/e404.xml
80
- UnauthorizedResponse:
81
- get:
82
- responses:
83
- 404:
84
- body:
85
- application/json:
86
- displayName: Unauthorized response
87
- type: ErrorResource
88
- application/xml:
89
- displayName: Unauthorized response
90
- type: !include schemas/error-response.xsd
91
- example: !include examples/e401.xml
92
- RequestErrorResponse:
93
- get:
94
- responses:
95
- 400:
96
- description: The error response when one of the parameters is invalid and can't be parsed. Nothing can be done at the time except correcting the request to send valid data.
97
- body:
98
- application/json:
99
- displayName: Invalid request
100
- type: ErrorResource
101
- application/xml:
102
- displayName: Invalid request
103
- type: !include schemas/error-response.xsd
104
- example: !include examples/e400.xml
105
- traits:
106
- Paginated: !include traits/pagination.raml
107
- Adminable: !include traits/adminable.raml
108
- RateLimited: !include traits/rate-limited.raml
109
- securitySchemes:
110
- oauth_2_0: !include securitySchemes/oauth_2_0.raml
111
- x-custom: !include securitySchemes/x-custom.raml
112
- basic: !include securitySchemes/basic.raml
113
-
114
- documentation:
115
- - title: Test doc
116
- content: Test content
117
-
118
- securedBy: [basic]
119
-
120
- /test-parameters/{feature}:
121
- (deprecated): This endpoint is deprecated and will be removed.
122
- securedBy: [myLib.oauthLib]
123
- uriParameters:
124
- feature:
125
- type: string
126
- enum:
127
- - A
128
- - B
129
- - C
130
- get:
131
- (deprecated): This method is deprecated and will be removed.
132
- (clearanceLevel):
133
- level: high
134
- signature: 230-ghtwvfrs1itr
135
- description: To test enum values in the URI parameters for inline type declaration.
136
- queryParameters:
137
- testRepeatable:
138
- (deprecated): Test parameter will be removed in next version of the API.
139
- required: true
140
- type: string[]
141
- example: [value1, value2]
142
- numericRepeatable:
143
- required: true
144
- type: integer[]
145
- examples:
146
- Some-test-example: [123, 456]
147
- Other-example: [1011, 1213]
148
- notRequiredRepeatable:
149
- (annotationTest):
150
- type: array
151
- items: date-only
152
- required: false
153
- /{typeFeature}:
154
- (annotationTest):
155
- (deprecated): This method will be removed in future release of the API.
156
- uriParameters:
157
- typeFeature:
158
- (annotationTest):
159
- type: Feature
160
- get:
161
- (deprecated): This endpoint is deprecated and will be removed.
162
- description: To test enum values in the URI parameters for global type declaration.
163
- /people:
164
- displayName: People
165
- type: RequestErrorResponse
166
- is: [RateLimited]
167
- get:
168
- (annotationTest):
169
- displayName: List people
170
- description: Use this method to list all the people.
171
- is: [Paginated: {resourceType: AppPerson}]
172
- headers:
173
- x-people-op-id:
174
- (annotationTest):
175
- type: string
176
- pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[4][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
177
- description: People ops ID. It is UUID v4 string
178
- example: 9719fa6f-c666-48e0-a191-290890760b30
179
- post:
180
- (deprecated): |
181
- This method is not deprecated. And this is only an annotation test.
182
- displayName: Create a person
183
- description: Use this method to add new person
184
- body:
185
- application/json:
186
- (deprecated): This response type is deprecated and soon will be replaced.
187
- type: AppPerson
188
- application/xml:
189
- type: !include schemas/person.xsd
190
- example: !include examples/person.xml
191
- put:
192
- displayName: Update a person
193
- description: Updates the person in the datastore.
194
- body:
195
- application/json:
196
- schema: !include schemas/person.json
197
- example: !include examples/person.json
198
- application/xml:
199
- type: !include schemas/person.xsd
200
- example: !include examples/person.xml
201
- responses:
202
- 200:
203
- (deprecated): This response type is deprecated and soon will be replaced.
204
- description: |
205
- Success response for the body
206
- headers:
207
- X-Frame-Options:
208
- type: string
209
- examples:
210
- Deny: DENY
211
- SameOrigin: SAMEORIGIN
212
- body:
213
- application/json:
214
- schema: !include schemas/person.json
215
- example: !include examples/person.json
216
- application/xml:
217
- type: !include schemas/person.xsd
218
- example: !include examples/person.xml
219
- /{personId}:
220
- securedBy: x-custom
221
- type: ResourceNotFound
222
- displayName: A person
223
- description: The endpoint to access information about the person
224
- uriParameters:
225
- personId:
226
- type: integer
227
- required: true
228
- description: The ID of the person in the system. It is generated by the database numeric value for the person.
229
- example: 1234
230
- get:
231
- displayName: Get a person
232
- description: Returns a person
233
- headers:
234
- x-client-id:
235
- (deprecated): This will be replaced
236
- example: 123456-acme.client.com
237
- description: The application id used to make a request. It can be obtained in the developer console.
238
- type: string
239
- required: true
240
- x-people-op-id:
241
- (annotationTest):
242
- type: string
243
- pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[4][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
244
- description: People ops ID. It is UUID v4 string
245
- example: 9719fa6f-c666-48e0-a191-290890760b30
246
- responses:
247
- 200:
248
- body:
249
- application/json:
250
- type: AppPerson
251
- application/xml:
252
- type: !include schemas/person.xsd
253
- example: !include examples/person.xml
254
- delete:
255
- displayName: Remove a person
256
- description: Removes the person from the datastore. This method do not returns any data in 200 response.
257
- responses:
258
- 204:
259
- headers:
260
- x-people-op-id:
261
- (annotationTest):
262
- type: string
263
- pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[4][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
264
- description: People ops ID. It is UUID v4 string
265
- example: 9719fa6f-c666-48e0-a191-290890760b30
266
- put:
267
- displayName: Update a person
268
- description: Updates the person in the datastore.
269
- queryParameters:
270
- testPatam: string
271
- body:
272
- application/json:
273
- type: AppPerson
274
- application/xml:
275
- type: !include schemas/person.xsd
276
- example: !include examples/person.xml
277
- responses:
278
- 200:
279
- headers:
280
- x-people-op-id:
281
- (annotationTest):
282
- type: string
283
- pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[4][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
284
- description: People ops ID. It is UUID v4 string
285
- example: 9719fa6f-c666-48e0-a191-290890760b30
286
- /products:
287
- displayName: Products
288
- description: The API is to be used to access data about the products.
289
- type: RequestErrorResponse
290
- post:
291
- displayName: Create product
292
- description: |
293
- Creates a product in the store.
294
- While creating a product the `id` and `etag` properties will be ignored.
295
-
296
- The endpoint will reject the request if exactly the same product is already defined in the
297
- datastore (all properties of both objects equals). Newly created product is available
298
- for listing but **it won't be available for ordering API** until it's availability is not set.
299
- body:
300
- application/json:
301
- type: Product
302
- application/xml:
303
- type: !include schemas/product.xsd
304
- example: !include examples/product.xml
305
- responses:
306
- 200:
307
- body:
308
- application/json:
309
- type: Product
310
- examples:
311
- Product:
312
- id: d697f5cea85011e680f576304dec7eb7
313
- name: Super product
314
- quantity: 125
315
- unit: ml
316
- upc: "123456789101"
317
- available: true
318
- etag: "W/\"686897696a7c876b7e\""
319
- OtherProduct:
320
- id: 123e4567e89b12d3a456426655440000
321
- name: Acme Product
322
- quantity: 1
323
- unit: kg
324
- upc: "223456789101"
325
- available: true
326
- etag: "W/\"123456789\""
327
- application/xml:
328
- type: !include schemas/product.xsd
329
- example: !include examples/product.xml
330
- 400:
331
- description: The request has been rejected. Probably the product already exists in the datastore.
332
- /orgs:
333
- /{orgId}:
334
- is: [RateLimited]
335
- get:
336
- displayName: Get organization
337
- description: Returns an organization info.
338
- responses:
339
- 200:
340
- body:
341
- application/json:
342
- type: ExampleType.Org
343
- properties:
344
- id:
345
- type: string
346
- description: UUID generated ID
347
- example:
348
- id: "12345"
349
- onCall:
350
- firstname: nico
351
- lastname: ark
352
- kind: AcmeAdmin
353
- clearanceLevel: low
354
- phone: "12321"
355
- Head:
356
- firstname: nico
357
- lastname: ark
358
- kind: AcmeManager
359
- reports:
360
- -
361
- firstname: nico
362
- lastname: ark
363
- kind: admin
364
- phone: "123-23"
365
- put:
366
- body:
367
- application/json:
368
- type: ExampleType.Org
369
- properties:
370
- id:
371
- type: string
372
- description: UUID generated ID
373
- responses:
374
- 200:
375
- body:
376
- application/json:
377
- type: ExampleType.Org
378
- /managers:
379
- get:
380
- responses:
381
- 200:
382
- body:
383
- application/json:
384
- type: ExampleType.Manager[]
385
- /messages:
386
- securedBy: [oauth_2_0]
387
- post:
388
- description: Create a new message
389
- is: [Adminable]
390
- body:
391
- application/json:
392
- type: object
393
- properties:
394
- receiver:
395
- type: string
396
- description: receiver of the message
397
- required: true
398
- body:
399
- type: string
400
- description: A message body
401
- required: true
402
- important:
403
- type: boolean
404
- description: If true then the message will be marked as important
405
- default: false
406
- required: true
407
- get:
408
- description: |
409
- List user messages. It returns an array of messages for last of 7 days if
410
- `since` property is not set.
411
- You can use `since` and `until` query parameters to control messages time
412
- span.
413
- queryParameters:
414
- until:
415
- (annotationTest):
416
- type: date-only
417
- description: Date right limit of the messages query.
418
- example: 2017-05-12
419
- since:
420
- type: date-only
421
- description: Date left limit of the messages query.
422
- example: 2017-05-10
423
- responses:
424
- 200:
425
- body:
426
- application/json:
427
- type: array
428
- items: !include resourceTypes/message-type.raml
429
- example: !include examples/messages-example.json
430
- /bulk:
431
- post:
432
- description: Bulk create messages.
433
- is: [Adminable]
434
- body:
435
- application/json:
436
- (annotationTest):
437
- type: array
438
- items: !include resourceTypes/message-sent-type.raml
439
- examples:
440
- Example1: !include examples/messages-sent-example.json
441
- /arrayBody:
442
- post:
443
- body:
444
- application/json:
445
- (deprecated): This response type is deprecated and soon will be replaced.
446
- description: |
447
- This demonstrates a body as an Array
448
- type: AppPerson[]
449
- /multipleTypeInheritance:
450
- get:
451
- description: |
452
- The response body inherits the following types:
453
-
454
- - AppPerson
455
- - AlertableAdmin
456
- responses:
457
- 200:
458
- body:
459
- application/json:
460
- type:
461
- - AppPerson
462
- - ExampleType.AlertableAdmin
463
- /typeFromLibraryEndpoint:
464
- post:
465
- body:
466
- type: myLib.TypeFromLibray
467
- responses:
468
- 200:
@@ -1,4 +0,0 @@
1
- <?xml version="1.0" encoding="UTF-8"?>
2
- <resource error="true">
3
- <message>Invalid request</message>
4
- </resource>
@@ -1,4 +0,0 @@
1
- <?xml version="1.0" encoding="UTF-8"?>
2
- <resource error="true">
3
- <message>Unauthorized</message>
4
- </resource>
@@ -1,4 +0,0 @@
1
- <?xml version="1.0" encoding="UTF-8"?>
2
- <resource error="true">
3
- <message>Not found</message>
4
- </resource>
@@ -1,5 +0,0 @@
1
- <?xml version="1.0" encoding="UTF-8"?>
2
- <image>
3
- <url>https://www.domain.com/people/Qawer63J73HJ6khjswuqyq62382jG21s/image</url>
4
- <thumb>https://www.domain.com/people/Qawer63J73HJ6khjswuqyq62382jG21s/image/thumb</thumb>
5
- </image>