elastic · lcawl · Mar 13, 2025 · Mar 12, 2025
diff --git a/docs/add-new-api.md b/docs/add-new-api.md
@@ -169,7 +169,7 @@ class Response {
 
 ### Add endpoint request and response examples
 
-Add an `examples` folder and `request` and `xxx_response` subfolders (where `xxx` is the relevant response code).
+Add an `examples` folder and `request` and `xxx_response` subfolders (where `xxx` is the relevant response code). The file names within these folders should be unique (for example,`DownsampleRequestExample1.yaml` not `RequestExample1.yaml`).
 
 These examples are for use in the API documentation and must adhere to the [OpenAPI 3.0 Example object specification](https://spec.openapis.org/oas/v3.0.3#example-object). They must have a `value` field that contains the request or response body.
 If there are multiple examples for the endpoint, they must each have a brief `summary` field, which is used as the label for the example. You can also optionaly provide an explanation in a `description` field.

diff --git a/docs/overlays/elasticsearch-openapi-overlays.yaml b/docs/overlays/elasticsearch-openapi-overlays.yaml
diff --git a/docs/overlays/elasticsearch-shared-overlays.yaml b/docs/overlays/elasticsearch-shared-overlays.yaml
diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json
diff --git a/output/openapi/elasticsearch-serverless-openapi.json b/output/openapi/elasticsearch-serverless-openapi.json
diff --git a/output/schema/schema.json b/output/schema/schema.json
diff --git a/...ers/examples/request/RequestExample1.yaml → ...st/MigrateToDataTiersRequestExample1.yaml b/...ers/examples/request/RequestExample1.yaml → ...st/MigrateToDataTiersRequestExample1.yaml
diff --git a/...s/examples/response/ResponseExample1.yaml → ...e/MigrateToDataTiersResponseExample1.yaml b/...s/examples/response/ResponseExample1.yaml → ...e/MigrateToDataTiersResponseExample1.yaml
diff --git a/...ple/examples/request/RequestExample1.yaml → ...es/request/DownsampleRequestExample1.yaml b/...ple/examples/request/RequestExample1.yaml → ...es/request/DownsampleRequestExample1.yaml
diff --git a/...s/examples/response/ResponseExample1.yaml → .../response/CacheStatsResponseExample1.yaml b/...s/examples/response/ResponseExample1.yaml → .../response/CacheStatsResponseExample1.yaml
diff --git a/...ile/examples/request/RequestExample1.yaml → ...t/ActivateUserProfileRequestExample1.yaml b/...ile/examples/request/RequestExample1.yaml → ...t/ActivateUserProfileRequestExample1.yaml
diff --git a/...e/examples/response/ResponseExample1.yaml → .../ActivateUserProfileResponseExample1.yaml b/...e/examples/response/ResponseExample1.yaml → .../ActivateUserProfileResponseExample1.yaml
diff --git a/...a/examples/response/ResponseExample1.yaml → ...esponse/EnrollKibanaResponseExample1.yaml b/...a/examples/response/ResponseExample1.yaml → ...esponse/EnrollKibanaResponseExample1.yaml
diff --git a/...e/examples/response/ResponseExample1.yaml → .../response/EnrollNodeResponseExample1.yaml b/...e/examples/response/ResponseExample1.yaml → .../response/EnrollNodeResponseExample1.yaml
diff --git a/...e/examples/response/ResponseExample1.yaml → ...ponse/GetUserProfileResponseExample1.yaml b/...e/examples/response/ResponseExample1.yaml → ...ponse/GetUserProfileResponseExample1.yaml
diff --git a/...e/examples/response/ResponseExample2.yaml → ...ponse/GetUserProfileResponseExample2.yaml b/...e/examples/response/ResponseExample2.yaml → ...ponse/GetUserProfileResponseExample2.yaml
diff --git a/...e/examples/response/ResponseExample3.yaml → ...ponse/GetUserProfileResponseExample3.yaml b/...e/examples/response/ResponseExample3.yaml → ...ponse/GetUserProfileResponseExample3.yaml
diff --git a/...ile/examples/request/RequestExample1.yaml → ...PrivilegesUserProfileRequestExample1.yaml b/...ile/examples/request/RequestExample1.yaml → ...PrivilegesUserProfileRequestExample1.yaml
diff --git a/...e/examples/response/ResponseExample1.yaml → ...rivilegesUserProfileResponseExample1.yaml b/...e/examples/response/ResponseExample1.yaml → ...rivilegesUserProfileResponseExample1.yaml
diff --git a/...ate/examples/request/RequestExample1.yaml → ...uest/OidcAuthenticateRequestExample1.yaml b/...ate/examples/request/RequestExample1.yaml → ...uest/OidcAuthenticateRequestExample1.yaml
diff --git a/...e/examples/response/ResponseExample1.yaml → ...nse/OidcAuthenticateResponseExample1.yaml b/...e/examples/response/ResponseExample1.yaml → ...nse/OidcAuthenticateResponseExample1.yaml
diff --git a/...out/examples/request/RequestExample1.yaml → ...es/request/OidcLogoutRequestExample1.yaml b/...out/examples/request/RequestExample1.yaml → ...es/request/OidcLogoutRequestExample1.yaml
diff --git a/...t/examples/response/ResponseExample1.yaml → .../response/OidcLogoutResponseExample1.yaml b/...t/examples/response/ResponseExample1.yaml → .../response/OidcLogoutResponseExample1.yaml
diff --git a/...ion/examples/request/RequestExample1.yaml → ...PrepareAuthenticationRequestExample1.yaml b/...ion/examples/request/RequestExample1.yaml → ...PrepareAuthenticationRequestExample1.yaml
diff --git a/...ion/examples/request/RequestExample2.yaml → ...PrepareAuthenticationRequestExample2.yaml b/...ion/examples/request/RequestExample2.yaml → ...PrepareAuthenticationRequestExample2.yaml
diff --git a/...ion/examples/request/RequestExample3.yaml → ...PrepareAuthenticationRequestExample3.yaml b/...ion/examples/request/RequestExample3.yaml → ...PrepareAuthenticationRequestExample3.yaml
diff --git a/...n/examples/response/ResponseExample1.yaml → ...repareAuthenticationResponseExample1.yaml b/...n/examples/response/ResponseExample1.yaml → ...repareAuthenticationResponseExample1.yaml
diff --git a/...ate/examples/request/RequestExample1.yaml → ...uest/SamlAuthenticateRequestExample1.yaml b/...ate/examples/request/RequestExample1.yaml → ...uest/SamlAuthenticateRequestExample1.yaml
diff --git a/...e/examples/response/ResponseExample1.yaml → ...nse/SamlAuthenticateResponseExample1.yaml b/...e/examples/response/ResponseExample1.yaml → ...nse/SamlAuthenticateResponseExample1.yaml
diff --git a/...out/examples/request/RequestExample1.yaml → ...st/SamlCompleteLogoutRequestExample1.yaml b/...out/examples/request/RequestExample1.yaml → ...st/SamlCompleteLogoutRequestExample1.yaml
diff --git a/...out/examples/request/RequestExample2.yaml → ...st/SamlCompleteLogoutRequestExample2.yaml b/...out/examples/request/RequestExample2.yaml → ...st/SamlCompleteLogoutRequestExample2.yaml
diff --git a/...ate/examples/request/RequestExample1.yaml → ...equest/SamlInvalidateRequestExample1.yaml b/...ate/examples/request/RequestExample1.yaml → ...equest/SamlInvalidateRequestExample1.yaml
diff --git a/...e/examples/response/ResponseExample1.yaml → ...ponse/SamlInvalidateResponseExample1.yaml b/...e/examples/response/ResponseExample1.yaml → ...ponse/SamlInvalidateResponseExample1.yaml
diff --git a/...out/examples/request/RequestExample1.yaml → ...es/request/SamlLogoutRequestExample1.yaml b/...out/examples/request/RequestExample1.yaml → ...es/request/SamlLogoutRequestExample1.yaml
diff --git a/...t/examples/response/ResponseExample1.yaml → .../response/SamlLogoutResponseExample1.yaml b/...t/examples/response/ResponseExample1.yaml → .../response/SamlLogoutResponseExample1.yaml
diff --git a/...ion/examples/request/RequestExample1.yaml → ...PrepareAuthenticationRequestExample1.yaml b/...ion/examples/request/RequestExample1.yaml → ...PrepareAuthenticationRequestExample1.yaml
diff --git a/...ion/examples/request/RequestExample2.yaml → ...PrepareAuthenticationRequestExample2.yaml b/...ion/examples/request/RequestExample2.yaml → ...PrepareAuthenticationRequestExample2.yaml
diff --git a/...n/examples/response/ResponseExample1.yaml → ...repareAuthenticationResponseExample1.yaml b/...n/examples/response/ResponseExample1.yaml → ...repareAuthenticationResponseExample1.yaml
diff --git a/...a/examples/response/ResponseExample1.yaml → ...viceProviderMetadataResponseExample1.yaml b/...a/examples/response/ResponseExample1.yaml → ...viceProviderMetadataResponseExample1.yaml
diff --git a/...les/examples/request/RequestExample1.yaml → ...t/SuggestUserProfilesRequestExample1.yaml b/...les/examples/request/RequestExample1.yaml → ...t/SuggestUserProfilesRequestExample1.yaml
diff --git a/...s/examples/response/ResponseExample1.yaml → .../SuggestUserProfilesResponseExample1.yaml b/...s/examples/response/ResponseExample1.yaml → .../SuggestUserProfilesResponseExample1.yaml
diff --git a/...key/examples/request/RequestExample1.yaml → .../request/UpdateApiKeyRequestExample1.yaml b/...key/examples/request/RequestExample1.yaml → .../request/UpdateApiKeyRequestExample1.yaml
diff --git a/...key/examples/request/RequestExample2.yaml → .../request/UpdateApiKeyRequestExample2.yaml b/...key/examples/request/RequestExample2.yaml → .../request/UpdateApiKeyRequestExample2.yaml
diff --git a/...y/examples/response/ResponseExample1.yaml → ...esponse/UpdateApiKeyResponseExample1.yaml b/...y/examples/response/ResponseExample1.yaml → ...esponse/UpdateApiKeyResponseExample1.yaml
diff --git a/...ata/examples/request/RequestExample1.yaml → ...UpdateUserProfileDataRequestExample1.yaml b/...ata/examples/request/RequestExample1.yaml → ...UpdateUserProfileDataRequestExample1.yaml
diff --git a/...a/examples/response/ResponseExample1.yaml → ...pdateUserProfileDataResponseExample1.yaml b/...a/examples/response/ResponseExample1.yaml → ...pdateUserProfileDataResponseExample1.yaml