case class WebApi(_internal: plugins.domain.webapi.models.WebApi) extends DomainElement with Product with Serializable

WebApi model class.

Annotations
@JSExportAll()
Linear Supertypes
Serializable, Serializable, Product, Equals, DomainElement, PlatformSecrets, AmfObjectWrapper, Annotable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. WebApi
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. DomainElement
  7. PlatformSecrets
  8. AmfObjectWrapper
  9. Annotable
  10. AnyRef
  11. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new WebApi()
    Annotations
    @JSExportTopLevel( "model.domain.WebApi" )
  2. new WebApi(_internal: plugins.domain.webapi.models.WebApi)

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def accepts: ClientList[StrField]
  5. def annotations(): Annotations
    Definition Classes
    AmfObjectWrapper → Annotable
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  8. def contentType: ClientList[StrField]
  9. def customDomainProperties: convert.CoreClientConverters.ClientList[DomainExtension]
    Definition Classes
    DomainElement
  10. def description: StrField
  11. def documentations: ClientList[CreativeWork]
  12. def endPoints: ClientList[EndPoint]
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def extendsNode: convert.CoreClientConverters.ClientList[DomainElement]
    Definition Classes
    DomainElement
  15. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  16. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. def graph(): Graph
    Definition Classes
    DomainElement
  18. def id: String
    Definition Classes
    DomainElement
  19. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  20. def license: License
  21. def name: StrField
  22. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  23. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  24. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  25. val platform: Platform
    Definition Classes
    PlatformSecrets
  26. def position: Range
    Definition Classes
    DomainElement
  27. def provider: Organization
  28. def schemes: ClientList[StrField]
  29. def security: ClientList[ParametrizedSecurityScheme]
  30. def servers: ClientList[Server]
  31. def sourceVendor: Option[Vendor]
  32. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  33. def termsOfService: StrField
  34. def version: StrField
  35. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  36. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  37. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  38. def withAccepts(accepts: ClientList[String]): WebApi.this.type

    Set accepts property of this WebApi.

  39. def withContentType(contentType: ClientList[String]): WebApi.this.type

    Set contentType property of this WebApi.

  40. def withCustomDomainProperties(extensions: convert.CoreClientConverters.ClientList[DomainExtension]): WebApi.this.type
    Definition Classes
    DomainElement
  41. 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.

  42. def withDescription(description: String): WebApi.this.type

    Set description property of this WebApi.

  43. def withDocumentation(documentations: ClientList[CreativeWork]): WebApi.this.type

    Set documentation property of this WebApi using a CreativeWork

  44. 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.

  45. 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.

  46. 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.

  47. def withEndPoints(endPoints: ClientList[EndPoint]): WebApi.this.type

    Set endPoints property of this WebApi.

  48. def withExtendsNode(extension: convert.CoreClientConverters.ClientList[ParametrizedDeclaration]): WebApi.this.type
    Definition Classes
    DomainElement
  49. def withId(id: String): WebApi.this.type
    Definition Classes
    DomainElement
  50. def withLicense(license: License): WebApi.this.type

    Set license property of this WebApi using a License

  51. def withName(name: String): WebApi.this.type

    Set name property of this WebApi.

  52. def withProvider(provider: Organization): WebApi.this.type

    Set provider property of this WebApi using a Organization

  53. def withSchemes(schemes: ClientList[String]): WebApi.this.type

    Set schemes property of this WebApi.

  54. def withSecurity(security: ClientList[ParametrizedSecurityScheme]): WebApi.this.type

    Set security property of this WebApi using a list of ParametrizedSecurityScheme

  55. 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.

  56. def withServers(servers: ClientList[Server]): WebApi.this.type

    Set servers property of this WebApi using a list of Server objects.

  57. def withTermsOfService(terms: String): WebApi.this.type

    Set termsOfService property of this WebApi.

  58. def withVersion(version: String): WebApi.this.type

    Set version property of this WebApi.

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from DomainElement

Inherited from PlatformSecrets

Inherited from AmfObjectWrapper

Inherited from Annotable

Inherited from AnyRef

Inherited from Any

Ungrouped