From 84a1fddd7d651efb35958bfed2fbb997d7869ff9 Mon Sep 17 00:00:00 2001
From: Slobodan Adamovic <slobodan.adamovic@elastic.co>
Date: Mon, 16 Dec 2024 21:40:24 +0100
Subject: [PATCH] Make query roles API public in Serverless

---
 .../elasticsearch-serverless-openapi.json     | 188 ++++++++
 output/schema/schema-serverless.json          | 447 ++++++++++++++++++
 output/schema/schema.json                     |   2 +-
 .../security/query_role/QueryRolesRequest.ts  |   2 +-
 4 files changed, 637 insertions(+), 2 deletions(-)

diff --git a/output/openapi/elasticsearch-serverless-openapi.json b/output/openapi/elasticsearch-serverless-openapi.json
index 7e639ab6c6..a30dc8511f 100644
--- a/output/openapi/elasticsearch-serverless-openapi.json
+++ b/output/openapi/elasticsearch-serverless-openapi.json
@@ -17469,6 +17469,42 @@
         "x-state": "Added in 7.15.0"
       }
     },
+    "/_security/_query/role": {
+      "get": {
+        "tags": [
+          "security"
+        ],
+        "summary": "Find roles with a query",
+        "description": "Get roles in a paginated manner. You can optionally filter the results with a query.",
+        "operationId": "security-query-role",
+        "requestBody": {
+          "$ref": "#/components/requestBodies/security.query_role"
+        },
+        "responses": {
+          "200": {
+            "$ref": "#/components/responses/security.query_role#200"
+          }
+        },
+        "x-state": "Added in 8.15.0"
+      },
+      "post": {
+        "tags": [
+          "security"
+        ],
+        "summary": "Find roles with a query",
+        "description": "Get roles in a paginated manner. You can optionally filter the results with a query.",
+        "operationId": "security-query-role-1",
+        "requestBody": {
+          "$ref": "#/components/requestBodies/security.query_role"
+        },
+        "responses": {
+          "200": {
+            "$ref": "#/components/responses/security.query_role#200"
+          }
+        },
+        "x-state": "Added in 8.15.0"
+      }
+    },
     "/_security/api_key/{id}": {
       "put": {
         "tags": [
@@ -54778,6 +54814,98 @@
           }
         ]
       },
+      "security.query_role:RoleQueryContainer": {
+        "type": "object",
+        "properties": {
+          "bool": {
+            "$ref": "#/components/schemas/_types.query_dsl:BoolQuery"
+          },
+          "exists": {
+            "$ref": "#/components/schemas/_types.query_dsl:ExistsQuery"
+          },
+          "ids": {
+            "$ref": "#/components/schemas/_types.query_dsl:IdsQuery"
+          },
+          "match": {
+            "description": "Returns roles that match a provided text, number, date or boolean value.\nThe provided text is analyzed before matching.",
+            "type": "object",
+            "additionalProperties": {
+              "$ref": "#/components/schemas/_types.query_dsl:MatchQuery"
+            },
+            "minProperties": 1,
+            "maxProperties": 1
+          },
+          "match_all": {
+            "$ref": "#/components/schemas/_types.query_dsl:MatchAllQuery"
+          },
+          "prefix": {
+            "description": "Returns roles that contain a specific prefix in a provided field.",
+            "type": "object",
+            "additionalProperties": {
+              "$ref": "#/components/schemas/_types.query_dsl:PrefixQuery"
+            },
+            "minProperties": 1,
+            "maxProperties": 1
+          },
+          "range": {
+            "description": "Returns roles that contain terms within a provided range.",
+            "type": "object",
+            "additionalProperties": {
+              "$ref": "#/components/schemas/_types.query_dsl:RangeQuery"
+            },
+            "minProperties": 1,
+            "maxProperties": 1
+          },
+          "simple_query_string": {
+            "$ref": "#/components/schemas/_types.query_dsl:SimpleQueryStringQuery"
+          },
+          "term": {
+            "description": "Returns roles that contain an exact term in a provided field.\nTo return a document, the query term must exactly match the queried field's value, including whitespace and capitalization.",
+            "type": "object",
+            "additionalProperties": {
+              "$ref": "#/components/schemas/_types.query_dsl:TermQuery"
+            },
+            "minProperties": 1,
+            "maxProperties": 1
+          },
+          "terms": {
+            "$ref": "#/components/schemas/_types.query_dsl:TermsQuery"
+          },
+          "wildcard": {
+            "description": "Returns roles that contain terms matching a wildcard pattern.",
+            "type": "object",
+            "additionalProperties": {
+              "$ref": "#/components/schemas/_types.query_dsl:WildcardQuery"
+            },
+            "minProperties": 1,
+            "maxProperties": 1
+          }
+        },
+        "minProperties": 1,
+        "maxProperties": 1
+      },
+      "security.query_role:QueryRole": {
+        "allOf": [
+          {
+            "$ref": "#/components/schemas/security._types:RoleDescriptor"
+          },
+          {
+            "type": "object",
+            "properties": {
+              "_sort": {
+                "$ref": "#/components/schemas/_types:SortResults"
+              },
+              "name": {
+                "description": "Name of the role.",
+                "type": "string"
+              }
+            },
+            "required": [
+              "name"
+            ]
+          }
+        ]
+      },
       "sql:Column": {
         "type": "object",
         "properties": {
@@ -56953,6 +57081,38 @@
           }
         }
       },
