Add examples

Author: lcawl

docs/overlays/elasticsearch-openapi-overlays.yaml

@@ -472,6 +472,24 @@ actions:
                 renderSearchApplicationQueryResponseExample1:
                   $ref: "../../specification/search_application/render_query/SearchApplicationsRenderQueryResponseExample1.yaml"
 
+  - target: "$.paths['/_security/api_key/_bulk_update']['post']"
+    description: "Add examples for bulk update API keys operation"
+    update:
+      requestBody: 
+        content: 
+          application/json: 
+            examples: 
+              bulkUpdateApiKeysRequestExample1: 
+                $ref: "../../specification/security/bulk_update_api_keys/SecurityBulkUpdateApiKeysRequestExample1.yaml"
+              bulkUpdateApiKeysRequestExample2: 
+                $ref: "../../specification/security/bulk_update_api_keys/SecurityBulkUpdateApiKeysRequestExample2.yaml"
+      responses:
+        200:
+          content:
+            application/json:
+              examples:
+                bulkUpdateApiKeysResponseExample1:
+                  $ref: "../../specification/security/bulk_update_api_keys/SecurityBulkUpdateApiKeysResponseExample1.yaml"
   - target: "$.paths['/_security/delegate_pki']['post']"
     description: "Add examples for delegate PKI operation"
     update:

output/openapi/elasticsearch-openapi.json

@@ -0,0 +1,22 @@
+# summary:
+description: Assign new role descriptors and metadata and update the expiration time for two API keys.
+# type": "response",
+# response_code": 200,
+value:
+  ids:
+    - VuaCfGcBCdbkQm-e5aOx
+    - H3_AhoIBA9hmeQJdg7ij
+  role_descriptors:
+    role-a:
+      indices:
+        - names:
+            - '*'
+          privileges:
+            - write
+  metadata:
+    environment:
+      level: 2
+      trusted: true
+      tags:
+        - production
+  expiration: 30d

output/schema/schema.json

@@ -0,0 +1,9 @@
+# summary:
+description: Remove the previously assigned permissions for two API keys, making them inherit the owner user's full permissions.
+# type": "response",
+# response_code": 200,
+value:
+  ids:
+    - VuaCfGcBCdbkQm-e5aOx
+    - H3_AhoIBA9hmeQJdg7ij
+  role_descriptors: {}

output/typescript/types.ts

@@ -17,10 +17,12 @@
  * under the License.
  */
 
