Skip to content

Commit da30074

Browse files
add example requests for endpoints that do not use bodies (#4489) (#4509)
* 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 <[email protected]>
1 parent e04d320 commit da30074

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
}
@@ -329,21 +331,6 @@ pub fn add_endpoint(
329331
}
330332
}
331333
}
332-
if code_samples.is_empty() {
333-
// if there are no example requests we look for example responses
334-
// this can only happen for examples that do not have a request body
335-
if let Some(examples) = response_def.examples.clone() {
336-
if let Some((_, example)) = examples.first() {
337-
let request_line = example.method_request.clone().unwrap_or(String::from(""));
338-
if !request_line.is_empty() {
339-
code_samples.push(serde_json::json!({
340-
"lang": "Console",
341-
"source": request_line + "\n",
342-
}));
343-
}
344-
}
345-
}
346-
}
347334
if !code_samples.is_empty() {
348335
extensions.insert("x-codeSamples".to_string(), serde_json::json!(code_samples));
349336
}
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)