+      "security.query_role#200": {
+        "description": "",
+        "content": {
+          "application/json": {
+            "schema": {
+              "type": "object",
+              "properties": {
+                "total": {
+                  "description": "The total number of roles found.",
+                  "type": "number"
+                },
+                "count": {
+                  "description": "The number of roles returned in the response.",
+                  "type": "number"
+                },
+                "roles": {
+                  "description": "The list of roles.",
+                  "type": "array",
+                  "items": {
+                    "$ref": "#/components/schemas/security.query_role:QueryRole"
+                  }
+                }
+              },
+              "required": [
+                "total",
+                "count",
+                "roles"
+              ]
+            }
+          }
+        }
+      },
       "sql.query#200": {
         "description": "",
         "content": {
@@ -63860,6 +64020,34 @@
           }
         }
       },
+      "security.query_role": {
+        "content": {
+          "application/json": {
+            "schema": {
+              "type": "object",
+              "properties": {
+                "query": {
+                  "$ref": "#/components/schemas/security.query_role:RoleQueryContainer"
+                },
+                "from": {
+                  "description": "Starting document offset.\nBy default, you cannot page through more than 10,000 hits using the from and size parameters.\nTo page through more hits, use the `search_after` parameter.",
+                  "type": "number"
+                },
+                "sort": {
+                  "$ref": "#/components/schemas/_types:Sort"
+                },
+                "size": {
+                  "description": "The number of hits to return.\nBy default, you cannot page through more than 10,000 hits using the `from` and `size` parameters.\nTo page through more hits, use the `search_after` parameter.",
+                  "type": "number"
+                },
+                "search_after": {
+                  "$ref": "#/components/schemas/_types:SortResults"
+                }
+              }
+            }
+          }
+        }
+      },
       "sql.query": {
         "content": {
           "application/json": {
diff --git a/output/schema/schema-serverless.json b/output/schema/schema-serverless.json
index 360ee95471..818d229e40 100644
--- a/output/schema/schema-serverless.json
+++ b/output/schema/schema-serverless.json
@@ -8782,6 +8782,50 @@
         }
       ]
     },
