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 withName(name: String): Api.this.type
    Definition Classes
    NamedDomainElement

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. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  23. def license: License
  24. def name: StrField
    Definition Classes
    Api → NamedDomainElement
  25. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  26. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  27. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  28. val platform: Platform
    Definition Classes
    PlatformSecrets
  29. def position: Range
    Definition Classes
    DomainElement
  30. def provider: Organization
  31. def schemes: ClientList[StrField]
  32. def security: ClientList[SecurityRequirement]
  33. def servers: ClientList[Server]
  34. def sourceVendor: Option[Vendor]
  35. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  36. def termsOfService: StrField
  37. def toString(): String
    Definition Classes
    AnyRef → Any
  38. def version: StrField
  39. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  40. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  41. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  42. def withAccepts(accepts: ClientList[String]): A

    Set accepts property of this WebApi.

    Set accepts property of this WebApi.

    Definition Classes
    ApiFieldSetter
  43. def withContentType(contentType: ClientList[String]): A

    Set contentType property of this WebApi.

    Set contentType property of this WebApi.

    Definition Classes
    ApiFieldSetter
  44. def withCustomDomainProperties(extensions: convert.CoreClientConverters.ClientList[DomainExtension]): Api.this.type
    Definition Classes
    DomainElement
  45. 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.

  46. def withDescription(description: String): A

    Set description property of this WebApi.

    Set description property of this WebApi.

    Definition Classes
    ApiFieldSetter
  47. def withDocumentation(documentations: ClientList[CreativeWork]): A

    Set documentation property of this WebApi using a CreativeWork

    Set documentation property of this WebApi using a CreativeWork

    Definition Classes
    ApiFieldSetter
  48. 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.

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

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

  51. def withEndPoints(endPoints: ClientList[EndPoint]): A

    Set endPoints property of this WebApi.

    Set endPoints property of this WebApi.

    Definition Classes
    ApiFieldSetter
  52. def withExtendsNode(extension: convert.CoreClientConverters.ClientList[ParametrizedDeclaration]): Api.this.type
    Definition Classes
    DomainElement
  53. def withId(id: String): Api.this.type
    Definition Classes
    DomainElement
  54. def withIdentifier(identifier: String): A

    Set identifier property of this WebApi.

    Set identifier property of this WebApi.

    Definition Classes
    ApiFieldSetter
  55. def withLicense(license: License): A

    Set license property of this WebApi using a License

    Set license property of this WebApi using a License

    Definition Classes
    ApiFieldSetter
  56. def withProvider(provider: Organization): A

    Set provider property of this WebApi using a Organization

    Set provider property of this WebApi using a Organization

    Definition Classes
    ApiFieldSetter
  57. def withSchemes(schemes: ClientList[String]): A

    Set schemes property of this WebApi.

    Set schemes property of this WebApi.

    Definition Classes
    ApiFieldSetter
  58. def withSecurity(security: ClientList[SecurityRequirement]): A

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

  60. def withServers(servers: ClientList[Server]): A

    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
  61. def withTermsOfService(terms: String): A

    Set termsOfService property of this WebApi.

    Set termsOfService property of this WebApi.

    Definition Classes
    ApiFieldSetter
  62. def withVersion(version: String): A

    Set version property of this WebApi.

    Set version property of this WebApi.

    Definition Classes
    ApiFieldSetter

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