common.py 5.5KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126
  1. from collections import OrderedDict
  2. SWAGGER_DOC_API = {
  3. 'definitions': {
  4. 'AboutResponseSchema': {'properties': {
  5. 'datetime': {'format': 'date-time',
  6. 'type': 'string'},
  7. 'version': {'type': 'string'}
  8. },
  9. 'required': ['datetime', 'version'],
  10. 'type': 'object'},
  11. 'ListsUserSchema': {'properties': {
  12. 'item_nb': {'format': 'int32',
  13. 'minimum': 0,
  14. 'type': 'integer'},
  15. 'items': {
  16. 'items': {'$ref': '#/definitions/UserSchema_without_email_address_first_name_last_name'},
  17. 'type': 'array'},
  18. 'pagination': {'$ref': '#/definitions/PaginationSchema'}},
  19. 'required': ['item_nb'],
  20. 'type': 'object'},
  21. 'NoContentSchema': {'properties': {},
  22. 'type': 'object'},
  23. 'PaginationSchema': {'properties': {
  24. 'current_id': {'format': 'int32', 'type': 'integer'},
  25. 'first_id': {'format': 'int32', 'type': 'integer'},
  26. 'last_id': {'format': 'int32', 'type': 'integer'}},
  27. 'required': ['current_id', 'first_id', 'last_id'],
  28. 'type': 'object'},
  29. 'UserSchema': {'properties': {
  30. 'company': {'type': 'string'},
  31. 'display_name': {'type': 'string'},
  32. 'email_address': {'format': 'email', 'type': 'string'},
  33. 'first_name': {'type': 'string'},
  34. 'id': {'format': 'int32', 'type': 'integer'},
  35. 'last_name': {'type': 'string'},
  36. 'username': {'type': 'string'}},
  37. 'required': ['company',
  38. 'display_name',
  39. 'email_address',
  40. 'first_name',
  41. 'id',
  42. 'last_name',
  43. 'username'],
  44. 'type': 'object'},
  45. 'UserSchema_without_id': {
  46. 'properties': {
  47. 'username': {'type': 'string'},
  48. 'display_name': {'type': 'string'},
  49. 'company': {'type': 'string'},
  50. 'last_name': {'type': 'string'},
  51. 'email_address': {'format': 'email', 'type': 'string'},
  52. 'first_name': {'type': 'string'}},
  53. 'required': ['company', 'display_name', 'email_address', 'first_name',
  54. 'last_name', 'username'], 'type': 'object'},
  55. 'UserSchema_without_email_address_first_name_last_name': {
  56. 'properties': {
  57. 'username': {'type': 'string'},
  58. 'id': {'format': 'int32', 'type': 'integer'},
  59. 'company': {'type': 'string'},
  60. 'display_name': {'type': 'string'}},
  61. 'required': ['company', 'display_name', 'id', 'username'], 'type': 'object'
  62. },
  63. },
  64. 'info': {'description': 'just an example of hapic API', 'title': 'Fake API', 'version': '1.0.0'},
  65. 'parameters': {},
  66. 'paths': OrderedDict(
  67. [('/about', {
  68. 'get': {
  69. 'description': 'General information about this API.',
  70. 'responses': {200: {
  71. 'description': '200',
  72. 'schema': {'$ref': '#/definitions/AboutResponseSchema'}}}}}),
  73. ('/users', {
  74. 'get': {
  75. 'description': 'Obtain users list.',
  76. 'responses': {200: {
  77. 'description': '200',
  78. 'schema': {'$ref': '#/definitions/ListsUserSchema'}}}}}),
  79. ('/users/{id}', {
  80. 'delete': {
  81. 'description': 'delete user',
  82. 'parameters': [{'format': 'int32',
  83. 'minimum': 1,
  84. 'in': 'path',
  85. 'name': 'id',
  86. 'required': True,
  87. 'type': 'integer'}],
  88. 'responses': {204: {
  89. 'description': '204',
  90. 'schema': {'$ref': '#/definitions/NoContentSchema'}}}},
  91. 'get': {
  92. 'description': 'Obtain one user',
  93. 'parameters': [{'format': 'int32',
  94. 'in': 'path',
  95. 'minimum': 1,
  96. 'name': 'id',
  97. 'required': True,
  98. 'type': 'integer'}],
  99. 'responses': {200: {
  100. 'description': '200',
  101. 'schema': {'$ref': '#/definitions/UserSchema'}}}}}),
  102. ('/users/', {
  103. 'post': {
  104. 'description': 'Add new user',
  105. 'parameters': [{'in': 'body',
  106. 'name': 'body',
  107. 'schema': {'$ref': '#/definitions/UserSchema_without_id'}}],
  108. 'responses': {200: {
  109. 'description': '200',
  110. 'schema': {'$ref': '#/definitions/UserSchema'}}}}}),
  111. ( '/users2', {
  112. 'get': {
  113. 'description': 'Obtain users list.',
  114. 'responses': {200: {
  115. 'description': '200',
  116. 'schema': {'type': 'array',
  117. 'items': {'$ref': '#/definitions/UserSchema_without_email_address_first_name_last_name'}
  118. }
  119. }}}}
  120. )]),
  121. 'swagger': '2.0',
  122. 'tags': []
  123. }