Refactor organization API and user organization details

reportportal · Sep 30, 2024 · 8533aaa · 8533aaa
1 parent 070563d
commit 8533aaa
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 14 deletions.
diff --git a/api/openapi/apis/organizations.yaml b/api/openapi/apis/organizations.yaml
@@ -748,7 +748,7 @@ paths:
           application/json:
             schema:
               $ref: ../models/SearchCriteriaRQ.yaml
-        description: ''
+        description: 'Provide search criteria for organizations.'
       tags:
         - Organization
         - Ready for implementation
@@ -843,24 +843,15 @@ components:
       type: object
       properties:
         name:
-          type: string
-          description: Organization display name.
-          minLength: 3
-          maxLength: 60
-          pattern: '^[A-Za-z0-9._\- ]+$'
+          $ref: ../types/name.yaml
         slug:
-          type: string
-          pattern: '^[a-z0-9]+(?:-[a-z0-9]+)*$'
-          minLength: 3
-          maxLength: 60
-          description: 'A slug is used to identify a resource. It should be unique and contain only lowercase letters, numbers, and hyphens. It should not start or end with a hyphen.'
-          nullable: true
+          $ref: ../types/slug.yaml
       required:
         - name
     OrganizationStats:
       title: Organization statistics
       type: object
-      description: ''
+      description: 'General information about the organization.'
       properties:
         relationships:
           type: object

diff --git a/api/openapi/apis/users.yaml b/api/openapi/apis/users.yaml
@@ -816,7 +816,7 @@ components:
             organizations:
               type: array
               items:
-                $ref: ../models/user/UserOrgInfo.yaml
+                $ref: '#/components/schemas/InstanceUserOrgDetails'
     InstanceUserStats:
       title: Instance User statistics
       type: object
@@ -827,6 +827,15 @@ components:
             total_count:
               type: integer
               description: Total number of user's organisations
+    InstanceUserOrgDetails:
+      title: Instance User organization details
+      description: User's organization details.
+      allOf:
+        - type: object
+          properties:
+            name:
+              $ref: ../types/name.yaml
+        - $ref: ../models/user/UserOrgInfo.yaml
     InstanceUserPage:
       title: Instance User page
       allOf: