public class ResponsesObjectBuilder extends Object
A container for the expected responses of an operation. The container maps a HTTP response code to the expected response.
The documentation is not necessarily expected to cover all possible HTTP response codes because they may not be known in advance. However, documentation is expected to cover a successful operation response and any known errors.
The default MAY be used as a default response object for all HTTP codes that are not covered
individually by the specification.
The Responses Object MUST contain at least one response code, and it SHOULD be the response for a
successful operation call.
| Constructor and Description |
|---|
ResponsesObjectBuilder() |
| Modifier and Type | Method and Description |
|---|---|
ResponsesObject |
build() |
static ResponsesObjectBuilder |
mergeResponses(ResponsesObject primary,
ResponsesObject secondary)
Creates a new build by merging two exising responses
|
static ResponsesObjectBuilder |
responsesObject()
Creates a builder for a
ResponsesObject |
ResponsesObjectBuilder |
withDefaultValue(ResponseObject defaultValue) |
ResponsesObjectBuilder |
withHttpStatusCodes(Map<String,ResponseObject> httpStatusCodes) |
public ResponsesObjectBuilder withDefaultValue(ResponseObject defaultValue)
defaultValue - The documentation of responses other than the ones declared for specific HTTP response codes.
Use this field to cover undeclared responses.public ResponsesObjectBuilder withHttpStatusCodes(Map<String,ResponseObject> httpStatusCodes)
httpStatusCodes - To define a range of response codes, this field MAY contain the uppercase wildcard character
X. For example, 2XX represents all response codes between
[200-299]. The following range definitions are allowed: 1XX,
2XX, 3XX, 4XX, and 5XX. If a response
range is defined using an explicit code, the explicit code definition takes precedence over
the range definition for that code.public ResponsesObject build()
public static ResponsesObjectBuilder responsesObject()
ResponsesObjectpublic static ResponsesObjectBuilder mergeResponses(ResponsesObject primary, ResponsesObject secondary)
primary - A responses object to use. This is the dominant response who's values will
be preferred when values cannot be merged (such as ResponseObject.descriptionsecondary - The other responses objectCopyright © 2017–2019. All rights reserved.