core-explore-example-app 2.16.0__tar.gz → 2.17.0__tar.gz

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 (142) hide show
  1. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/PKG-INFO +1 -1
  2. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/core_explore_example_app/rest/persistent_query_example/views.py +208 -87
  3. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/core_explore_example_app/rest/saved_query/views.py +73 -24
  4. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/core_explore_example_app.egg-info/PKG-INFO +1 -1
  5. core_explore_example_app-2.17.0/core_explore_example_app.egg-info/requires.txt +7 -0
  6. core_explore_example_app-2.17.0/requirements.core.txt +3 -0
  7. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/setup.py +1 -1
  8. core_explore_example_app-2.16.0/core_explore_example_app.egg-info/requires.txt +0 -7
  9. core_explore_example_app-2.16.0/requirements.core.txt +0 -3
  10. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/LICENSE.md +0 -0
  11. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/MANIFEST.in +0 -0
  12. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/README.rst +0 -0
  13. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/core_explore_example_app/__init__.py +0 -0
  14. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/core_explore_example_app/admin.py +0 -0
  15. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/core_explore_example_app/apps.py +0 -0
  16. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/core_explore_example_app/commons/__init__.py +0 -0
  17. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/core_explore_example_app/commons/exceptions.py +0 -0
  18. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/core_explore_example_app/components/__init__.py +0 -0
  19. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/core_explore_example_app/components/explore_data_structure/__init__.py +0 -0
  20. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/core_explore_example_app/components/explore_data_structure/admin_site.py +0 -0
  21. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/core_explore_example_app/components/explore_data_structure/api.py +0 -0
  22. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/core_explore_example_app/components/explore_data_structure/models.py +0 -0
  23. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/core_explore_example_app/components/persistent_query_example/__init__.py +0 -0
  24. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/core_explore_example_app/components/persistent_query_example/admin_site.py +0 -0
  25. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/core_explore_example_app/components/persistent_query_example/api.py +0 -0
  26. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/core_explore_example_app/components/persistent_query_example/models.py +0 -0
  27. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/core_explore_example_app/components/saved_query/__init__.py +0 -0
  28. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/core_explore_example_app/components/saved_query/admin_site.py +0 -0
  29. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/core_explore_example_app/components/saved_query/api.py +0 -0
  30. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/core_explore_example_app/components/saved_query/models.py +0 -0
  31. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/core_explore_example_app/discover.py +0 -0
  32. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/core_explore_example_app/menus.py +0 -0
  33. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/core_explore_example_app/migrations/0001_initial.py +0 -0
  34. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/core_explore_example_app/migrations/__init__.py +0 -0
  35. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/core_explore_example_app/models.py +0 -0
  36. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/core_explore_example_app/permissions/__init__.py +0 -0
  37. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/core_explore_example_app/permissions/discover.py +0 -0
  38. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/core_explore_example_app/permissions/rights.py +0 -0
  39. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/core_explore_example_app/rest/__init__.py +0 -0
  40. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/core_explore_example_app/rest/persistent_query_example/__init__.py +0 -0
  41. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/core_explore_example_app/rest/persistent_query_example/serializers.py +0 -0
  42. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/core_explore_example_app/rest/saved_query/__init__.py +0 -0
  43. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/core_explore_example_app/rest/saved_query/serializers.py +0 -0
  44. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/core_explore_example_app/rest/urls.py +0 -0
  45. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/core_explore_example_app/settings.py +0 -0
  46. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/core_explore_example_app/static/core_explore_example_app/user/css/query_builder.css +0 -0
  47. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/core_explore_example_app/static/core_explore_example_app/user/css/style.css +0 -0
  48. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/core_explore_example_app/static/core_explore_example_app/user/css/xsd_form.css +0 -0
  49. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/core_explore_example_app/static/core_explore_example_app/user/js/build_query.js +0 -0
  50. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/core_explore_example_app/static/core_explore_example_app/user/js/build_query.raw.js +0 -0
  51. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/core_explore_example_app/static/core_explore_example_app/user/js/buttons.raw.js +0 -0
  52. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/core_explore_example_app/static/core_explore_example_app/user/js/choice.raw.js +0 -0
  53. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/core_explore_example_app/static/core_explore_example_app/user/js/persistent_query.raw.js +0 -0
  54. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/core_explore_example_app/static/core_explore_example_app/user/js/refresh_sorting.js +0 -0
  55. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/core_explore_example_app/static/core_explore_example_app/user/js/refresh_sorting.raw.js +0 -0
  56. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/core_explore_example_app/static/core_explore_example_app/user/js/select_fields.js +0 -0
  57. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/core_explore_example_app/static/core_explore_example_app/user/js/select_fields.raw.js +0 -0
  58. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/core_explore_example_app/system/__init__.py +0 -0
  59. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/core_explore_example_app/system/api.py +0 -0
  60. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/core_explore_example_app/tasks.py +0 -0
  61. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/core_explore_example_app/templates/core_explore_example_app/user/build_query.html +0 -0
  62. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/core_explore_example_app/templates/core_explore_example_app/user/errors.html +0 -0
  63. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/core_explore_example_app/templates/core_explore_example_app/user/index.html +0 -0
  64. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/core_explore_example_app/templates/core_explore_example_app/user/list/list.html +0 -0
  65. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/core_explore_example_app/templates/core_explore_example_app/user/modals/custom_tree.html +0 -0
  66. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/core_explore_example_app/templates/core_explore_example_app/user/modals/delete_all_queries.html +0 -0
  67. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/core_explore_example_app/templates/core_explore_example_app/user/modals/delete_query.html +0 -0
  68. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/core_explore_example_app/templates/core_explore_example_app/user/modals/errors.html +0 -0
  69. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/core_explore_example_app/templates/core_explore_example_app/user/modals/sub_elements_query_builder.html +0 -0
  70. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/core_explore_example_app/templates/core_explore_example_app/user/query_builder/add.html +0 -0
  71. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/core_explore_example_app/templates/core_explore_example_app/user/query_builder/and_or_not.html +0 -0
  72. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/core_explore_example_app/templates/core_explore_example_app/user/query_builder/criteria_select.html +0 -0
  73. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/core_explore_example_app/templates/core_explore_example_app/user/query_builder/enum.html +0 -0
  74. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/core_explore_example_app/templates/core_explore_example_app/user/query_builder/field_input.html +0 -0
  75. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/core_explore_example_app/templates/core_explore_example_app/user/query_builder/gregorian_strict_match.html +0 -0
  76. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/core_explore_example_app/templates/core_explore_example_app/user/query_builder/initial_form.html +0 -0
  77. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/core_explore_example_app/templates/core_explore_example_app/user/query_builder/input.html +0 -0
  78. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/core_explore_example_app/templates/core_explore_example_app/user/query_builder/new_criteria.html +0 -0
  79. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/core_explore_example_app/templates/core_explore_example_app/user/query_builder/new_query.html +0 -0
  80. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/core_explore_example_app/templates/core_explore_example_app/user/query_builder/numeric_select.html +0 -0
  81. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/core_explore_example_app/templates/core_explore_example_app/user/query_builder/remove.html +0 -0
  82. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/core_explore_example_app/templates/core_explore_example_app/user/query_builder/string_select.html +0 -0
  83. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/core_explore_example_app/templates/core_explore_example_app/user/query_builder/sub_elements_query.html +0 -0
  84. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/core_explore_example_app/templates/core_explore_example_app/user/query_builder/yes_no.html +0 -0
  85. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/core_explore_example_app/templates/core_explore_example_app/user/results.html +0 -0
  86. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/core_explore_example_app/templates/core_explore_example_app/user/select_fields.html +0 -0
  87. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/core_explore_example_app/urls.py +0 -0
  88. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/core_explore_example_app/utils/__init__.py +0 -0
  89. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/core_explore_example_app/utils/custom_checkbox_renderer.py +0 -0
  90. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/core_explore_example_app/utils/displayed_query.py +0 -0
  91. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/core_explore_example_app/utils/mongo_query.py +0 -0
  92. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/core_explore_example_app/utils/parser.py +0 -0
  93. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/core_explore_example_app/utils/query_builder.py +0 -0
  94. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/core_explore_example_app/utils/xml.py +0 -0
  95. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/core_explore_example_app/views/__init__.py +0 -0
  96. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/core_explore_example_app/views/admin/__init__.py +0 -0
  97. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/core_explore_example_app/views/user/__init__.py +0 -0
  98. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/core_explore_example_app/views/user/ajax.py +0 -0
  99. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/core_explore_example_app/views/user/views.py +0 -0
  100. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/core_explore_example_app.egg-info/SOURCES.txt +0 -0
  101. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/core_explore_example_app.egg-info/dependency_links.txt +0 -0
  102. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/core_explore_example_app.egg-info/top_level.txt +0 -0
  103. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/docs/__init__.py +0 -0
  104. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/docs/conf.py +0 -0
  105. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/docs/conf_urls.py +0 -0
  106. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/pyproject.toml +0 -0
  107. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/setup.cfg +0 -0
  108. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/tests/__init__.py +0 -0
  109. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/tests/components/__init__.py +0 -0
  110. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/tests/components/data/__init__.py +0 -0
  111. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/tests/components/data/fixtures/__init__.py +0 -0
  112. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/tests/components/data/fixtures/fixtures.py +0 -0
  113. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/tests/components/explore_data_structure/__init__.py +0 -0
  114. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/tests/components/explore_data_structure/tests_unit.py +0 -0
  115. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/tests/components/persistent_query_example/__init__.py +0 -0
  116. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/tests/components/persistent_query_example/fixtures/__init__.py +0 -0
  117. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/tests/components/persistent_query_example/fixtures/fixtures.py +0 -0
  118. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/tests/components/persistent_query_example/tests_int_access_control.py +0 -0
  119. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/tests/components/persistent_query_example/tests_unit.py +0 -0
  120. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/tests/components/saved_query/__init__.py +0 -0
  121. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/tests/components/saved_query/tests_unit.py +0 -0
  122. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/tests/mocks.py +0 -0
  123. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/tests/rest/__init__.py +0 -0
  124. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/tests/rest/persistent_query_example/__init__.py +0 -0
  125. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/tests/rest/persistent_query_example/tests_int.py +0 -0
  126. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/tests/rest/persistent_query_example/tests_permissions.py +0 -0
  127. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/tests/rest/saved_query/__init__.py +0 -0
  128. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/tests/rest/saved_query/fixtures/__init__.py +0 -0
  129. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/tests/rest/saved_query/fixtures/fixtures.py +0 -0
  130. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/tests/rest/saved_query/tests_int.py +0 -0
  131. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/tests/rest/saved_query/tests_permissions.py +0 -0
  132. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/tests/test_settings.py +0 -0
  133. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/tests/utils/__init__.py +0 -0
  134. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/tests/utils/mongo_query/__init__.py +0 -0
  135. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/tests/utils/mongo_query/tests_unit.py +0 -0
  136. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/tests/utils/xml/__init__.py +0 -0
  137. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/tests/utils/xml/tests_unit.py +0 -0
  138. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/tests/views/__init__.py +0 -0
  139. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/tests/views/ajax/__init__.py +0 -0
  140. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/tests/views/ajax/tests_unit.py +0 -0
  141. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/tests/views/views/__init__.py +0 -0
  142. {core_explore_example_app-2.16.0 → core_explore_example_app-2.17.0}/tests/views/views/tests_int.py +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: core_explore_example_app
