Add authentication, change password, create api key examples

Author: lcawl

specification/security/authenticate/examples/response/SecurityAuthenticateResponseExample1.yaml

@@ -0,0 +1,24 @@
+# summary:
+description: A successful response from `GET /_security/_authenticate`.
+# type: response
+# response_code: 200
+value: |-
+  {
+    "username": "rdeniro",
+    "roles": [
+      "admin"
+    ],
+    "full_name": null,
+    "email":  null,
+    "metadata": { },
+    "enabled": true,
+    "authentication_realm": {
+      "name" : "file",
+      "type" : "file"
+    },
+    "lookup_realm": {
+      "name" : "file",
+      "type" : "file"
+    },
+    "authentication_type": "realm"
+  }

specification/security/change_password/examples/request/SecurityChangePasswordRequestExample1.yaml

@@ -0,0 +1,9 @@
+# summary:
+# method_request: POST /_security/user/jacknich/_password
+description: >
+  Run `POST /_security/user/jacknich/_password` to update the password for the `jacknich` user.
+# type: request
+value: |-
+  {
+    "password" : "new-test-password"
+  }

specification/security/create_api_key/examples/request/SecurityCreateApiKeyRequestExample1.yaml

@@ -0,0 +1,40 @@
+# summary:
+# method_request: POST /_security/api_key
+description: >
+  Run `POST /_security/api_key` to create an API key.
+  If `expiration` is not provided, the API keys do not expire.
+  If `role_descriptors` is not provided, the permissions of the authenticated user are applied.
+# type: request
+value: |-
+  {
+    "name": "my-api-key",
+    "expiration": "1d",   
+    "role_descriptors": { 
+      "role-a": {
+        "cluster": ["all"],
+        "indices": [
+          {
+            "names": ["index-a*"],
+            "privileges": ["read"]
+          }
+        ]
+      },
+      "role-b": {
+        "cluster": ["all"],
+        "indices": [
+          {
+            "names": ["index-b*"],
+            "privileges": ["all"]
+          }
+        ]
+      }
+    },
+    "metadata": {
+      "application": "my-application",
+      "environment": {
+        "level": 1,
+        "trusted": true,
+        "tags": ["dev", "staging"]
+      }
+    }
+  }

specification/security/create_api_key/examples/response/SecurityCreateApiKeyResponseExample1.yaml

@@ -0,0 +1,12 @@
+# summary:
+description: A successful response from `POST /_security/api_key`.
+# type: response
+# response_code: 200
+value: |-
+  {
+    "id": "VuaCfGcBCdbkQm-e5aOx",        
+    "name": "my-api-key",
+    "expiration": 1544068612110,         
+    "api_key": "ui2lp2axTNmsyakw9tvNnw", 
+    "encoded": "VnVhQ2ZHY0JDZGJrUW0tZTVhT3g6dWkybHAyYXhUTm1zeWFrdzl0dk5udw=="  
+  }