Skip to content

Commit 551363b

Browse files
miguelgrinberglcawl
andcommitted
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 7d1a5df commit 551363b

File tree

584 files changed

+6199
-1025
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

+6199
-1025
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
@@ -144,14 +144,16 @@ pub fn add_endpoint(
144144
// }
145145
};
146146

147-
let openapi_example = Example {
148-
value: example,
149-
description: schema_example.description.clone(),
150-
summary: schema_example.summary.clone(),
151-
external_value: None,
152-
extensions: Default::default(),
153-
};
154-
openapi_examples.insert(name.clone(), ReferenceOr::Item(openapi_example));
147+
if example.is_some() {
148+
let openapi_example = Example {
149+
value: example,
150+
description: schema_example.description.clone(),
151+
summary: schema_example.summary.clone(),
152+
external_value: None,
153+
extensions: Default::default(),
154+
};
155+
openapi_examples.insert(name.clone(), ReferenceOr::Item(openapi_example));
156+
}
155157
}
156158
openapi_examples
157159
}
@@ -268,21 +270,6 @@ pub fn add_endpoint(
268270
}
269271
}
270272
}
271-
if code_samples.is_empty() {
272-
// if there are no example requests we look for example responses
273-
// this can only happen for examples that do not have a request body
274-
if let Some(examples) = response_def.examples.clone() {
275-
if let Some((_, example)) = examples.first() {
276-
let request_line = example.method_request.clone().unwrap_or(String::from(""));
277-
if !request_line.is_empty() {
278-
code_samples.push(serde_json::json!({
279-
"lang": "Console",
280-
"source": request_line + "\n",
281-
}));
282-
}
283-
}
284-
}
285-
}
286273
if !code_samples.is_empty() {
287274
extensions.insert("x-codeSamples".to_string(), serde_json::json!(code_samples));
288275
}
Binary file not shown.

docs/overlays/elasticsearch-shared-overlays.yaml

Lines changed: 0 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1071,17 +1071,6 @@ actions:
10711071
# update:
10721072
# aggregations:
10731073
# x-model: true
1074-
# Examples
1075-
## xCodeSamples
1076-
- target: "$.paths['/{index}/_doc/{id}']['head']"
1077-
description: "Add xCodeSamples for check document operation"
1078-
update:
1079-
x-codeSamples:
1080-
- $ref: "../../specification/_global/exists/examples/xCodeSamples/DocumentExistsConsoleExample1.yaml"
1081-
- $ref: "../../specification/_global/exists/examples/xCodeSamples/DocumentExistsCurlExample1.yaml"
1082-
- $ref: "../../specification/_global/exists/examples/xCodeSamples/DocumentExistsJavaScriptExample1.yaml"
1083-
- $ref: "../../specification/_global/exists/examples/xCodeSamples/DocumentExistsPythonExample1.yaml"
1084-
- $ref: "../../specification/_global/exists/examples/xCodeSamples/DocumentExistsRubyExample1.yaml"
10851074
# Remove long lists of enum values
10861075
- target: "$.components['schemas']['cat._types.CatAnomalyDetectorColumn'].enum"
10871076
description: Remove enum array

0 commit comments

Comments
 (0)