+import { BulkError } from '@security/_types/Bulk'
 import { integer } from '@_types/Numeric'
 
 export class Response {
   body: {
+    errors?: BulkError
     noops: Array<integer>
     updated: Array<string>
   }

specification/security/bulk_update_api_keys/SecurityBulkUpdateApiKeysRequestExample1.yaml

@@ -0,0 +1,9 @@
+# summary:
+description: A successful response from updating two API keys.
+# type": "response",
+# response_code": 200,
+value:
+  updated:
+    - VuaCfGcBCdbkQm-e5aOx
+    - H3_AhoIBA9hmeQJdg7ij
+  noops: []

specification/security/bulk_update_api_keys/SecurityBulkUpdateApiKeysRequestExample2.yaml

@@ -41,7 +41,7 @@ export interface Request extends RequestBase {
      * The X509Certificate chain, which is represented as an ordered string array.
      * Each string in the array is a base64-encoded (Section 4 of RFC4648 - not base64url-encoded) of the certificate's DER encoding.
      *
-     * The first element is the target certificate that contains the subject distinguished name that is requesting access. 
+     * The first element is the target certificate that contains the subject distinguished name that is requesting access.
      * This may be followed by additional certificates; each subsequent certificate is used to certify the previous one.
      */
     x509_certificate_chain: string[]

specification/security/bulk_update_api_keys/SecurityBulkUpdateApiKeysResponse.ts

@@ -1,5 +1,5 @@
-# summary: 
+# summary:
 description: Delegate a one element certificate chain.
 # type": "response",
 # response_code": 200,
-value: "{\n\"x509_certificate_chain\": [\"MIIDeDCCAmCgAwIBAgIUBzj/nGGKxP2iXawsSquHmQjCJmMwDQYJKoZIhvcNAQELBQAwUzErMCkGA1UEAxMiRWxhc3RpY3NlYXJjaCBUZXN0IEludGVybWVkaWF0ZSBDQTEWMBQGA1UECxMNRWxhc3RpY3NlYXJjaDEMMAoGA1UEChMDb3JnMB4XDTIzMDcxODE5MjkwNloXDTQzMDcxMzE5MjkwNlowSjEiMCAGA1UEAxMZRWxhc3RpY3NlYXJjaCBUZXN0IENsaWVudDEWMBQGA1UECxMNRWxhc3RpY3NlYXJjaDEMMAoGA1UEChMDb3JnMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAllHL4pQkkfwAm/oLkxYYO+r950DEy1bjH+4viCHzNADLCTWO+lOZJVlNx7QEzJE3QGMdif9CCBBxQFMapA7oUFCLq84fPSQQu5AnvvbltVD9nwVtCs+9ZGDjMKsz98RhSLMFIkxdxi6HkQ3Lfa4ZSI4lvba4oo+T/GveazBDS+NgmKyq00EOXt3tWi1G9vEVItommzXWfv0agJWzVnLMldwkPqsw0W7zrpyT7FZS4iLbQADGceOW8fiauOGMkscu9zAnDR/SbWl/chYioQOdw6ndFLn1YIFPd37xL0WsdsldTpn0vH3YfzgLMffT/3P6YlwBegWzsx6FnM/93Ecb4wIDAQABo00wSzAJBgNVHRMEAjAAMB0GA1UdDgQWBBQKNRwjW+Ad/FN1Rpoqme/5+jrFWzAfBgNVHSMEGDAWgBRcya0c0x/PaI7MbmJVIylWgLqXNjANBgkqhkiG9w0BAQsFAAOCAQEACZ3PF7Uqu47lplXHP6YlzYL2jL0D28hpj5lGtdha4Muw1m/BjDb0Pu8l0NQ1z3AP6AVcvjNDkQq6Y5jeSz0bwQlealQpYfo7EMXjOidrft1GbqOMFmTBLpLA9SvwYGobSTXWTkJzonqVaTcf80HpMgM2uEhodwTcvz6v1WEfeT/HMjmdIsq4ImrOL9RNrcZG6nWfw0HR3JNOgrbfyEztEI471jHznZ336OEcyX7gQuvHE8tOv5+oD1d7s3Xg1yuFp+Ynh+FfOi3hPCuaHA+7F6fLmzMDLVUBAllugst1C3U+L/paD7tqIa4ka+KNPCbSfwazmJrt4XNiivPR4hwH5g==\"]\n}"
+value: "{\n\"x509_certificate_chain\": [\"MIIDeDCCAmCgAwIBAgIUBzj/nGGKxP2iXawsSquHmQjCJmMwDQYJKoZIhvcNAQELBQAwUzErMCkGA1UEAxMiRWxhc3RpY3NlYXJjaCBUZXN0IEludGVybWVkaWF0ZSBDQTEWMBQGA1UECxMNRWxhc3RpY3NlYXJjaDEMMAoGA1UEChMDb3JnMB4XDTIzMDcxODE5MjkwNloXDTQzMDcxMzE5MjkwNlowSjEiMCAGA1UEAxMZRWxhc3RpY3NlYXJjaCBUZXN0IENsaWVudDEWMBQGA1UECxMNRWxhc3RpY3NlYXJjaDEMMAoGA1UEChMDb3JnMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAllHL4pQkkfwAm/oLkxYYO+r950DEy1bjH+4viCHzNADLCTWO+lOZJVlNx7QEzJE3QGMdif9CCBBxQFMapA7oUFCLq84fPSQQu5AnvvbltVD9nwVtCs+9ZGDjMKsz98RhSLMFIkxdxi6HkQ3Lfa4ZSI4lvba4oo+T/GveazBDS+NgmKyq00EOXt3tWi1G9vEVItommzXWfv0agJWzVnLMldwkPqsw0W7zrpyT7FZS4iLbQADGceOW8fiauOGMkscu9zAnDR/SbWl/chYioQOdw6ndFLn1YIFPd37xL0WsdsldTpn0vH3YfzgLMffT/3P6YlwBegWzsx6FnM/93Ecb4wIDAQABo00wSzAJBgNVHRMEAjAAMB0GA1UdDgQWBBQKNRwjW+Ad/FN1Rpoqme/5+jrFWzAfBgNVHSMEGDAWgBRcya0c0x/PaI7MbmJVIylWgLqXNjANBgkqhkiG9w0BAQsFAAOCAQEACZ3PF7Uqu47lplXHP6YlzYL2jL0D28hpj5lGtdha4Muw1m/BjDb0Pu8l0NQ1z3AP6AVcvjNDkQq6Y5jeSz0bwQlealQpYfo7EMXjOidrft1GbqOMFmTBLpLA9SvwYGobSTXWTkJzonqVaTcf80HpMgM2uEhodwTcvz6v1WEfeT/HMjmdIsq4ImrOL9RNrcZG6nWfw0HR3JNOgrbfyEztEI471jHznZ336OEcyX7gQuvHE8tOv5+oD1d7s3Xg1yuFp+Ynh+FfOi3hPCuaHA+7F6fLmzMDLVUBAllugst1C3U+L/paD7tqIa4ka+KNPCbSfwazmJrt4XNiivPR4hwH5g==\"]\n}"

specification/security/bulk_update_api_keys/SecurityBulkUpdateApiKeysResponseExample1.yaml

@@ -1,4 +1,4 @@
-# summary: 
+# summary:
 description: A successful response from delegating a one element certificate chain.
 # type": "response",
 # response_code": 200,
@@ -23,4 +23,4 @@ value:
     lookup_realm:
       name: pki1
       type: pki
-    authentication_type: realm
+    authentication_type: realm