case class WebApi(_internal: plugins.domain.webapi.models.api.WebApi) extends Api[WebApi] with Product with Serializable
- Annotations
- @JSExportAll()
- Alphabetic
- By Inheritance
- WebApi
- Serializable
- Serializable
- Product
- Equals
- Api
- NamedDomainElement
- DomainElement
- PlatformSecrets
- AmfObjectWrapper
- Annotable
- ApiFieldSetter
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
-
new
WebApi()
- Annotations
- @JSExportTopLevel( "model.domain.WebApi" )
- new WebApi(_internal: plugins.domain.webapi.models.api.WebApi)
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
accepts: ClientList[StrField]
- Definition Classes
- Api
-
def
annotations(): Annotations
- Definition Classes
- AmfObjectWrapper → Annotable
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
def
contentType: ClientList[StrField]
- Definition Classes
- Api
-
def
customDomainProperties: convert.CoreClientConverters.ClientList[DomainExtension]
- Definition Classes
- DomainElement
-
def
description: StrField
- Definition Classes
- Api
-
def
documentations: ClientList[CreativeWork]
- Definition Classes
- Api
-
def
endPoints: ClientList[EndPoint]
- Definition Classes
- Api
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
extendsNode: convert.CoreClientConverters.ClientList[DomainElement]
- Definition Classes
- DomainElement
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
graph(): Graph
- Definition Classes
- DomainElement
-
def
id: String
- Definition Classes
- DomainElement
-
def
identifier: StrField
- Definition Classes
- Api
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
def
license: License
- Definition Classes
- Api
-
def
name: StrField
- Definition Classes
- Api → NamedDomainElement
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
val
platform: Platform
- Definition Classes
- PlatformSecrets
-
def
position: Range
- Definition Classes
- DomainElement
-
def
provider: Organization
- Definition Classes
- Api
-
def
schemes: ClientList[StrField]
- Definition Classes
- Api
-
def
security: ClientList[SecurityRequirement]
- Definition Classes
- Api
-
def
servers: ClientList[Server]
- Definition Classes
- Api
-
def
sourceVendor: Option[Vendor]
- Definition Classes
- Api
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
termsOfService: StrField
- Definition Classes
- Api
-
def
version: StrField
- Definition Classes
- Api
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
def
withAccepts(accepts: ClientList[String]): WebApi
Set accepts property of this WebApi.
Set accepts property of this WebApi.
- Definition Classes
- ApiFieldSetter
-
def
withContentType(contentType: ClientList[String]): WebApi
Set contentType property of this WebApi.
Set contentType property of this WebApi.
- Definition Classes
- ApiFieldSetter
-
def
withCustomDomainProperties(extensions: convert.CoreClientConverters.ClientList[DomainExtension]): WebApi.this.type
- Definition Classes
- DomainElement
-
def
withDefaultServer(url: String): Server
Adds one Server to the servers property of this WebApi and returns it for population.
Adds one Server to the servers property of this WebApi and returns it for population. url property of the server is required. This method marks this Server as default. When generating this Server in RAML or OAS2, it will generate a 'baseUri', 'host' or 'basePath', instead of a 'servers' annotation.
- Definition Classes
- Api
-
def
withDescription(description: String): WebApi
Set description property of this WebApi.
Set description property of this WebApi.
- Definition Classes
- ApiFieldSetter
-
def
withDocumentation(documentations: ClientList[CreativeWork]): WebApi
Set documentation property of this WebApi using a CreativeWork
Set documentation property of this WebApi using a CreativeWork
- Definition Classes
- ApiFieldSetter
-
def
withDocumentationTitle(title: String): CreativeWork
Adds one CreativeWork to the documentations property of this WebApi and returns it for population.
Adds one CreativeWork to the documentations property of this WebApi and returns it for population. Path property of the CreativeWork is required.
- Definition Classes
- Api
-
def
withDocumentationUrl(url: String): CreativeWork
Adds one CreativeWork to the documentations property of this WebApi and returns it for population.
Adds one CreativeWork to the documentations property of this WebApi and returns it for population. Path property of the CreativeWork is required.
- Definition Classes
- Api
-
def
withEndPoint(path: String): EndPoint
Adds one EndPoint to the endPoints property of this WebApi and returns it for population.
Adds one EndPoint to the endPoints property of this WebApi and returns it for population. Path property of the endPoint is required.
- Definition Classes
- Api
-
def
withEndPoints(endPoints: ClientList[EndPoint]): WebApi
Set endPoints property of this WebApi.
Set endPoints property of this WebApi.
- Definition Classes
- ApiFieldSetter
-
def
withExtendsNode(extension: convert.CoreClientConverters.ClientList[ParametrizedDeclaration]): WebApi.this.type
- Definition Classes
- DomainElement
-
def
withId(id: String): WebApi.this.type
- Definition Classes
- DomainElement
-
def
withIdentifier(identifier: String): WebApi
Set identifier property of this WebApi.
Set identifier property of this WebApi.
- Definition Classes
- ApiFieldSetter
-
def
withLicense(license: License): WebApi
Set license property of this WebApi using a License
Set license property of this WebApi using a License
- Definition Classes
- ApiFieldSetter
-
def
withName(name: String): WebApi.this.type
Set name property of this WebApi.
Set name property of this WebApi.
- Definition Classes
- WebApi → NamedDomainElement
-
def
withProvider(provider: Organization): WebApi
Set provider property of this WebApi using a Organization
Set provider property of this WebApi using a Organization
- Definition Classes
- ApiFieldSetter
-
def
withSchemes(schemes: ClientList[String]): WebApi
Set schemes property of this WebApi.
Set schemes property of this WebApi.
- Definition Classes
- ApiFieldSetter
-
def
withSecurity(security: ClientList[SecurityRequirement]): WebApi
Set security property of this WebApi using a list of SecurityRequirement
Set security property of this WebApi using a list of SecurityRequirement
- Definition Classes
- ApiFieldSetter
-
def
withServer(url: String): Server
Adds one Server to the servers property of this WebApi and returns it for population.
Adds one Server to the servers property of this WebApi and returns it for population. url property of the server is required.
- Definition Classes
- Api
-
def
withServers(servers: ClientList[Server]): WebApi
Set servers property of this WebApi using a list of Server objects.
Set servers property of this WebApi using a list of Server objects.
- Definition Classes
- ApiFieldSetter
-
def
withTermsOfService(terms: String): WebApi
Set termsOfService property of this WebApi.
Set termsOfService property of this WebApi.
- Definition Classes
- ApiFieldSetter
-
def
withVersion(version: String): WebApi
Set version property of this WebApi.
Set version property of this WebApi.
- Definition Classes
- ApiFieldSetter