abstract class Api[A] extends ApiFieldSetter[A] with DomainElement with NamedDomainElement

Api model class.

Annotations
@JSExportAll()
Linear Supertypes
NamedDomainElement, DomainElement, PlatformSecrets, AmfObjectWrapper, Annotable, ApiFieldSetter[A], AnyRef, Any
Known Subclasses
AsyncApi, WebApi
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Api
  2. NamedDomainElement
  3. DomainElement
  4. PlatformSecrets
  5. AmfObjectWrapper
  6. Annotable
  7. ApiFieldSetter
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Api(_internal: plugins.domain.webapi.models.api.Api)

Abstract Value Members

  1. abstract def withAccepts(accepts: ClientList[String]): A
    Definition Classes
    ApiFieldSetter
  2. abstract def withContentType(contentType: ClientList[String]): A
    Definition Classes
    ApiFieldSetter
  3. abstract def withDescription(description: String): A
    Definition Classes
    ApiFieldSetter
  4. abstract def withDocumentation(documentations: ClientList[CreativeWork]): A
    Definition Classes
    ApiFieldSetter
  5. abstract def withEndPoints(endPoints: ClientList[EndPoint]): A
    Definition Classes
    ApiFieldSetter
  6. abstract def withIdentifier(identifier: String): A
    Definition Classes
    ApiFieldSetter
  7. abstract def withLicense(license: License): A
    Definition Classes
    ApiFieldSetter
  8. abstract def withName(name: String): Api.this.type
    Definition Classes
    NamedDomainElement
  9. abstract def withProvider(provider: Organization): A
    Definition Classes
    ApiFieldSetter
  10. abstract def withSchemes(schemes: ClientList[String]): A
    Definition Classes
    ApiFieldSetter
  11. abstract def withSecurity(security: ClientList[SecurityRequirement]): A
    Definition Classes
    ApiFieldSetter
  12. abstract def withServers(servers: ClientList[Server]): A
    Definition Classes
    ApiFieldSetter
  13. abstract def withTermsOfService(terms: String): A
    Definition Classes
    ApiFieldSetter
  14. abstract def withVersion(version: String): A
    Definition Classes
    ApiFieldSetter

Concrete 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[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  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 equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  15. def extendsNode: convert.CoreClientConverters.ClientList[DomainElement]
    Definition Classes
    DomainElement
  16. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  17. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  18. def graph(): Graph
    Definition Classes
    DomainElement
  19. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  20. def id: String
    Definition Classes
    DomainElement
  21. def identifier: StrField
  22. def isExternalLink: BoolField
    Definition Classes
    DomainElement
  23. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  24. def license: License
  25. def name: StrField
    Definition Classes
    Api → NamedDomainElement
  26. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  27. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  28. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  29. val platform: Platform
    Definition Classes
    PlatformSecrets
  30. def position: Range
    Definition Classes
    DomainElement
  31. def provider: Organization
  32. def schemes: ClientList[StrField]
  33. def security: ClientList[SecurityRequirement]
  34. def servers: ClientList[Server]
  35. def sourceVendor: Option[Vendor]
  36. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  37. def termsOfService: StrField
  38. def toString(): String
    Definition Classes
    AnyRef → Any
  39. def version: StrField
  40. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  41. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  42. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  43. def withCustomDomainProperties(extensions: convert.CoreClientConverters.ClientList[DomainExtension]): Api.this.type
    Definition Classes
    DomainElement
  44. 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.

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

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

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

  48. def withExtendsNode(extension: convert.CoreClientConverters.ClientList[ParametrizedDeclaration]): Api.this.type
    Definition Classes
    DomainElement
  49. def withId(id: String): Api.this.type
    Definition Classes
    DomainElement
  50. def withIsExternalLink(isExternalLink: Boolean): DomainElement
    Definition Classes
    DomainElement
  51. 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.

Inherited from NamedDomainElement

Inherited from DomainElement

Inherited from PlatformSecrets

Inherited from AmfObjectWrapper

Inherited from Annotable

Inherited from ApiFieldSetter[A]

Inherited from AnyRef

Inherited from Any

Ungrouped