Packages

abstract class Api extends NamedDomainElement with SecuredElement with ServerContainer with DocumentedElement with VersionedAmfObject

Web Api internal model

Linear Supertypes
VersionedAmfObject, VersionField, DocumentedElement, ServerContainer, SecuredElement, NamedDomainElement, DomainElement, CustomizableElement, NamedAmfObject, AmfObject, AmfElement, AnyRef, Any
Known Subclasses
AsyncApi, WebApi
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Api
  2. VersionedAmfObject
  3. VersionField
  4. DocumentedElement
  5. ServerContainer
  6. SecuredElement
  7. NamedDomainElement
  8. DomainElement
  9. CustomizableElement
  10. NamedAmfObject
  11. AmfObject
  12. AmfElement
  13. AnyRef
  14. 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(fields: Fields, annotations: Annotations)

Abstract Value Members

  1. abstract val annotations: Annotations
    Definition Classes
    AmfElement
  2. abstract val fields: Fields
    Definition Classes
    AmfObject
  3. abstract def meta: Obj
    Definition Classes
    AmfObject

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 to any2stringadd[Api] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (Api, B)
    Implicit
    This member is added by an implicit conversion from Api to ArrowAssoc[Api] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. val Version: Field
    Definition Classes
    VersionField
  7. def accepts: Seq[StrField]
  8. def add(field: Field, value: AmfElement): Api.this.type
    Definition Classes
    AmfObject
  9. def add(other: Annotations): Api.this.type
    Definition Classes
    AmfElement
  10. def add(annotation: Annotation): Api.this.type
    Definition Classes
    AmfElement
  11. def adopted(parent: String, cycle: Seq[String]): Api.this.type
    Definition Classes
    AmfObject
  12. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  13. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  14. def cloneElement(branch: Map[AmfObject, AmfObject]): AmfObject
    Definition Classes
    AmfObject → AmfElement
  15. def componentId: String

    Value , path + field value that is used to compose the id when the object its adopted

    Value , path + field value that is used to compose the id when the object its adopted

    Definition Classes
    Api → AmfObject
  16. def contentType: Seq[StrField]
  17. def customDomainProperties: Seq[DomainExtension]
    Definition Classes
    DomainElement → CustomizableElement
  18. def description: StrField
  19. def documentations: Seq[CreativeWork]
    Definition Classes
    Api → DocumentedElement
  20. def endPoints: Seq[EndPoint]
  21. def ensuring(cond: (Api) ⇒ Boolean, msg: ⇒ Any): Api
    Implicit
    This member is added by an implicit conversion from Api to Ensuring[Api] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  22. def ensuring(cond: (Api) ⇒ Boolean): Api
    Implicit
    This member is added by an implicit conversion from Api to Ensuring[Api] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  23. def ensuring(cond: Boolean, msg: ⇒ Any): Api
    Implicit
    This member is added by an implicit conversion from Api to Ensuring[Api] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  24. def ensuring(cond: Boolean): Api
    Implicit
    This member is added by an implicit conversion from Api to Ensuring[Api] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  25. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  26. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  27. def extend: Seq[DomainElement]
    Definition Classes
    DomainElement
  28. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from Api to StringFormat[Api] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  29. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  30. lazy val graph: Graph
    Definition Classes
    DomainElement
  31. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  32. val id: String
    Definition Classes
    AmfObject
  33. def identifier: StrField
  34. def isExternalLink: BoolField
    Definition Classes
    DomainElement
  35. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  36. def isTrackedBy(trackId: String): Boolean
    Definition Classes
    AmfElement
  37. def license: License
  38. def location(): Option[String]
    Definition Classes
    AmfElement
  39. def name: StrField
    Definition Classes
    NamedAmfObject
  40. def nameField: Field
    Definition Classes
    Api → NamedAmfObject
  41. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  42. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  43. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  44. def position(): Option[LexicalInformation]
    Definition Classes
    AmfElement
  45. def provider: Organization
  46. def removeServers(): Unit
    Definition Classes
    Api → ServerContainer
  47. def schemes: Seq[StrField]
  48. def security: Seq[SecurityRequirement]
    Definition Classes
    SecuredElement
  49. def servers: Seq[Server]
    Definition Classes
    Api → ServerContainer
  50. def set(field: Field, value: AmfElement, annotations: Annotations): Api.this.type
    Definition Classes
    AmfObject
  51. def set(field: Field, value: AmfElement): Api.this.type
    Definition Classes
    AmfObject
  52. def set(field: Field, values: Seq[String]): Api.this.type
    Definition Classes
    AmfObject
  53. def set(field: Field, value: Float): Api.this.type
    Definition Classes
    AmfObject
  54. def set(field: Field, value: Double): Api.this.type
    Definition Classes
    AmfObject
  55. def set(field: Field, value: Int): Api.this.type
    Definition Classes
    AmfObject
  56. def set(field: Field, value: Boolean): Api.this.type
    Definition Classes
    AmfObject
  57. def set(field: Field, value: String, annotations: Annotations): Api.this.type
    Definition Classes
    AmfObject
  58. def set(field: Field, value: String): Api.this.type
    Definition Classes
    AmfObject
  59. def setArray(field: Field, values: Seq[AmfElement], annotations: Annotations): Api.this.type
    Definition Classes
    AmfObject
  60. def setArray(field: Field, values: Seq[AmfElement]): Api.this.type
    Definition Classes
    AmfObject
  61. def setArrayWithoutId(field: Field, values: Seq[AmfElement], annotations: Annotations): Api.this.type
    Definition Classes
    AmfObject
  62. def setArrayWithoutId(field: Field, values: Seq[AmfElement]): Api.this.type
    Definition Classes
    AmfObject
  63. def setWithoutId(field: Field, value: AmfElement, annotations: Annotations): Api.this.type
    Definition Classes
    AmfObject
  64. final def simpleAdoption(parent: String): Api.this.type
    Definition Classes
    AmfObject
  65. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  66. def tags: Seq[Tag]
  67. def termsOfService: StrField
  68. def toString(): String
    Definition Classes
    AnyRef → Any
  69. def typeIris: Seq[String]
    Definition Classes
    DomainElement → CustomizableElement
  70. def version: StrField

    Return AmfObject version.

    Return AmfObject version.

    Definition Classes
    VersionedAmfObject
  71. def versionField: Field
    Attributes
    protected
    Definition Classes
    VersionedAmfObject
  72. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  73. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  74. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  75. def withAccepts(accepts: Seq[String]): Api.this.type
  76. def withContentType(contentType: Seq[String]): Api.this.type
  77. def withCustomDomainProperties(extensions: Seq[DomainExtension]): Api.this.type
    Definition Classes
    DomainElement → CustomizableElement
  78. def withCustomDomainProperty(extensions: DomainExtension): Api.this.type
    Definition Classes
    DomainElement → CustomizableElement
  79. def withDefaultServer(url: String): Server
  80. def withDescription(description: String): Api.this.type
  81. def withDocumentationTitle(title: String): CreativeWork
  82. def withDocumentationUrl(url: String): CreativeWork
  83. def withDocumentations(documentations: Seq[CreativeWork]): Api.this.type
  84. def withEndPoint(path: String): EndPoint
  85. def withEndPoints(endPoints: Seq[EndPoint]): Api.this.type
  86. def withExtends(extend: Seq[DomainElement]): Api.this.type
    Definition Classes
    DomainElement
  87. def withId(value: String): Api.this.type
    Definition Classes
    AmfObject
  88. def withIdentifier(identifier: String): Api.this.type
  89. def withInferredName(name: String): Api.this.type
    Definition Classes
    NamedAmfObject
  90. def withIsExternalLink(isReference: Boolean): Api.this.type
    Definition Classes
    DomainElement
  91. def withLicense(license: License): Api.this.type
  92. def withName(name: String): Api.this.type
    Definition Classes
    NamedAmfObject
  93. def withName(nameNode: ScalarNode): Api.this.type
    Definition Classes
    NamedAmfObject
  94. def withName(name: String, a: Annotations): Api.this.type
    Definition Classes
    NamedAmfObject
  95. def withName(node: YNode): Api.this.type
    Definition Classes
    NamedAmfObject
  96. def withProvider(provider: Organization): Api.this.type
  97. def withSchemes(schemes: Seq[String]): Api.this.type
  98. def withSecurity(name: String): SecurityRequirement
    Definition Classes
    SecuredElement
  99. def withSecurity(security: Seq[SecurityRequirement]): Api.this.type
    Definition Classes
    SecuredElement
  100. def withServer(url: String): Server
  101. def withServers(servers: Seq[Server]): Api.this.type
    Definition Classes
    Api → ServerContainer
  102. def withSynthesizeName(name: String): Api.this.type
    Definition Classes
    NamedAmfObject
  103. def withTags(tags: Seq[Tag]): Api.this.type
  104. def withTermsOfService(terms: String): Api.this.type
  105. def withVersion(version: String): Api.this.type
    Definition Classes
    VersionedAmfObject
  106. def withVersion(versionNode: ScalarNode): Api.this.type

    Update AmfObject version.

    Update AmfObject version.

    Definition Classes
    VersionedAmfObject
  107. def withVersion(version: String, a: Annotations): Api.this.type
    Definition Classes
    VersionedAmfObject
  108. def withVersion(node: YNode): Api.this.type
    Definition Classes
    VersionedAmfObject
  109. def →[B](y: B): (Api, B)
    Implicit
    This member is added by an implicit conversion from Api to ArrowAssoc[Api] 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

Inherited from VersionedAmfObject

Inherited from VersionField

Inherited from DocumentedElement

Inherited from ServerContainer

Inherited from SecuredElement

Inherited from NamedDomainElement

Inherited from DomainElement

Inherited from CustomizableElement

Inherited from NamedAmfObject

Inherited from AmfObject

Inherited from AmfElement

Inherited from AnyRef

Inherited from Any

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

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

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

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

Ungrouped