Document /api/v2/roles/templates (#2864)

Co-authored-by: ci.datadog-api-spec <[email protected]>

Author: api-clients-generation-pipeline[bot]

.generator/schemas/v2/openapi.yaml

@@ -38435,6 +38435,49 @@ components:
         permissions:
           $ref: '#/components/schemas/RelationshipToPermissions'
       type: object
+    RoleTemplateArray:
+      description: The definition of `RoleTemplateArray` object.
+      properties:
+        data:
+          description: The `RoleTemplateArray` `data`.
+          items:
+            $ref: '#/components/schemas/RoleTemplateData'
+          type: array
+      required:
+      - data
+      type: object
+    RoleTemplateData:
+      description: The definition of `RoleTemplateData` object.
+      properties:
+        attributes:
+          $ref: '#/components/schemas/RoleTemplateDataAttributes'
+        id:
+          description: The `RoleTemplateData` `id`.
+          type: string
+        type:
+          $ref: '#/components/schemas/RoleTemplateDataType'
+      required:
+      - type
+      type: object
+    RoleTemplateDataAttributes:
+      description: The definition of `RoleTemplateDataAttributes` object.
+      properties:
+        description:
+          description: The `attributes` `description`.
+          type: string
+        name:
+          description: The `attributes` `name`.
+          type: string
+      type: object
+    RoleTemplateDataType:
+      default: roles
+      description: Roles resource type.
+      enum:
+      - roles
+      example: roles
+      type: string
+      x-enum-varnames:
+      - ROLES
     RoleUpdateAttributes:
       description: Attributes of the role.
       properties:
@@ -67658,6 +67701,28 @@ paths:
         operator: OR
         permissions:
         - user_access_manage
+  /api/v2/roles/templates:
+    get:
+      description: List all role templates
+      operationId: ListRoleTemplates
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/RoleTemplateArray'
+          description: OK
+        '429':
+          $ref: '#/components/responses/TooManyRequestsResponse'
+      security:
+      - apiKeyAuth: []
+        appKeyAuth: []
+      - AuthZ:
+        - user_access_read
+      summary: List role templates
+      tags:
+      - Roles
+      x-unstable: '**Note**: This endpoint may be subject to changes.'
   /api/v2/roles/{role_id}:
     delete:
       description: Disables a role.

features/v2/roles.feature

@@ -216,6 +216,13 @@ Feature: Roles
     And the response "data" has item with field "attributes.restricted" with value false
     And the response "data" has item with field "attributes.name" with value "admin"
 
+  @generated @skip @team:DataDog/aaa-core-access
+  Scenario: List role templates returns "OK" response
+    Given operation "ListRoleTemplates" enabled
+    And new "ListRoleTemplates" request
+    When the request is sent
+    Then the response status is 200 OK
+
   @team:DataDog/aaa-core-access
   Scenario: List roles returns "OK" response
     Given there is a valid "role" in the system

features/v2/undo.json

@@ -2869,6 +2869,12 @@
       "type": "unsafe"
     }
   },
