org.raml.v2.model.v10.api

Interface Overlay

All Superinterfaces:

AbstractWrapperNode, Annotable, Api, BasicFragmentNode, BasicNode, LibraryBase

public interface Overlay
extends Api

Method Summary

Methods

Modifier and Type	Method and Description
String	extendsApi() Location of a valid RAML API definition (or overlay or extension), the overlay is applied to.
String	usage() contains description of why overlay exist

Methods inherited from interface org.raml.v2.model.v10.api.Api

baseUri, baseUriParameters, documentation, mediaType, protocols, RAMLVersion, resources, securedBy, title, version

Methods inherited from interface org.raml.v2.model.v10.api.LibraryBase

annotationTypes, resourceTypes, schemas, securitySchemes, traits, types

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

annotations

Methods inherited from interface org.raml.v2.model.v10.fragment.BasicFragmentNode

fragment

Methods inherited from interface org.raml.v2.model.v10.core.BasicNode

meta, optional, optionalProperties, parent, toJSON

Method Detail

usage

String usage()

contains description of why overlay exist

extendsApi

String extendsApi()

Location of a valid RAML API definition (or overlay or extension), the overlay is applied to.