3
- Version: 2.16.0
3
+ Version: 2.17.0
4
4
  Summary: Exploration by example for the curator core project
5
5
  Home-page: https://github.com/usnistgov/core_explore_example_app
6
6
  Author: NIST IT Lab
@@ -1,39 +1,55 @@
1
- """ REST views for the Persistent Query Example.
1
+ """ REST views for the Persistent Query by Example.
2
2
  """
3
3
 
4
4
  from django.db import IntegrityError
5
+ from drf_spectacular.types import OpenApiTypes
6
+ from drf_spectacular.utils import (
7
+ extend_schema,
8
+ OpenApiExample,
9
+ OpenApiParameter,
10
+ OpenApiResponse,
11
+ )
5
12
  from rest_framework import status
6
13
  from rest_framework.exceptions import ValidationError
7
14
  from rest_framework.permissions import IsAdminUser, IsAuthenticated
8
15
  from rest_framework.response import Response
9
16
  from rest_framework.views import APIView
10
17
 
11
- from core_main_app.access_control.exceptions import AccessControlError
12
- from core_main_app.commons import exceptions
13
18
  import core_explore_example_app.components.persistent_query_example.api as persistent_query_example_api
14
19
  from core_explore_example_app.rest.persistent_query_example.serializers import (
15
20
  PersistentQueryExampleSerializer,
16
21
  PersistentQueryExampleAdminSerializer,
17
22
  )
23
+ from core_main_app.access_control.exceptions import AccessControlError
24
+ from core_main_app.commons import exceptions
18
25
 
19
26
 
27
+ @extend_schema(
28
+ tags=["Persistent Query by Example"],
29
+ description="List all persistent query by example, or create a new one",
30
+ )
20
31
  class AdminPersistentQueryExampleList(APIView):
21
- """List all persistent query example, or create a new one."""
32
+ """List all persistent query by example, or create a new one."""
22
33
 
23
34
  permission_classes = (IsAdminUser,)
24
35
  serializer = PersistentQueryExampleAdminSerializer
25
36
 
37
+ @extend_schema(
38
+ summary="Get all persistent query by example",
39
+ description="Retrieve a list of all persistent query by examples",
40
+ responses={
41
+ 200: PersistentQueryExampleAdminSerializer(many=True),
42
+ 403: OpenApiResponse(description="Access Forbidden"),
43
+ 500: OpenApiResponse(description="Internal server error"),
44
+ },
45
+ )
26
46
  def get(self, request):
27
- """Get all user persistent query example
28
-
47
+ """Get all user persistent query by example
29
48
  Args:
30
-
31
49
  request: HTTP request
32
-
33
50
  Returns:
34
-
35
51
  - code: 200
36
- content: List of persistent query example
52
+ content: List of persistent query by example
37
53
  - code: 403
38
54
  content: Forbidden
39
55
  - code: 500
@@ -41,14 +57,11 @@ class AdminPersistentQueryExampleList(APIView):
41
57
  """
