Merge pull request #596 from meshery/org-team-hard-delete-endpoint

OpenAPI: org team soft-delete via POST action payload

Author: leecalcote

schemas/constructs/v1beta1/organization/api.yml

@@ -28,7 +28,77 @@ paths:
         "500":
           description: Internal server error
 
+  /api/identity/orgs/{orgID}/teams/{teamId}:
+    post:
+      summary: Add team to organization or soft delete team
+      description: Adds a team to an organization. If request body contains action=delete, tombstones a team by setting its deleted_at timestamp. The team's organization mapping remains intact.
+      operationId: AddTeamToOrg
+      parameters:
+        - $ref: "#/components/parameters/orgID"
+        - $ref: "#/components/parameters/teamId"
+      requestBody:
+        required: false
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/OrgTeamActionPayload"
+      responses:
+        "200":
+          description: Team added to organization or team tombstoned
+          content:
+            application/json:
+              schema:
+                oneOf:
+                  - $ref: "#/components/schemas/TeamsOrganizationsMappingPage"
+                  - $ref: "#/components/schemas/TeamsPage"
+        "400":
+          description: Bad request
+        "401":
+          description: Unauthorized
+        "404":
+          description: Not found
+        "500":
+          description: Internal server error
+
+    delete:
+      summary: Remove team from organization
+      description: Removes (unassigns) a team from an organization.
+      operationId: RemoveTeamFromOrg
+      parameters:
+        - $ref: "#/components/parameters/orgID"
+        - $ref: "#/components/parameters/teamId"
+      responses:
+        "200":
+          description: Team removed from organization
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/TeamsOrganizationsMappingPage"
+        "400":
+          description: Bad request
+        "401":
+          description: Unauthorized
+        "404":
+          description: Not found
+        "500":
+          description: Internal server error
+
 components:
+  parameters:
+    orgID:
+      name: orgID
+      in: path
+      required: true
+      schema:
+        $ref: "../../v1alpha1/core/api.yml#/components/schemas/organization_id"
+
+    teamId:
+      name: teamId
+      in: path
+      required: true
+      schema:
+        $ref: "../../v1alpha1/core/api.yml#/components/schemas/team_id"
+
   schemas:
     UUID:
       $ref: "../../v1alpha1/core/api.yml#/components/schemas/uuid"
@@ -39,6 +109,22 @@ components:
     Time:
       $ref: "../../v1alpha1/core/api.yml#/components/schemas/Time"
 
+    Text:
+      $ref: "../../v1alpha1/core/api.yml#/components/schemas/Text"
+
+    MapObject:
+      $ref: "../../v1alpha1/core/api.yml#/components/schemas/MapObject"
+
+    OrgTeamActionPayload:
+      type: object
+      description: Optional action payload for POST on /api/identity/orgs/{orgID}/teams/{teamId}.
+      properties:
+        action:
+          type: string
+          description: Internal action to perform on the team resource.
+          enum:
+            - delete
+
     Location:
       type: object
       required:
@@ -172,3 +258,67 @@ components:
           nullable: true
           x-oapi-codegen-extra-tags:
             db: "domain"
+
+    AvailableTeam:
+      type: object
+      properties:
+        ID:
+          $ref: "../../v1alpha1/core/api.yml#/components/schemas/general_id"
+        name:
+          $ref: "#/components/schemas/Text"
+        description:
+          $ref: "#/components/schemas/Text"
+        owner:
+          $ref: "#/components/schemas/Text"
+        metadata:
+          $ref: "#/components/schemas/MapObject"
+        created_at:
+          $ref: "#/components/schemas/Time"
+        updated_at:
+          $ref: "#/components/schemas/Time"
+        deleted_at:
+          $ref: "#/components/schemas/NullableTime"
+
+    TeamsPage:
+      type: object
+      properties:
+        page:
+          type: integer
+        page_size:
+          type: integer
+        total_count:
+          type: integer
+        teams:
+          type: array
+          items:
+            $ref: "#/components/schemas/AvailableTeam"
+
+    TeamsOrganizationsMapping:
+      type: object
+      properties:
+        ID:
+          $ref: "../../v1alpha1/core/api.yml#/components/schemas/general_id"
+        org_id:
+          $ref: "../../v1alpha1/core/api.yml#/components/schemas/organization_id"
+        team_id:
+          $ref: "../../v1alpha1/core/api.yml#/components/schemas/team_id"
+        created_at:
+          $ref: "#/components/schemas/Time"
+        updated_at:
+          $ref: "#/components/schemas/Time"
+        deleted_at:
+          $ref: "#/components/schemas/NullableTime"
+
+    TeamsOrganizationsMappingPage:
+      type: object
+      properties:
+        page:
+          type: integer
+        page_size:
+          type: integer
+        total_count:
+          type: integer
+        teams_organizations_mapping:
+          type: array
+          items:
+            $ref: "#/components/schemas/TeamsOrganizationsMapping"