Adds endpoint for fetching valid enum choices (#486)

Better-HPC · Nov 14, 2024 · 85a549b · 85a549b
1 parent 8695d43
commit 85a549b
Show file tree

Hide file tree

Showing 17 changed files with 423 additions and 118 deletions.
diff --git a/docs/api.yml b/docs/api.yml
@@ -4,6 +4,43 @@ info:
   version: 0.0.0
   description: A REST API for managing user resource allocations on HPC systems.
 paths:
+  /allocations/allocation-request/status-choices/:
+    get:
+      operationId: allocations_allocation_request_status_choices_retrieve
+      description: Return valid values for the allocation review `status` field.
+      tags:
+      - allocations
+      security:
+      - cookieAuth: []
+      - basicAuth: []
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                PD: Pending
+                AP: Approved
+                DC: Declined
+                CR: Changes Requested
+          description: ''
+  /allocations/allocation-review/status-choices/:
+    get:
+      operationId: allocations_allocation_review_status_choices_retrieve
+      description: Return valid values for the allocation review `status` field.
+      tags:
+      - allocations
+      security:
+      - cookieAuth: []
+      - basicAuth: []
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                AP: Approved
+                DC: Declined
+                CR: Changes Requested
+          description: ''
   /allocations/allocations/:
     get:
       operationId: allocations_allocations_list
@@ -1636,24 +1673,24 @@ paths:
               schema:
                 type: array
                 items:
-                  $ref: '#/components/schemas/AllocationRequestReview'
+                  $ref: '#/components/schemas/AllocationReview'
           description: ''
     post:
       operationId: allocations_reviews_create
-      description: Create a new `AllocationRequestReview` object.
+      description: Create a new `AllocationReview` object.
       tags:
       - allocations
       requestBody:
         content:
           application/json:
             schema:
-              $ref: '#/components/schemas/AllocationRequestReview'
+              $ref: '#/components/schemas/AllocationReview'
           application/x-www-form-urlencoded:
             schema:
-              $ref: '#/components/schemas/AllocationRequestReview'
+              $ref: '#/components/schemas/AllocationReview'
           multipart/form-data:
             schema:
-              $ref: '#/components/schemas/AllocationRequestReview'
+              $ref: '#/components/schemas/AllocationReview'
         required: true
       security:
       - cookieAuth: []
@@ -1663,7 +1700,7 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/AllocationRequestReview'
+                $ref: '#/components/schemas/AllocationReview'
           description: ''
   /allocations/reviews/{id}/:
     get:
@@ -1674,7 +1711,7 @@ paths:
         name: id
         schema:
           type: integer
-        description: A unique integer value identifying this allocation request review.
+        description: A unique integer value identifying this allocation review.
         required: true
       tags:
       - allocations
@@ -1686,7 +1723,7 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/AllocationRequestReview'
+                $ref: '#/components/schemas/AllocationReview'
           description: ''
     put:
       operationId: allocations_reviews_update
@@ -1696,21 +1733,21 @@ paths:
         name: id
         schema:
           type: integer
-        description: A unique integer value identifying this allocation request review.
+        description: A unique integer value identifying this allocation review.
         required: true
       tags:
       - allocations
       requestBody:
         content:
           application/json:
             schema:
-              $ref: '#/components/schemas/AllocationRequestReview'
+              $ref: '#/components/schemas/AllocationReview'
           application/x-www-form-urlencoded:
             schema:
-              $ref: '#/components/schemas/AllocationRequestReview'
+              $ref: '#/components/schemas/AllocationReview'
           multipart/form-data:
             schema:
-              $ref: '#/components/schemas/AllocationRequestReview'
+              $ref: '#/components/schemas/AllocationReview'
         required: true
       security:
       - cookieAuth: []
@@ -1720,7 +1757,7 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/AllocationRequestReview'
+                $ref: '#/components/schemas/AllocationReview'
           description: ''
     patch:
       operationId: allocations_reviews_partial_update
@@ -1730,21 +1767,21 @@ paths:
         name: id
         schema:
           type: integer
-        description: A unique integer value identifying this allocation request review.
+        description: A unique integer value identifying this allocation review.
         required: true
       tags:
       - allocations
       requestBody:
         content:
           application/json:
             schema:
-              $ref: '#/components/schemas/PatchedAllocationRequestReview'
+              $ref: '#/components/schemas/PatchedAllocationReview'
           application/x-www-form-urlencoded:
             schema:
-              $ref: '#/components/schemas/PatchedAllocationRequestReview'
+              $ref: '#/components/schemas/PatchedAllocationReview'
           multipart/form-data:
             schema:
-              $ref: '#/components/schemas/PatchedAllocationRequestReview'
+              $ref: '#/components/schemas/PatchedAllocationReview'
       security:
       - cookieAuth: []
       - basicAuth: []
@@ -1753,7 +1790,7 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/AllocationRequestReview'
+                $ref: '#/components/schemas/AllocationReview'
           description: ''
     delete:
       operationId: allocations_reviews_destroy
@@ -1763,7 +1800,7 @@ paths:
         name: id
         schema:
           type: integer
-        description: A unique integer value identifying this allocation request review.
+        description: A unique integer value identifying this allocation review.
         required: true
       tags:
       - allocations
@@ -4318,6 +4355,24 @@ paths:
       responses:
         '204':
           description: No response body
+  /users/team-membership/role-choices/:
+    get:
+      operationId: users_team_membership_role_choices_retrieve
+      description: Return valid values for the team membership `role` field.
+      tags:
+      - users
+      security:
+      - cookieAuth: []
+      - basicAuth: []
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                OW: Owner
+                AD: Admin
+                MB: Member
+          description: ''
   /users/teams/:
     get:
       operationId: users_teams_list
@@ -5240,15 +5295,27 @@ components:
       - submitted
       - team
       - title
-    AllocationRequestReview:
+    AllocationRequestStatusEnum:
+      enum:
+      - PD
+      - AP
+      - DC
+      - CR
+      type: string
+      description: |-
+        * `PD` - Pending
+        * `AP` - Approved
+        * `DC` - Declined
+        * `CR` - Changes Requested
+    AllocationReview:
       type: object
-      description: Object serializer for the `AllocationRequestReview` class.
+      description: Object serializer for the `AllocationReview` class.
       properties:
         id:
           type: integer
           readOnly: true
         status:
-          $ref: '#/components/schemas/AllocationRequestReviewStatusEnum'
+          $ref: '#/components/schemas/AllocationReviewStatusEnum'
         public_comments:
           type: string
           nullable: true
@@ -5271,7 +5338,7 @@ components:
       - last_modified
       - request
       - status
-    AllocationRequestReviewStatusEnum:
+    AllocationReviewStatusEnum:
       enum:
       - AP
       - DC
@@ -5281,18 +5348,6 @@ components:
         * `AP` - Approved
         * `DC` - Declined
         * `CR` - Changes Requested
-    AllocationRequestStatusEnum:
-      enum:
-      - PD
-      - AP
-      - DC
-      - CR
-      type: string
-      description: |-
-        * `PD` - Pending
-        * `AP` - Approved
-        * `DC` - Declined
-        * `CR` - Changes Requested
     AppLog:
       type: object
       description: Object serializer for the `AppLog` class.
@@ -5506,15 +5561,15 @@ components:
           type: array
           items:
             type: integer
-    PatchedAllocationRequestReview:
+    PatchedAllocationReview:
       type: object
-      description: Object serializer for the `AllocationRequestReview` class.
+      description: Object serializer for the `AllocationReview` class.
       properties:
         id:
           type: integer
           readOnly: true
         status:
-          $ref: '#/components/schemas/AllocationRequestReviewStatusEnum'
+          $ref: '#/components/schemas/AllocationReviewStatusEnum'
         public_comments:
           type: string
           nullable: true

diff --git a/keystone_api/apps/allocations/admin.py b/keystone_api/apps/allocations/admin.py
@@ -30,10 +30,10 @@ class AllocationInline(admin.TabularInline):
     extra = 1
 
 
-class AllocationRequestReviewInline(admin.StackedInline):
-    """Inline admin interface for the `AllocationRequestReview` model."""
+class AllocationReviewInline(admin.StackedInline):
+    """Inline admin interface for the `AllocationReview` model."""
 
-    model = AllocationRequestReview
+    model = AllocationReview
     verbose_name = 'Review'
     show_change_link = True
     readonly_fields = ('last_modified',)
@@ -110,7 +110,7 @@ def team(obj: Allocation) -> str:
     def reviews(obj: AllocationRequest) -> int:
         """Return the total number of submitted reviews."""
 
-        return sum(1 for _ in obj.allocationrequestreview_set.all())
+        return sum(1 for _ in obj.allocationreview_set.all())
 
     team.admin_order_field = 'team__name'
 
@@ -124,7 +124,7 @@ def reviews(obj: AllocationRequest) -> int:
         ('expire', admin.DateFieldListFilter),
         ('status', admin.ChoicesFieldListFilter),
     ]
-    inlines = [AllocationInline, AllocationRequestReviewInline, AttachmentInline]
+    inlines = [AllocationInline, AllocationReviewInline, AttachmentInline]
 
 
 @admin.register(Cluster)

diff --git a/...e_api/apps/allocations/migrations/0011_rename_allocationrequestreview_allocationreview.py b/...e_api/apps/allocations/migrations/0011_rename_allocationrequestreview_allocationreview.py
@@ -0,0 +1,19 @@
+# Generated by Django 5.1.2 on 2024-11-13 17:36
+
+from django.conf import settings
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('allocations', '0010_rename_file_data_attachment_path'),
+        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
+    ]
+
+    operations = [
+        migrations.RenameModel(
+            old_name='AllocationRequestReview',
+            new_name='AllocationReview',
+        ),
+    ]
diff --git a/keystone_api/apps/allocations/models.py b/keystone_api/apps/allocations/models.py
@@ -21,7 +21,7 @@
 __all__ = [
     'Allocation',
     'AllocationRequest',
-    'AllocationRequestReview',
+    'AllocationReview',
     'Attachment',
     'Cluster',
     'TeamModelInterface',
@@ -107,7 +107,7 @@ def __str__(self) -> str:  # pragma: nocover
         return truncatechars(self.title, 100)
 
 
-class AllocationRequestReview(TeamModelInterface, models.Model):
+class AllocationReview(TeamModelInterface, models.Model):
     """Reviewer feedback for an allocation request."""
 
     class StatusChoices(models.TextChoices):

diff --git a/keystone_api/apps/allocations/serializers.py b/keystone_api/apps/allocations/serializers.py
@@ -15,7 +15,7 @@
     'AttachmentSerializer',
     'AllocationSerializer',
     'AllocationRequestSerializer',
-    'AllocationRequestReviewSerializer',
+    'AllocationReviewSerializer',
     'ClusterSerializer',
 ]
 
@@ -52,13 +52,13 @@ class Meta:
         fields = '__all__'
 
 
-class AllocationRequestReviewSerializer(serializers.ModelSerializer):
-    """Object serializer for the `AllocationRequestReview` class."""
+class AllocationReviewSerializer(serializers.ModelSerializer):
+    """Object serializer for the `AllocationReview` class."""
 
     class Meta:
         """Serializer settings."""
 
-        model = AllocationRequestReview
+        model = AllocationReview
         fields = '__all__'
         extra_kwargs = {'reviewer': {'required': False}}  # Default reviewer value is set by the view class