42
58
  if not request.user.is_superuser:
43
59
  return Response(status=status.HTTP_403_FORBIDDEN)
44
-
45
60
  try:
46
61
  # Get object
47
62
  object_list = persistent_query_example_api.get_all(request.user)
48
-
49
63
  # Serialize object
50
64
  serializer = self.serializer(object_list, many=True)
51
-
52
65
  # Return response
53
66
  return Response(serializer.data, status=status.HTTP_200_OK)
54
67
  except AccessControlError as exception:
@@ -60,25 +73,43 @@ class AdminPersistentQueryExampleList(APIView):
60
73
  content, status=status.HTTP_500_INTERNAL_SERVER_ERROR
61
74
  )
62
75
 
76
+ @extend_schema(
77
+ summary="Create a persistent query by example",
78
+ description="Create a new persistent query by example",
79
+ request=PersistentQueryExampleAdminSerializer,
80
+ responses={
81
+ 201: PersistentQueryExampleAdminSerializer,
82
+ 400: OpenApiResponse(description="Validation error"),
83
+ 403: OpenApiResponse(description="Access Forbidden"),
84
+ 500: OpenApiResponse(description="Internal server error"),
85
+ },
86
+ examples=[
87
+ OpenApiExample(
88
+ "Create a persistent query by example",
89
+ summary="Create a new persistent query by example",
90
+ description="Create a new persistent query by example with the provided parameters",
91
+ request_only=True,
92
+ value={
93
+ "content": "{}",
94
+ "templates": ["123"],
95
+ "name": "persistent_query_example",
96
+ },
97
+ ),
98
+ ],
99
+ )
63
100
  def post(self, request):
