org.raml.v2.api.model.v10.api

Interface LibraryBase

All Superinterfaces:

Annotable

All Known Subinterfaces:

Api, Library

public interface LibraryBase
extends Annotable

Method Summary

Modifier and Type	Method and Description
List<TypeDeclaration>	annotationTypes() Declarations of annotation types for use by annotations
List<ResourceType>	resourceTypes() Declarations of resource types for use within this API
List<TypeDeclaration>	schemas() Alias for the equivalent "types" property, for compatibility with RAML 0.8.
List<SecurityScheme>	securitySchemes() Declarations of security schemes for use within this API.
List<Trait>	traits() Declarations of traits for use within this API
List<TypeDeclaration>	types() Declarations of (data) types for use within this API
List<Library>	uses() Importing external libraries that can be used within the API.

Methods inherited from interface org.raml.v2.api.model.v10.common.Annotable

annotations

Method Detail

schemas

List<TypeDeclaration> schemas()

Alias for the equivalent "types" property, for compatibility with RAML 0.8. Deprecated - API definitions should use the "types" property, as the "schemas" alias for that property name may be removed in a future RAML version. The "types" property allows for XML and JSON schemas.

types

List<TypeDeclaration> types()

Declarations of (data) types for use within this API

traits

List<Trait> traits()

Declarations of traits for use within this API

resourceTypes

List<ResourceType> resourceTypes()

Declarations of resource types for use within this API

annotationTypes

List<TypeDeclaration> annotationTypes()

Declarations of annotation types for use by annotations

securitySchemes

List<SecurityScheme> securitySchemes()

Declarations of security schemes for use within this API.

uses

List<Library> uses()

Importing external libraries that can be used within the API.