Skip to content

improve OpenAPI description for Response<Body> endpoints #295

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 13, 2022
Merged

improve OpenAPI description for Response<Body> endpoints #295

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b83d08e
improve OpenAPI description for Response<Body> endpoints
ahl Mar 2, 2022
b573d5b
Merge branch 'main' into yolo-body
ahl Mar 13, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 19 additions & 2 deletions dropshot/src/api_description.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -778,15 +778,32 @@ impl<Context: ServerContext> ApiDescription<Context> {
} else {
// If no schema was specified, the response is hand-rolled. In
// this case we'll fall back to the default response type which
// we assume to be inclusive of errors.
// we assume to be inclusive of errors. The media type and
// and schema will similarly be maximally permissive.
let mut content = indexmap::IndexMap::new();
content.insert(
"*/*".to_string(),
openapiv3::MediaType {
schema: Some(openapiv3::ReferenceOr::Item(
openapiv3::Schema {
schema_data: openapiv3::SchemaData::default(),
schema_kind: openapiv3::SchemaKind::Any(
openapiv3::AnySchema::default(),
),
},
)),
..Default::default()
},
);
operation.responses.default =
Some(openapiv3::ReferenceOr::Item(openapiv3::Response {
// TODO: perhaps we should require even free-form
// responses to have a description since it's required
// by OpenAPI.
description: "".to_string(),
content,
..Default::default()
}))
}));
}

// Drop in the operation.
Expand Down
7 changes: 6 additions & 1 deletion dropshot/tests/test_openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -485,7 +485,12 @@
"operationId": "handler16",
"responses": {
"default": {
"description": ""
"description": "",
"content": {
"*/*": {
"schema": {}
}
}
}
}
}
Expand Down
7 changes: 6 additions & 1 deletion dropshot/tests/test_openapi_fuller.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -493,7 +493,12 @@
"operationId": "handler16",
"responses": {
"default": {
"description": ""
"description": "",
"content": {
"*/*": {
"schema": {}
}
}
}
}
}
Expand Down