64
- """Create a persistent query example
65
-
101
+ """Create a persistent query by example
66
102
  Parameters:
67
-
68
103
  {
69
- "content": "{}",
70
- "templates": ["5ea99316d26ebc48e475c60a"],
71
- "name": "persistent_query_example"
104
+ "content": "{}",
105
+ "templates": ["123"],
106
+ "name": "persistent_query_example"
72
107
  }
73
-
74
108
  Args:
75
-
76
109
  request: HTTP request
77
-
78
110
  Returns:
79
-
80
111
  - code: 201
81
- content: Created persistent query example
112
+ content: Created persistent query by example
82
113
  - code: 400
83
114
  content: Validation error
84
115
  - code: 403
@@ -88,18 +119,15 @@ class AdminPersistentQueryExampleList(APIView):
88
119
  """
89
120
  if not request.user.is_superuser:
90
121
  return Response(status=status.HTTP_403_FORBIDDEN)
91
-
92
122
  try:
93
123
  # Build serializer
94
124
  serializer = self.serializer(
95
125
  data=request.data, context={"request": request}
96
126
  )
97
-
98
127
  # Validate data
99
128
  serializer.is_valid(raise_exception=True)
100
129
  # Save data
101
130
  serializer.save()
102
-
103
131
  # Return the serialized data
104
132
  return Response(serializer.data, status=status.HTTP_201_CREATED)
105
133
  except ValidationError as validation_exception:
@@ -115,38 +143,44 @@ class AdminPersistentQueryExampleList(APIView):
115
143
  )
116
144
 
117
145
 
146
+ @extend_schema(
147
+ tags=["Persistent Query by Example"],
148
+ description="List all persistent query by example or create one",
149
+ )
118
150
  class PersistentQueryExampleList(APIView):
119
- """List all persistent query example or create one"""
151
+ """List all persistent query by example or create one"""
120
152
 
121
153
  permission_classes = (IsAuthenticated,)
122
154
  serializer = PersistentQueryExampleSerializer
123
155
 
156
+ @extend_schema(
157
+ summary="Get all persistent query by example by user",
158
+ description="Retrieve a list of all persistent query by examples for the current user",
159
+ responses={
160
+ 200: PersistentQueryExampleSerializer(many=True),
161
+ 403: OpenApiResponse(description="Access Forbidden"),
162
+ 500: OpenApiResponse(description="Internal server error"),
163
+ },
164
+ )
124
165
  def get(self, request):
125
- """Get all user persistent query example
126
-
166
+ """Get all user persistent query by example
127
167
  Args:
128
-
129
168
  request: HTTP request
130
-
131
169
  Returns:
132
-
133
170
  - code: 200
134
- content: List of persistent query example
171
+ content: List of persistent query by example
135
172
  - code: 403
136
173
  content: Forbidden
137
174
  - code: 500
138
175
  content: Internal server error
139
176
  """
