Packages

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

Api model class.

Annotations
@JSExportAll()
Linear Supertypes
NamedDomainElement, DomainElement, CustomizableElement, 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. CustomizableElement
  5. PlatformSecrets
  6. AmfObjectWrapper
  7. Annotable
  8. ApiFieldSetter
  9. AnyRef
  10. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Api(_internal: scala.model.domain.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 withTags(servers: ClientList[Tag]): A
    Definition Classes
    ApiFieldSetter
  14. abstract def withTermsOfService(terms: String): A
    Definition Classes
    ApiFieldSetter
  15. 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. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from Api[A] to any2stringadd[Api[A]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (Api[A], B)
    Implicit
    This member is added by an implicit conversion from Api[A] to ArrowAssoc[Api[A]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. def accepts: ClientList[StrField]
  7. def annotations(): Annotations
    Definition Classes
    AmfObjectWrapper → Annotable
  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  10. def contentType: ClientList[StrField]
  11. def customDomainProperties: core.internal.convert.CoreClientConverters.ClientList[DomainExtension]
    Definition Classes
    DomainElement → CustomizableElement
  12. def description: StrField
  13. def documentations: ClientList[CreativeWork]
  14. def endPoints: ClientList[EndPoint]
  15. def ensuring(cond: (Api[A]) ⇒ Boolean, msg: ⇒ Any): Api[A]
    Implicit
    This member is added by an implicit conversion from Api[A] to Ensuring[Api[A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. def ensuring(cond: (Api[A]) ⇒ Boolean): Api[A]
    Implicit
    This member is added by an implicit conversion from Api[A] to Ensuring[Api[A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  17. def ensuring(cond: Boolean, msg: ⇒ Any): Api[A]
    Implicit
    This member is added by an implicit conversion from Api[A] to Ensuring[Api[A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  18. def ensuring(cond: Boolean): Api[A]
    Implicit
    This member is added by an implicit conversion from Api[A] to Ensuring[Api[A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  19. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  21. def extendsNode: core.internal.convert.CoreClientConverters.ClientList[DomainElement]
    Definition Classes
    DomainElement
  22. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from Api[A] to StringFormat[Api[A]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  23. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  24. def graph(): Graph
    Definition Classes
    DomainElement
  25. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  26. def id: String
    Definition Classes
    DomainElement
  27. def identifier: StrField
  28. def isExternalLink: BoolField
    Definition Classes
    DomainElement
  29. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  30. def license: License
  31. def name: StrField
    Definition Classes
    Api → NamedDomainElement
  32. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  33. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  34. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  35. val platform: Platform
    Definition Classes
    PlatformSecrets
  36. def position: Range
    Definition Classes
    DomainElement
  37. def provider: Organization
  38. def schemes: ClientList[StrField]
  39. def security: ClientList[SecurityRequirement]
  40. def servers: ClientList[Server]
  41. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  42. def tags: ClientList[Tag]
  43. def termsOfService: StrField
  44. def toString(): String
    Definition Classes
    AnyRef → Any
  45. def version: StrField
  46. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  47. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  48. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  49. def withCustomDomainProperties(extensions: core.internal.convert.CoreClientConverters.ClientList[DomainExtension]): Api.this.type
    Definition Classes
    DomainElement → CustomizableElement
  50. 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.

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

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

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

  54. def withExtendsNode(extension: core.internal.convert.CoreClientConverters.ClientList[ParametrizedDeclaration]): Api.this.type
    Definition Classes
    DomainElement
  55. def withId(id: String): Api.this.type
    Definition Classes
    DomainElement
  56. def withIsExternalLink(isExternalLink: Boolean): DomainElement
    Definition Classes
    DomainElement
  57. 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.

  58. def →[B](y: B): (Api[A], B)
    Implicit
    This member is added by an implicit conversion from Api[A] to ArrowAssoc[Api[A]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated @deprecated
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

Inherited from NamedDomainElement

Inherited from DomainElement

Inherited from CustomizableElement

Inherited from PlatformSecrets

Inherited from AmfObjectWrapper

Inherited from Annotable

Inherited from ApiFieldSetter[A]

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from Api[A] to any2stringadd[Api[A]]

Inherited by implicit conversion StringFormat from Api[A] to StringFormat[Api[A]]

Inherited by implicit conversion Ensuring from Api[A] to Ensuring[Api[A]]

Inherited by implicit conversion ArrowAssoc from Api[A] to ArrowAssoc[Api[A]]

Ungrouped