Skip to content

Commit a22f345

Browse files
lcawllcawl
committed
Change example files to unique names
1 parent 17d2cd5 commit a22f345

File tree

40 files changed

+560
-0
lines changed

40 files changed

+560
-0
lines changed

‎specification/ilm/migrate_to_data_tiers/examples/request/MigrateToDataTiersRequestExample1.yaml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# summary: 'Migrates indices, ILM policies, and templates from using custom node attributes to using data tiers.'
2+
# method_request: POST /_ilm/migrate_to_data_tiers
3+
description: >
4+
Run `POST /_ilm/migrate_to_data_tiers` to migrate the indices, ILM policies, legacy templates, composable, and component templates away from defining custom allocation filtering using the `custom_attribute_name` node attribute.
5+
It also deletes the legacy template with name `global-template` if it exists in the system.
6+
# type: request
7+
value: |-
8+
{
9+
"legacy_template_to_delete": "global-template",
10+
"node_attribute": "custom_attribute_name"
11+
}

‎specification/ilm/migrate_to_data_tiers/examples/response/MigrateToDataTiersResponseExample1.yaml

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# summary:
2+
description: >
3+
A successful response when migrating indices, ILMs, and templates from custom node attributes to data tiers.
4+
# type: response
5+
# response_code: 200
6+
value: |-
7+
{
8+
"dry_run": false,
9+
"removed_legacy_template":"global-template",
10+
"migrated_ilm_policies":["policy_with_allocate_action"],
11+
"migrated_indices":["warm-index-to-migrate-000001"],
12+
"migrated_legacy_templates":["a-legacy-template"],
13+
"migrated_composable_templates":["a-composable-template"],
14+
"migrated_component_templates":["a-component-template"]
15+
}

‎specification/indices/downsample/examples/request/DownsampleRequestExample1.yaml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# summary:
2+
# method_request: POST /my-time-series-index/_downsample/my-downsampled-time-series-index
3+
# description: ''
4+
# type: request
5+
value:
6+
fixed_interval: 1d

‎specification/searchable_snapshots/cache_stats/examples/response/CacheStatsResponseExample1.yaml

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# summary:
2+
description: A successful response from `GET /_searchable_snapshots/cache/stats`.
3+
# type: response
4+
# response_code: 200
5+
value: |-
6+
{
7+
"nodes" : {
8+
"eerrtBMtQEisohZzxBLUSw" : {
9+
"shared_cache" : {
10+
"reads" : 6051,
11+
"bytes_read_in_bytes" : 5448829,
12+
"writes" : 37,
13+
"bytes_written_in_bytes" : 1208320,
14+
"evictions" : 5,
15+
"num_regions" : 65536,
16+
"size_in_bytes" : 1099511627776,
17+
"region_size_in_bytes" : 16777216
18+
}
19+
}
20+
}
21+
}

‎specification/security/activate_user_profile/examples/request/ActivateUserProfileRequestExample1.yaml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# summary:
2+
# method_request: POST /_security/profile/_activate
3+
description: >
4+
Run `POST /_security/profile/_activate` to activate a user profile.
5+
# type: request
6+
value: |-
7+
{
8+
"grant_type": "password",
9+
"username" : "jacknich",
10+
"password" : "l0ng-r4nd0m-p@ssw0rd"
11+
}

‎specification/security/activate_user_profile/examples/response/ActivateUserProfileResponseExample1.yaml

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# summary:
2+
description: A successful response from `POST /_security/profile/_activate`.
3+
# type: response
4+
# response_code:
5+
value: |-
6+
{
7+
"uid": "u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0",
8+
"enabled": true,
9+
"last_synchronized": 1642650651037,
10+
"user": {
11+
"username": "jacknich",
12+
"roles": [
13+
"admin", "other_role1"
14+
],
15+
"realm_name": "native",
16+
"full_name": "Jack Nicholson",
17+
"email": "jacknich@example.com"
18+
},
19+
"labels": {},
20+
"data": {},
21+
"_doc": {
22+
"_primary_term": 88,
23+
"_seq_no": 66
24+
}
25+
}

