| Modifier and Type | Method and Description |
|---|---|
List<TypeDeclaration> |
LibraryBase.annotationTypes()
Declarations of annotation types for use by annotations
|
List<TypeDeclaration> |
Api.baseUriParameters()
Named parameters used in the baseUri (template)
|
List<TypeDeclaration> |
LibraryBase.schemas()
Alias for the equivalent "types" property, for compatibility with RAML 0.8.
|
List<TypeDeclaration> |
LibraryBase.types()
Declarations of (data) types for use within this API
|
| Modifier and Type | Method and Description |
|---|---|
List<TypeDeclaration> |
Response.body()
The body of the response: a body declaration
|
List<TypeDeclaration> |
Response.headers()
Detailed information about any response headers returned by this method
|
| Modifier and Type | Interface and Description |
|---|---|
interface |
ArrayTypeDeclaration |
interface |
BooleanTypeDeclaration |
interface |
DateOnlyTypeDeclaration |
interface |
DateTimeOnlyTypeDeclaration |
interface |
DateTimeTypeDeclaration |
interface |
DateTypeDeclaration |
interface |
IntegerTypeDeclaration |
interface |
NumberTypeDeclaration |
interface |
ObjectTypeDeclaration |
interface |
StringTypeDeclaration |
interface |
TimeOnlyTypeDeclaration |
interface |
UnionTypeDeclaration |
| Modifier and Type | Method and Description |
|---|---|
TypeDeclaration |
ObjectTypeDeclaration.additionalProperties()
JSON schema style syntax for declaring maps
|
TypeDeclaration |
ArrayTypeDeclaration.items()
Array component type.
|
| Modifier and Type | Method and Description |
|---|---|
List<TypeDeclaration> |
ObjectTypeDeclaration.patternProperties()
JSON schema style syntax for declaring key restricted maps
|
List<TypeDeclaration> |
ObjectTypeDeclaration.properties()
The properties that instances of this type may or must have.
|
| Modifier and Type | Method and Description |
|---|---|
TypeDeclaration |
AnnotationRef.annotation()
Returns referenced annotation
|
| Modifier and Type | Method and Description |
|---|---|
TypeDeclaration |
Operation.queryString()
Specifies the query string needed by this method.
|
| Modifier and Type | Method and Description |
|---|---|
List<TypeDeclaration> |
MethodBase.body()
Some method verbs expect the resource to be sent as a request body.
|
List<TypeDeclaration> |
Operation.headers()
Headers that allowed at this position
|
List<TypeDeclaration> |
Operation.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.
|
| Modifier and Type | Interface and Description |
|---|---|
interface |
FileTypeDeclaration |
| Modifier and Type | Method and Description |
|---|---|
List<TypeDeclaration> |
ResourceBase.uriParameters()
Detailed information about any URI parameters of this resource
|
Copyright © 2016. All rights reserved.