140
-
141
177
  try:
142
178
  # Get object
143
179
  object_list = persistent_query_example_api.get_all_by_user(
144
180
  request.user
145
181
  )
146
-
147
182
  # Serialize object
148
183
  serializer = self.serializer(object_list, many=True)
149
-
150
184
  # Return response
151
185
  return Response(serializer.data, status=status.HTTP_200_OK)
152
186
  except AccessControlError as exception:
@@ -158,23 +192,40 @@ class PersistentQueryExampleList(APIView):
158
192
  content, status=status.HTTP_500_INTERNAL_SERVER_ERROR
159
193
  )
160
194
 
195
+ @extend_schema(
196
+ summary="Create a persistent query by example",
197
+ description="Create a new persistent query by example",
198
+ request=PersistentQueryExampleSerializer,
199
+ responses={
200
+ 201: PersistentQueryExampleSerializer,
201
+ 400: OpenApiResponse(description="Validation error"),
202
+ 500: OpenApiResponse(description="Internal server error"),
203
+ },
204
+ examples=[
205
+ OpenApiExample(
206
+ "Create a persistent query by example",
207
+ summary="Create a new persistent query by example",
208
+ description="Create a new persistent query by example with the provided parameters",
209
+ request_only=True,
210
+ value={
211
+ "content": "{}",
212
+ "templates": ["123"],
213
+ "name": "persistent_query_example",
214
+ },
215
+ ),
216
+ ],
217
+ )
161
218
  def post(self, request):
