nori/builder/operation_builder
Builder for constructing Operation objects with a fluent API.
Types
Builder for creating Operation objects.
pub opaque type OperationBuilderValues
pub fn deprecated(builder: OperationBuilder) -> OperationBuilderMarks as deprecated.
pub fn description(
builder: OperationBuilder,
d: String,
) -> OperationBuilderSets the description.
pub fn external_docs(
builder: OperationBuilder,
url: String,
) -> OperationBuilderSets external documentation.
pub fn external_docs_with_description(
builder: OperationBuilder,
url: String,
desc: String,
) -> OperationBuilderSets external documentation with description.
pub fn json_body(
builder: OperationBuilder,
schema: schema.Schema,
) -> OperationBuilderSets a JSON request body.
pub fn json_response(
builder: OperationBuilder,
status_code: String,
desc: String,
schema: schema.Schema,
) -> OperationBuilderAdds a JSON response.
pub fn json_response_ref(
builder: OperationBuilder,
status_code: String,
desc: String,
schema_ref: String,
) -> OperationBuilderAdds a JSON response with a schema reference.
pub fn operation_id(
builder: OperationBuilder,
id: String,
) -> OperationBuilderSets the operation ID.
pub fn parameter(
builder: OperationBuilder,
param: parameter.Parameter,
) -> OperationBuilderAdds a parameter.
pub fn parameter_ref(
builder: OperationBuilder,
ref: String,
) -> OperationBuilderAdds a parameter reference.
pub fn request_body(
builder: OperationBuilder,
body: request_body.RequestBody,
) -> OperationBuilderSets the request body.
pub fn request_body_ref(
builder: OperationBuilder,
ref: String,
) -> OperationBuilderSets the request body reference.
pub fn response(
builder: OperationBuilder,
status_code: String,
resp: response.Response,
) -> OperationBuilderAdds a response.
pub fn response_ref(
builder: OperationBuilder,
status_code: String,
ref: String,
) -> OperationBuilderAdds a response reference.
pub fn security(
builder: OperationBuilder,
req: dict.Dict(String, List(String)),
) -> OperationBuilderAdds a security requirement.
pub fn security_scheme(
builder: OperationBuilder,
scheme_name: String,
) -> OperationBuilderAdds a simple security requirement (security scheme with no scopes).
pub fn server(
builder: OperationBuilder,
s: server.Server,
) -> OperationBuilderAdds a server.
pub fn simple_response(
builder: OperationBuilder,
status_code: String,
desc: String,
) -> OperationBuilderAdds a simple response with just a description.
pub fn summary(
builder: OperationBuilder,
s: String,
) -> OperationBuilderSets the summary.
pub fn tags(
builder: OperationBuilder,
ts: List(String),
) -> OperationBuilderSets multiple tags.