Skip to content

Commit 7d0defc

Browse files
add example requests for endpoints that do not use bodies (#4489)
* add a few example requests for endpoints that do not use bodies * Remove x-codeSamples from overlay * restructure existing examples w/o bodies as request examples * skip examples w/o bodies when generating openapi examples * add a lot of missing examples * remove duplicate test * more examples missed in previous commit --------- Co-authored-by: lcawl <lcawley@elastic.co>
1 parent 3a9b685 commit 7d0defc

File tree

584 files changed

+6181
-1019
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

584 files changed

+6181
-1019
lines changed

compiler-rs/clients_schema_to_openapi/src/paths.rs

Lines changed: 10 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -148,14 +148,16 @@ pub fn add_endpoint(
148148
// }
149149
};
150150

151-
let openapi_example = Example {
152-
value: example,
153-
description: schema_example.description.clone(),
154-
summary: schema_example.summary.clone(),
155-
external_value: None,
156-
extensions: Default::default(),
157-
};
158-
openapi_examples.insert(name.clone(), ReferenceOr::Item(openapi_example));
151+
if example.is_some() {
152+
let openapi_example = Example {
153+
value: example,
154+
description: schema_example.description.clone(),
155+
summary: schema_example.summary.clone(),
156+
external_value: None,
157+
extensions: Default::default(),
158+
};
159+
openapi_examples.insert(name.clone(), ReferenceOr::Item(openapi_example));
160+
}
159161
}
160162
openapi_examples
161163
}
@@ -340,21 +342,6 @@ pub fn add_endpoint(
340342
}
341343
}
342344
}
343-
if code_samples.is_empty() {
344-
// if there are no example requests we look for example responses
345-
// this can only happen for examples that do not have a request body
346-
if let Some(examples) = response_def.examples.clone() {
347-
if let Some((_, example)) = examples.first() {
348-
let request_line = example.method_request.clone().unwrap_or(String::from(""));
349-
if !request_line.is_empty() {
350-
code_samples.push(serde_json::json!({
351-
"lang": "Console",
352-
"source": request_line + "\n",
353-
}));
354-
}
355-
}
356-
}
357-
}
358345
if !code_samples.is_empty() {
359346
extensions.insert("x-codeSamples".to_string(), serde_json::json!(code_samples));
360347
}
Binary file not shown.

docs/overlays/elasticsearch-shared-overlays.yaml

Lines changed: 0 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1077,17 +1077,6 @@ actions:
10771077
# update:
10781078
# aggregations:
10791079
# x-model: true
1080-
# Examples
1081-
## xCodeSamples
1082-
- target: "$.paths['/{index}/_doc/{id}']['head']"
1083-
description: "Add xCodeSamples for check document operation"
1084-
update:
1085-
x-codeSamples:
1086-
- $ref: "../../specification/_global/exists/examples/xCodeSamples/DocumentExistsConsoleExample1.yaml"
1087-
- $ref: "../../specification/_global/exists/examples/xCodeSamples/DocumentExistsCurlExample1.yaml"
1088-
- $ref: "../../specification/_global/exists/examples/xCodeSamples/DocumentExistsJavaScriptExample1.yaml"
1089-
- $ref: "../../specification/_global/exists/examples/xCodeSamples/DocumentExistsPythonExample1.yaml"
1090-
- $ref: "../../specification/_global/exists/examples/xCodeSamples/DocumentExistsRubyExample1.yaml"
10911080
# Remove long lists of enum values
10921081
- target: "$.components['schemas']['cat._types.CatAnomalyDetectorColumn'].enum"
10931082
description: Remove enum array

0 commit comments

Comments
 (0)