public interface MethodBase extends RAMLLanguageElement
| Modifier and Type | Method and Description |
|---|---|
List<Parameter> |
baseUriParameters()
A resource or a method can override a base URI template's values.
|
List<BodyLike> |
body()
Some method verbs expect the resource to be sent as a request body.
|
List<Parameter> |
headers()
Headers that allowed at this position
|
List<String> |
protocols()
A method can override an API's protocols value for that single method by setting a different value for the fields.
|
List<Parameter> |
queryParameters()
An APIs resources MAY be filtered (to return a subset of results) or altered (such as transforming a response body from JSON to XML format) by the use of query strings.
|
List<Response> |
responses()
Resource methods MAY have one or more responses.
|
List<SecuritySchemeRef> |
securedBy()
A list of the security schemas to apply, these must be defined in the securitySchemes declaration.
|
descriptionList<Response> responses()
List<BodyLike> body()
List<String> protocols()
List<SecuritySchemeRef> securedBy()
List<Parameter> baseUriParameters()
List<Parameter> queryParameters()
Copyright © 2016. All rights reserved.