+    {
+      "availability": {
+        "serverless": {
+          "stability": "stable",
+          "visibility": "public"
+        },
+        "stack": {
+          "since": "8.15.0",
+          "stability": "stable"
+        }
+      },
+      "description": "Find roles with a query.\n\nGet roles in a paginated manner. You can optionally filter the results with a query.",
+      "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-query-role.html",
+      "name": "security.query_role",
+      "privileges": {
+        "cluster": [
+          "read_security"
+        ]
+      },
+      "request": {
+        "name": "Request",
+        "namespace": "security.query_role"
+      },
+      "requestBodyRequired": false,
+      "requestMediaType": [
+        "application/json"
+      ],
+      "response": {
+        "name": "Response",
+        "namespace": "security.query_role"
+      },
+      "responseMediaType": [
+        "application/json"
+      ],
+      "urls": [
+        {
+          "methods": [
+            "GET",
+            "POST"
+          ],
+          "path": "/_security/_query/role"
+        }
+      ]
+    },
     {
       "availability": {
         "serverless": {
@@ -40169,6 +40213,147 @@
       },
       "specLocation": "security/query_api_keys/QueryApiKeysResponse.ts#L26-L45"
     },
+    {
+      "attachedBehaviors": [
+        "CommonQueryParameters"
+      ],
+      "body": {
+        "kind": "properties",
+        "properties": [
+          {
+            "description": "A query to filter which roles to return.\nIf the query parameter is missing, it is equivalent to a `match_all` query.\nThe query supports a subset of query types, including `match_all`, `bool`, `term`, `terms`, `match`,\n`ids`, `prefix`, `wildcard`, `exists`, `range`, and `simple_query_string`.\nYou can query the following information associated with roles: `name`, `description`, `metadata`,\n`applications.application`, `applications.privileges`, `applications.resources`.",
+            "name": "query",
+            "required": false,
+            "type": {
+              "kind": "instance_of",
+              "type": {
+                "name": "RoleQueryContainer",
+                "namespace": "security.query_role"
+              }
+            }
+          },
+          {
+            "description": "Starting document offset.\nBy default, you cannot page through more than 10,000 hits using the from and size parameters.\nTo page through more hits, use the `search_after` parameter.",
+            "name": "from",
+            "required": false,
+            "serverDefault": 0,
+            "type": {
+              "kind": "instance_of",
+              "type": {
+                "name": "integer",
+                "namespace": "_types"
+              }
+            }
+          },
+          {
+            "description": "All public fields of a role are eligible for sorting.\nIn addition, sort can also be applied to the `_doc` field to sort by index order.",
+            "docId": "sort-search-results",
+            "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/sort-search-results.html",
+            "name": "sort",
+            "required": false,
+            "type": {
+              "kind": "instance_of",
+              "type": {
+                "name": "Sort",
+                "namespace": "_types"
+              }
+            }
+          },
+          {
+            "description": "The number of hits to return.\nBy default, you cannot page through more than 10,000 hits using the `from` and `size` parameters.\nTo page through more hits, use the `search_after` parameter.",
+            "name": "size",
+            "required": false,
+            "serverDefault": 10,
+            "type": {
+              "kind": "instance_of",
+              "type": {
+                "name": "integer",
+                "namespace": "_types"
+              }
+            }
+          },
+          {
+            "description": "Search after definition",
+            "name": "search_after",
+            "required": false,
+            "type": {
+              "kind": "instance_of",
+              "type": {
+                "name": "SortResults",
+                "namespace": "_types"
+              }
+            }
+          }
+        ]
+      },
+      "description": "Find roles with a query.\n\nGet roles in a paginated manner. You can optionally filter the results with a query.",
+      "inherits": {
+        "type": {
+          "name": "RequestBase",
+          "namespace": "_types"
+        }
+      },
+      "kind": "request",
+      "name": {
+        "name": "Request",
+        "namespace": "security.query_role"
+      },
+      "path": [],
+      "query": [],
+      "specLocation": "security/query_role/QueryRolesRequest.ts#L25-L69"
+    },
+    {
+      "body": {
+        "kind": "properties",
+        "properties": [
+          {
+            "description": "The total number of roles found.",
+            "name": "total",
+            "required": true,
+            "type": {
+              "kind": "instance_of",
+              "type": {
+                "name": "integer",
+                "namespace": "_types"
+              }
+            }
+          },
+          {
+            "description": "The number of roles returned in the response.",
+            "name": "count",
+            "required": true,
+            "type": {
+              "kind": "instance_of",
+              "type": {
+                "name": "integer",
+                "namespace": "_types"
+              }
+            }
+          },
+          {
+            "description": "The list of roles.",
+            "name": "roles",
+            "required": true,
+            "type": {
+              "kind": "array_of",
+              "value": {
+                "kind": "instance_of",
+                "type": {
+                  "name": "QueryRole",
+                  "namespace": "security.query_role"
+                }
+              }
+            }
+          }
+        ]
+      },
+      "kind": "response",
+      "name": {
+        "name": "Response",
+        "namespace": "security.query_role"
+      },
+      "specLocation": "security/query_role/QueryRolesResponse.ts#L23-L38"
+    },
     {
       "attachedBehaviors": [
         "CommonQueryParameters"
@@ -141989,6 +142174,268 @@
       ],
       "specLocation": "security/query_api_keys/types.ts#L207-L227"
     },
+    {
+      "kind": "interface",
+      "name": {
+        "name": "RoleQueryContainer",
+        "namespace": "security.query_role"
+      },
+      "properties": [
+        {
+          "description": "matches roles matching boolean combinations of other queries.",
+          "docId": "query-dsl-bool-query",
+          "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-bool-query.html",
+          "name": "bool",
+          "required": false,
+          "type": {
+            "kind": "instance_of",
+            "type": {
+              "name": "BoolQuery",
+              "namespace": "_types.query_dsl"
+            }
+          }
+        },
+        {
+          "description": "Returns roles that contain an indexed value for a field.",
+          "docId": "query-dsl-exists-query",
+          "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-exists-query.html",
+          "name": "exists",
+          "required": false,
+          "type": {
+            "kind": "instance_of",
+            "type": {
+              "name": "ExistsQuery",
+              "namespace": "_types.query_dsl"
+            }
+          }
+        },
+        {
+          "description": "Returns roles based on their IDs.\nThis query uses role document IDs stored in the `_id` field.",
+          "docId": "query-dsl-ids-query",
+          "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-ids-query.html",
+          "name": "ids",
+          "required": false,
+          "type": {
+            "kind": "instance_of",
+            "type": {
+              "name": "IdsQuery",
+              "namespace": "_types.query_dsl"
+            }
+          }
+        },
+        {
+          "description": "Returns roles that match a provided text, number, date or boolean value.\nThe provided text is analyzed before matching.",
+          "docId": "query-dsl-match-query",
+          "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-match-query.html",
+          "name": "match",
+          "required": false,
+          "type": {
+            "key": {
+              "kind": "instance_of",
+              "type": {
+                "name": "Field",
+                "namespace": "_types"
+              }
+            },
+            "kind": "dictionary_of",
+            "singleKey": true,
+            "value": {
+              "kind": "instance_of",
+              "type": {
+                "name": "MatchQuery",
+                "namespace": "_types.query_dsl"
+              }
+            }
+          }
+        },
+        {
+          "description": "Matches all roles, giving them all a `_score` of 1.0.",
+          "docId": "query-dsl-match-all-query",
+          "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-match-all-query.html",
+          "name": "match_all",
+          "required": false,
+          "type": {
+            "kind": "instance_of",
+            "type": {
+              "name": "MatchAllQuery",
+              "namespace": "_types.query_dsl"
+            }
+          }
+        },
+        {
+          "description": "Returns roles that contain a specific prefix in a provided field.",
+          "docId": "query-dsl-prefix-query",
+          "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-prefix-query.html",
+          "name": "prefix",
+          "required": false,
+          "type": {
+            "key": {
+              "kind": "instance_of",
+              "type": {
+                "name": "Field",
+                "namespace": "_types"
+              }
+            },
+            "kind": "dictionary_of",
+            "singleKey": true,
+            "value": {
+              "kind": "instance_of",
+              "type": {
+                "name": "PrefixQuery",
+                "namespace": "_types.query_dsl"
+              }
+            }
+          }
+        },
+        {
+          "description": "Returns roles that contain terms within a provided range.",
+          "docId": "query-dsl-range-query",
+          "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-range-query.html",
+          "name": "range",
+          "required": false,
+          "type": {
+            "key": {
+              "kind": "instance_of",
+              "type": {
+                "name": "Field",
+                "namespace": "_types"
+              }
+            },
+            "kind": "dictionary_of",
+            "singleKey": true,
+            "value": {
+              "kind": "instance_of",
+              "type": {
+                "name": "RangeQuery",
+                "namespace": "_types.query_dsl"
+              }
+            }
+          }
+        },
+        {
+          "description": "Returns roles based on a provided query string, using a parser with a limited but fault-tolerant syntax.",
+          "docId": "query-dsl-simple-query-string-query",
+          "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-simple-query-string-query.html",
+          "name": "simple_query_string",
+          "required": false,
+          "type": {
+            "kind": "instance_of",
+            "type": {
+              "name": "SimpleQueryStringQuery",
+              "namespace": "_types.query_dsl"
+            }
+          }
+        },
+        {
+          "description": "Returns roles that contain an exact term in a provided field.\nTo return a document, the query term must exactly match the queried field's value, including whitespace and capitalization.",
+          "docId": "query-dsl-term-query",
+          "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-term-query.html",
+          "name": "term",
+          "required": false,
+          "type": {
+            "key": {
+              "kind": "instance_of",
+              "type": {
+                "name": "Field",
+                "namespace": "_types"
+              }
+            },
+            "kind": "dictionary_of",
+            "singleKey": true,
+            "value": {
+              "kind": "instance_of",
+              "type": {
+                "name": "TermQuery",
+                "namespace": "_types.query_dsl"
+              }
+            }
+          }
+        },
+        {
+          "description": "Returns roles that contain one or more exact terms in a provided field.\nTo return a document, one or more terms must exactly match a field value, including whitespace and capitalization.",
+          "docId": "query-dsl-terms-query",
+          "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-terms-query.html",
+          "name": "terms",
+          "required": false,
+          "type": {
+            "kind": "instance_of",
+            "type": {
+              "name": "TermsQuery",
+              "namespace": "_types.query_dsl"
+            }
+          }
+        },
+        {
+          "description": "Returns roles that contain terms matching a wildcard pattern.",
+          "docId": "query-dsl-wildcard-query",
+          "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-wildcard-query.html",
+          "name": "wildcard",
+          "required": false,
+          "type": {
+            "key": {
+              "kind": "instance_of",
+              "type": {
+                "name": "Field",
+                "namespace": "_types"
+              }
+            },
+            "kind": "dictionary_of",
+            "singleKey": true,
+            "value": {
+              "kind": "instance_of",
+              "type": {
+                "name": "WildcardQuery",
+                "namespace": "_types.query_dsl"
+              }
+            }
+          }
+        }
+      ],
+      "specLocation": "security/query_role/types.ts#L37-L101",
+      "variants": {
+        "kind": "container",
+        "nonExhaustive": true
+      }
+    },
+    {
+      "inherits": {
+        "type": {
+          "name": "RoleDescriptor",
+          "namespace": "security._types"
+        }
+      },
+      "kind": "interface",
+      "name": {
+        "name": "QueryRole",
+        "namespace": "security.query_role"
+      },
+      "properties": [
+        {
+          "name": "_sort",
+          "required": false,
+          "type": {
+            "kind": "instance_of",
+            "type": {
+              "name": "SortResults",
+              "namespace": "_types"
+            }
+          }
+        },
+        {
+          "description": "Name of the role.",
+          "name": "name",
+          "required": true,
+          "type": {
+            "kind": "instance_of",
+            "type": {
+              "name": "string",
+              "namespace": "_builtins"
+            }
+          }
+        }
+      ],
+      "specLocation": "security/query_role/types.ts#L103-L109"
+    },
     {
       "kind": "interface",
       "name": {
diff --git a/output/schema/schema.json b/output/schema/schema.json
index 478520ccf2..0b4529e68f 100644
--- a/output/schema/schema.json
+++ b/output/schema/schema.json
@@ -17165,7 +17165,7 @@
       "availability": {
         "serverless": {
           "stability": "stable",
-          "visibility": "private"
+          "visibility": "public"
         },
         "stack": {
           "since": "8.15.0",
diff --git a/specification/security/query_role/QueryRolesRequest.ts b/specification/security/query_role/QueryRolesRequest.ts
index 9d0a93dde6..8325558128 100644
--- a/specification/security/query_role/QueryRolesRequest.ts
+++ b/specification/security/query_role/QueryRolesRequest.ts
@@ -28,7 +28,7 @@ import { RoleQueryContainer } from './types'
  * Get roles in a paginated manner. You can optionally filter the results with a query.
  * @rest_spec_name security.query_role
  * @availability stack since=8.15.0 stability=stable
- * @availability serverless stability=stable visibility=private
+ * @availability serverless stability=stable visibility=public
  * @cluster_privileges read_security
  */
 export interface Request extends RequestBase {