‎specification/security/enroll_kibana/examples/response/EnrollKibanaResponseExample1.yaml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# summary:
2+
description: A successful response from `GET /_security/enroll/kibana`.
3+
# type: response
4+
# response_code:
5+
value: |-
6+
{
7+
"token" : {
8+
"name" : "enroll-process-token-1629123923000",
9+
"value": "AAEAAWVsYXN0aWM...vZmxlZXQtc2VydmVyL3Rva2VuMTo3TFdaSDZ"
10+
},
11+
"http_ca" : "MIIJlAIBAzVoGCSqGSIb3...vsDfsA3UZBAjEPfhubpQysAICAA=",
12+
}

‎specification/security/enroll_node/examples/response/EnrollNodeResponseExample1.yaml

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# summary:
2+
description: A successful response from `PGET /security/enroll/node`.
3+
# type: response
4+
# response_code:
5+
value: |-
6+
{
7+
"http_ca_key" : "MIIJlAIBAzCCCVoGCSqGSIb3DQEHAaCCCUsEgglHMIIJQzCCA98GCSqGSIb3DQ....vsDfsA3UZBAjEPfhubpQysAICCAA=",
8+
"http_ca_cert" : "MIIJlAIBAzCCCVoGCSqGSIb3DQEHAaCCCUsEgglHMIIJQzCCA98GCSqGSIb3DQ....vsDfsA3UZBAjEPfhubpQysAICCAA=",
9+
"transport_ca_cert" : "MIIJlAIBAzCCCVoGCSqGSIb3DQEHAaCCCUsEgglHMIIJQzCCA98GCSqG....vsDfsA3UZBAjEPfhubpQysAICCAA=",
10+
"transport_key" : "MIIEJgIBAzCCA98GCSqGSIb3DQEHAaCCA9AEggPMMIIDyDCCA8QGCSqGSIb3....YuEiOXvqZ6jxuVSQ0CAwGGoA==",
11+
"transport_cert" : "MIIEJgIBAzCCA98GCSqGSIb3DQEHAaCCA9AEggPMMIIDyDCCA8QGCSqGSIb3....YuEiOXvqZ6jxuVSQ0CAwGGoA==",
12+
"nodes_addresses" : [
13+
"192.168.1.2:9300"
14+
]
15+
}

‎specification/security/get_user_profile/examples/response/GetUserProfileResponseExample1.yaml

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
summary: Profile details for a UUID
2+
description: >
3+
A successful response from `GET /_security/profile/u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0`.
4+
By default, no content is returned in the `data` field.
5+
# type: response
6+
# response_code:
7+
value: |-
8+
{
9+
"profiles": [
10+
{
11+
"uid": "u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0",
12+
"enabled": true,
13+
"last_synchronized": 1642650651037,
14+
"user": {
15+
"username": "jacknich",
16+
"roles": [
17+
"admin", "other_role1"
18+
],
19+
"realm_name": "native",
20+
"full_name": "Jack Nicholson",
21+
"email": "jacknich@example.com"
22+
},
23+
"labels": {
24+
"direction": "north"
25+
},
26+
"data": {},
27+
"_doc": {
28+
"_primary_term": 88,
29+
"_seq_no": 66
30+
}
31+
}
32+
]
33+
}

‎specification/security/get_user_profile/examples/response/GetUserProfileResponseExample2.yaml

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
summary: Profile details for a UUID and data key
2+
description: >
3+
A successful response from `GET /_security/profile/u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0?data=app1.key1`.
4+
# type: response
5+
# response_code:
6+
value: |-
7+
{
8+
"profiles": [
9+
{
10+
"uid": "u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0",
11+
"enabled": true,
12+
"last_synchronized": 1642650651037,
13+
"user": {
14+
"username": "jacknich",
15+
"roles": [
16+
"admin", "other_role1"
17+
],
18+
"realm_name": "native",
19+
"full_name": "Jack Nicholson",
20+
"email": "jacknich@example.com"
21+
},
22+
"labels": {
23+
"direction": "north"
24+
},
25+
"data": {
26+
"app1": {
27+
"key1": "value1"
28+
}
29+
},
30+
"_doc": {
31+
"_primary_term": 88,
32+
"_seq_no": 66
33+
}
34+
}
35+
]
36+
}

0 commit comments

Comments
 (0)