+  "ListRoleTemplates": {
+    "tag": "Roles",
+    "undo": {
+      "type": "safe"
+    }
+  },
   "DeleteRole": {
     "tag": "Roles",
     "undo": {

private/bdd_runner/src/support/scenarios_model_mapping.ts

@@ -7054,6 +7054,9 @@ export const ScenariosModelMappings: { [key: string]: OperationMapping } = {
     },
     operationResponseType: "RoleCreateResponse",
   },
+  "RolesApi.V2.ListRoleTemplates": {
+    operationResponseType: "RoleTemplateArray",
+  },
   "RolesApi.V2.GetRole": {
     roleId: {
       type: "string",

services/roles/src/v2/RolesApi.ts

@@ -32,6 +32,7 @@ import { RoleCreateResponse } from "./models/RoleCreateResponse";
 import { RoleResponse } from "./models/RoleResponse";
 import { RolesResponse } from "./models/RolesResponse";
 import { RolesSort } from "./models/RolesSort";
+import { RoleTemplateArray } from "./models/RoleTemplateArray";
 import { RoleUpdateRequest } from "./models/RoleUpdateRequest";
 import { RoleUpdateResponse } from "./models/RoleUpdateResponse";
 import { UsersResponse } from "./models/UsersResponse";
@@ -526,6 +527,48 @@ export class RolesApiRequestFactory extends BaseAPIRequestFactory {
     return requestContext;
   }
 
+  public async listRoleTemplates(
+    _options?: Configuration,
+  ): Promise<RequestContext> {
+    const _config = _options || this.configuration;
+
+    if (!_config.unstableOperations["RolesApi.v2.listRoleTemplates"]) {
+      throw new Error(
+        "Unstable operation 'listRoleTemplates' is disabled. Enable it by setting `configuration.unstableOperations['RolesApi.v2.listRoleTemplates'] = true`",
+      );
+    }
+
+    // Path Params
+    const localVarPath = "/api/v2/roles/templates";
+
+    // Make Request Context
+    const { server, overrides } = _config.getServerAndOverrides(
+      "RolesApi.v2.listRoleTemplates",
+      RolesApi.operationServers,
+    );
+    const requestContext = server.makeRequestContext(
+      localVarPath,
+      HttpMethod.GET,
+      overrides,
+    );
+    requestContext.setHeaderParam("Accept", "application/json");
+    requestContext.setHttpConfig(_config.httpConfig);
+
+    // Set User-Agent
+    if (this.userAgent) {
+      requestContext.setHeaderParam("User-Agent", this.userAgent);
+    }
+
+    // Apply auth methods
+    applySecurityAuthentication(_config, requestContext, [
+      "apiKeyAuth",
+      "appKeyAuth",
+      "AuthZ",
+    ]);
+
+    return requestContext;
+  }
+
   public async listRoleUsers(
     roleId: string,
     pageSize?: number,
@@ -1308,6 +1351,62 @@ export class RolesApiResponseProcessor {
     );
   }
 
+  /**
+   * Unwraps the actual response sent by the server from the response context and deserializes the response content
+   * to the expected objects
+   *
+   * @params response Response returned by the server for a request to listRoleTemplates
+   * @throws ApiException if the response code was not in [200, 299]
+   */
+  public async listRoleTemplates(
+    response: ResponseContext,
+  ): Promise<RoleTemplateArray> {
+    const contentType = normalizeMediaType(response.headers["content-type"]);
+    if (response.httpStatusCode === 200) {
+      const body: RoleTemplateArray = deserialize(
+        parse(await response.body.text(), contentType),
+        TypingInfo,
+        "RoleTemplateArray",
+      ) as RoleTemplateArray;
+      return body;
+    }
+    if (response.httpStatusCode === 429) {
+      const bodyText = parse(await response.body.text(), contentType);
+      let body: APIErrorResponse;
+      try {
+        body = deserialize(
+          bodyText,
+          TypingInfo,
+          "APIErrorResponse",
+        ) as APIErrorResponse;
+      } catch (error) {
+        logger.debug(`Got error deserializing error: ${error}`);
+        throw new ApiException<APIErrorResponse>(
+          response.httpStatusCode,
+          bodyText,
+        );
+      }
+      throw new ApiException<APIErrorResponse>(response.httpStatusCode, body);
+    }
+
+    // Work around for missing responses in specification, e.g. for petstore.yaml
+    if (response.httpStatusCode >= 200 && response.httpStatusCode <= 299) {
+      const body: RoleTemplateArray = deserialize(
+        parse(await response.body.text(), contentType),
+        TypingInfo,
+        "RoleTemplateArray",
+        "",
+      ) as RoleTemplateArray;
+      return body;
+    }
+
+    const body = (await response.body.text()) || "";
+    throw new ApiException<string>(
+      response.httpStatusCode,
+      'Unknown API Status Code!\nBody: "' + body + '"',
+    );
+  }
+
   /**
    * Unwraps the actual response sent by the server from the response context and deserializes the response content
    * to the expected objects
@@ -1927,6 +2026,24 @@ export class RolesApi {
     });
   }
 
+  /**
+   * List all role templates
+   * @param param The request object
+   */
+  public listRoleTemplates(
+    options?: Configuration,
+  ): Promise<RoleTemplateArray> {
+    const requestContextPromise =
+      this.requestFactory.listRoleTemplates(options);
+    return requestContextPromise.then((requestContext) => {
+      return this.configuration.httpApi
+        .send(requestContext)
+        .then((responseContext) => {
+          return this.responseProcessor.listRoleTemplates(responseContext);
+        });
+    });
+  }
+
   /**
    * Gets all users of a role.
    * @param param The request object

services/roles/src/v2/index.ts

@@ -51,6 +51,10 @@ export { RoleResponseRelationships } from "./models/RoleResponseRelationships";
 export { RolesResponse } from "./models/RolesResponse";
 export { RolesSort } from "./models/RolesSort";
 export { RolesType } from "./models/RolesType";
+export { RoleTemplateArray } from "./models/RoleTemplateArray";
+export { RoleTemplateData } from "./models/RoleTemplateData";
+export { RoleTemplateDataAttributes } from "./models/RoleTemplateDataAttributes";
+export { RoleTemplateDataType } from "./models/RoleTemplateDataType";
 export { RoleUpdateAttributes } from "./models/RoleUpdateAttributes";
 export { RoleUpdateData } from "./models/RoleUpdateData";
 export { RoleUpdateRequest } from "./models/RoleUpdateRequest";

services/roles/src/v2/models/RoleTemplateArray.ts

@@ -0,0 +1,47 @@
+import { AttributeTypeMap } from "@datadog/datadog-api-client";
+
+import { RoleTemplateData } from "./RoleTemplateData";
+
+/**
+ * The definition of `RoleTemplateArray` object.
+ */
+export class RoleTemplateArray {
+  /**
+   * The `RoleTemplateArray` `data`.
+   */
+  "data": Array<RoleTemplateData>;
+  /**
+   * A container for additional, undeclared properties.
+   * This is a holder for any undeclared properties as specified with
+   * the 'additionalProperties' keyword in the OAS document.
+   */
+  "additionalProperties"?: { [key: string]: any };
+  /**
+   * @ignore
+   */
+  "_unparsed"?: boolean;
+
+  /**
+   * @ignore
+   */
+  static readonly attributeTypeMap: AttributeTypeMap = {
+    data: {
+      baseName: "data",
+      type: "Array<RoleTemplateData>",
+      required: true,
+    },
+    additionalProperties: {
+      baseName: "additionalProperties",
+      type: "{ [key: string]: any; }",
+    },
+  };
+
+  /**
+   * @ignore
+   */
+  static getAttributeTypeMap(): AttributeTypeMap {
+    return RoleTemplateArray.attributeTypeMap;
+  }
+
+  public constructor() {}
+}

services/roles/src/v2/models/RoleTemplateData.ts

@@ -0,0 +1,64 @@
+import { AttributeTypeMap } from "@datadog/datadog-api-client";
+
+import { RoleTemplateDataAttributes } from "./RoleTemplateDataAttributes";
+import { RoleTemplateDataType } from "./RoleTemplateDataType";
+
+/**
+ * The definition of `RoleTemplateData` object.
+ */
+export class RoleTemplateData {
+  /**
+   * The definition of `RoleTemplateDataAttributes` object.
+   */
+  "attributes"?: RoleTemplateDataAttributes;
+  /**
+   * The `RoleTemplateData` `id`.
+   */
+  "id"?: string;
+  /**
+   * Roles resource type.
+   */
+  "type": RoleTemplateDataType;
+  /**
+   * A container for additional, undeclared properties.
+   * This is a holder for any undeclared properties as specified with
+   * the 'additionalProperties' keyword in the OAS document.
+   */
+  "additionalProperties"?: { [key: string]: any };
+  /**
+   * @ignore
+   */
+  "_unparsed"?: boolean;
+
+  /**
+   * @ignore
+   */
+  static readonly attributeTypeMap: AttributeTypeMap = {
+    attributes: {
+      baseName: "attributes",
+      type: "RoleTemplateDataAttributes",
+    },
+    id: {
+      baseName: "id",
+      type: "string",
+    },
+    type: {
+      baseName: "type",
+      type: "RoleTemplateDataType",
+      required: true,
+    },
+    additionalProperties: {
+      baseName: "additionalProperties",
+      type: "{ [key: string]: any; }",
+    },
+  };
+
+  /**
+   * @ignore
+   */
+  static getAttributeTypeMap(): AttributeTypeMap {
+    return RoleTemplateData.attributeTypeMap;
+  }
+
+  public constructor() {}
+}