162
- """Create a new persistent query example
163
-
219
+ """Create a new persistent query by example
164
220
  Parameters:
165
-
166
221
  {
167
- "content": "{}",
168
- "templates": ["5ea99316d26ebc48e475c60a"],
169
- "name": "persistent_query_example"
222
+ "content": "{}",
223
+ "templates": ["123"],
224
+ "name": "persistent_query_example"
170
225
  }
171
-
172
226
  Args:
173
-
174
227
  request: HTTP request
175
-
176
228
  Returns:
177
-
178
229
  - code: 201
179
230
  content: Created data
180
231
  - code: 400
@@ -182,21 +233,17 @@ class PersistentQueryExampleList(APIView):
182
233
  - code: 500
183
234
  content: Internal server error
184
235
  """
185
-
186
236
  try:
187
237
  # Build serializer
188
238
  serializer = self.serializer(
189
239
  data=request.data, context={"request": request}
190
240
  )
191
-
192
241
  # Validate data
193
242
  serializer.is_valid(raise_exception=True)
194
243
  # Save data
195
244
  serializer.save()
196
-
197
245
  # Return the serialized data
198
246
  return Response(serializer.data, status=status.HTTP_201_CREATED)
199
-
200
247
  except ValidationError as validation_exception:
201
248
  content = {"message": validation_exception.detail}
202
249
  return Response(content, status=status.HTTP_400_BAD_REQUEST)
@@ -207,23 +254,42 @@ class PersistentQueryExampleList(APIView):
207
254
  )
208
255
 
209
256
 
257
+ @extend_schema(
258
+ tags=["Persistent Query by Example"],
259
+ description="Persistent query by example detail",
260
+ )
210
261
  class PersistentQueryExampleDetail(APIView):
211
- """Persistent query example detail"""
262
+ """Persistent query by example detail"""
212
263
 
213
264
  permission_classes = (IsAuthenticated,)
214
265
  serializer = PersistentQueryExampleSerializer
215
266
 
267
+ @extend_schema(
268
+ summary="Retrieve a persistent query by example",
269
+ description="Retrieve a persistent query by example by ID",
270
+ parameters=[
271
+ OpenApiParameter(
272
+ name="id",
273
+ type=OpenApiTypes.STR,
274
+ location=OpenApiParameter.PATH,
275
+ description="Persistent Query by Example ID",
276
+ ),
277
+ ],
278
+ responses={
279
+ 200: PersistentQueryExampleSerializer,
280
+ 403: OpenApiResponse(description="Access Forbidden"),
281
+ 404: OpenApiResponse(description="Object was not found"),
282
+ 500: OpenApiResponse(description="Internal server error"),
283
+ },
284
+ )
216
285
  def get(self, request, pk):
217
- """Retrieve persistent query example from database
218
-
286
+ """Retrieve persistent query by example from database
219
287
  Args:
220
-
221
288
  request: HTTP request
222
289
  pk: ObjectId
223
-
224
290
  Returns:
225
291
  - code: 200
226
- content: persistent query example
292
+ content: persistent query by example
227
293
  - code: 403
228
294
  content: Forbidden
229
295
  - code: 404
@@ -236,13 +302,10 @@ class PersistentQueryExampleDetail(APIView):
236
302
  persistent_query_example = persistent_query_example_api.get_by_id(
237
303
  pk, request.user
238
304
  )
239
-
240
305
  # Serialize object
241
306
  serializer = self.serializer(persistent_query_example)
242
-
243
307
  # Return response
244
308
  return Response(serializer.data)
245
-
246
309
  except exceptions.DoesNotExist:
247
310
  content = {"message": "Object not found."}
248
311
  return Response(content, status=status.HTTP_404_NOT_FOUND)
@@ -255,20 +318,50 @@ class PersistentQueryExampleDetail(APIView):
255
318
  content, status=status.HTTP_500_INTERNAL_SERVER_ERROR
256
319
  )
257
320
 
321
+ @extend_schema(
322
+ summary="Update a persistent query by example",
323
+ description="Update a persistent query by example by ID",
324
+ parameters=[
325
+ OpenApiParameter(
326
+ name="id",
327
+ type=OpenApiTypes.STR,
328
+ location=OpenApiParameter.PATH,
329
+ description="Persistent Query by Example ID",
330
+ ),
331
+ ],
332
+ request=PersistentQueryExampleSerializer(partial=True),
333
+ responses={
334
+ 200: PersistentQueryExampleSerializer,
335
+ 400: OpenApiResponse(description="Validation error"),
336
+ 403: OpenApiResponse(description="Access Forbidden"),
337
+ 404: OpenApiResponse(description="Object was not found"),
338
+ 500: OpenApiResponse(description="Internal server error"),
339
+ },
340
+ examples=[
341
+ OpenApiExample(
342
+ "Update a persistent query by example",
343
+ summary="Update a persistent query by example",
344
+ description="Update a persistent query by example with the provided parameters",
345
+ request_only=True,
346
+ value={
347
+ "content": "{}",
348
+ "templates": ["123"],
349
+ "name": None,
350
+ },
351
+ ),
352
+ ],
353
+ )
258
354
  def patch(self, request, pk):
259
- """Update a persistent query example
260
-
355
+ """Update a persistent query by example
261
356
  Parameters:
262
357
  {
263
- "content": "{}",
264
- "templates": ["5ea99316d26ebc48e475c60a"],
265
- "name": null
358
+ "content": "{}",
359
+ "templates": ["123"],
360
+ "name": null
266
361
  }
267
-
268
362
  Args:
269
363
  request: HTTP request
270
364
  pk: ObjectId
271
-
272
365
  Returns:
273
366
  - code: 200
274
367
  content: Updated data
@@ -286,7 +379,6 @@ class PersistentQueryExampleDetail(APIView):
286
379
  persistent_query_example = persistent_query_example_api.get_by_id(
287
380
  pk, request.user
288
381
  )
289
-
290
382
  # Build serializer
291
383
  serializer = self.serializer(
292
384
  instance=persistent_query_example,
@@ -294,11 +386,9 @@ class PersistentQueryExampleDetail(APIView):
294
386
  partial=True,
295
387
  context={"request": request},
296
388
  )
297
-
298
- # Validate and save persistent query example
389
+ # Validate and save persistent query by example
299
390
  serializer.is_valid(raise_exception=True)
300
391
  serializer.save()
301
-
302
392
  return Response(serializer.data, status=status.HTTP_200_OK)
303
393
  except ValidationError as validation_exception:
304
394
  content = {"message": validation_exception.detail}
@@ -310,7 +400,7 @@ class PersistentQueryExampleDetail(APIView):
310
400
  content = {"message": str(exception)}
311
401
  return Response(content, status=status.HTTP_400_BAD_REQUEST)
312
402
  except exceptions.DoesNotExist:
313
- content = {"message": "Persistent query example not found."}
403
+ content = {"message": "Persistent query by example not found."}
314
404
  return Response(content, status=status.HTTP_404_NOT_FOUND)
315
405
  except Exception as api_exception:
316
406
  content = {"message": str(api_exception)}
@@ -318,13 +408,29 @@ class PersistentQueryExampleDetail(APIView):
318
408
  content, status=status.HTTP_500_INTERNAL_SERVER_ERROR
319
409
  )
320
410
 
411
+ @extend_schema(
412
+ summary="Delete a persistent query by example",
413
+ description="Delete a persistent query by example by ID",
414
+ parameters=[
415
+ OpenApiParameter(
416
+ name="id",
417
+ type=OpenApiTypes.STR,
418
+ location=OpenApiParameter.PATH,
419
+ description="Persistent Query by Example ID",
420
+ ),
421
+ ],
422
+ responses={
423
+ 204: None,
424
+ 403: OpenApiResponse(description="Access Forbidden"),
425
+ 404: OpenApiResponse(description="Object was not found"),
426
+ 500: OpenApiResponse(description="Internal server error"),
427
+ },
428
+ )
321
429
  def delete(self, request, pk):
322
- """Delete a persistent query example
323
-
430
+ """Delete a persistent query by example
324
431
  Args:
325
432
  request: HTTP request
326
433
  pk: ObjectId
327
-
328
434
  Returns:
329
435
  - code: 204
330
436
  content: Deletion success
@@ -340,19 +446,17 @@ class PersistentQueryExampleDetail(APIView):
340
446
  persistent_query_example = persistent_query_example_api.get_by_id(
341
447
  pk, request.user
342
448
  )
343
-
344
449
  # delete object
345
450
  persistent_query_example_api.delete(
346
451
  persistent_query_example, request.user
347
452
  )
348
-
349
453
  # Return response
350
454
  return Response(status=status.HTTP_204_NO_CONTENT)
351
455
  except AccessControlError as exception:
352
456
  content = {"message": str(exception)}
353
457
  return Response(content, status=status.HTTP_403_FORBIDDEN)
354
458
  except exceptions.DoesNotExist:
355
- content = {"message": "Persistent query example not found."}
459
+ content = {"message": "Persistent query by example not found."}
356
460
  return Response(content, status=status.HTTP_404_NOT_FOUND)
357
461
  except Exception as api_exception:
358
462
  content = {"message": str(api_exception)}
@@ -361,23 +465,42 @@ class PersistentQueryExampleDetail(APIView):
361
465
  )
362
466
 
363
467
 
468
+ @extend_schema(
469
+ tags=["Persistent Query by Example"],
470
+ description="Persistent query by example detail by name",
471
+ )
364
472
  class PersistentQueryExampleByName(APIView):
365
- """Persistent query example detail"""
473
+ """Persistent query by example detail"""
366
474
 
367
475
  permission_classes = (IsAuthenticated,)
368
476
  serializer = PersistentQueryExampleSerializer
369
477
 
478
+ @extend_schema(
479
+ summary="Retrieve a persistent query by example by name",
480
+ description="Retrieve a persistent query by example by its name",
481
+ parameters=[
482
+ OpenApiParameter(
483
+ name="name",
484
+ type=OpenApiTypes.STR,
485
+ location=OpenApiParameter.PATH,
486
+ description="Persistent Query by Example name",
487
+ ),
488
+ ],
489
+ responses={
490
+ 200: PersistentQueryExampleSerializer,
491
+ 403: OpenApiResponse(description="Access Forbidden"),
492
+ 404: OpenApiResponse(description="Object was not found"),
493
+ 500: OpenApiResponse(description="Internal server error"),
494
+ },
495
+ )
370
496
  def get(self, request, name):
371
- """Retrieve persistent query example from database
372
-
497
+ """Retrieve persistent query by example from database
373
498
  Args:
374
-
375
499
  request: HTTP request
376
500
  name: name
377
-
378
501
  Returns:
379
502
  - code: 200
380
- content: persistent query example
503
+ content: persistent query by example
381
504
  - code: 403
382
505
  content: Forbidden
383
506
  - code: 404
@@ -390,14 +513,12 @@ class PersistentQueryExampleByName(APIView):
390
513
  persistent_query_example = (
391
514
  persistent_query_example_api.get_by_name(name, request.user)
392
515
  )
393
-
394
516
  # Serialize object
395
517
  serializer = self.serializer(persistent_query_example)
396
-
397
518
  # Return response
398
519
  return Response(serializer.data)
399
520
  except exceptions.DoesNotExist:
400
- content = {"message": "Persistent query example not found."}
521
+ content = {"message": "Persistent query by example not found."}
401
522
  return Response(content, status=status.HTTP_404_NOT_FOUND)
402
523
  except AccessControlError as exception:
403
524
  content = {"message": str(exception)}