Packages

abstract class Api extends NamedDomainElement with SecuredElement with ServerContainer with DocumentedElement

Web Api internal model

Linear Supertypes
DocumentedElement, ServerContainer, SecuredElement, NamedDomainElement, DomainElement, CustomizableElement, AmfObject, AmfElement, AnyRef, Any
Known Subclasses
AsyncApi, WebApi
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Api
  2. DocumentedElement
  3. ServerContainer
  4. SecuredElement
  5. NamedDomainElement
  6. DomainElement
  7. CustomizableElement
  8. AmfObject
  9. AmfElement
  10. AnyRef
  11. Any
  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. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def accepts: Seq[StrField]
  5. def add(field: Field, value: AmfElement): Api.this.type
    Definition Classes
    AmfObject
  6. def add(other: Annotations): Api.this.type
    Definition Classes
    AmfElement
  7. def add(annotation: Annotation): Api.this.type
    Definition Classes
    AmfElement
  8. def adopted(parent: String, cycle: Seq[String]): Api.this.type
    Definition Classes
    AmfObject
  9. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  10. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  11. def cloneElement(branch: Map[AmfObject, AmfObject]): AmfObject
    Definition Classes
    AmfObject → AmfElement
  12. 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
  13. def contentType: Seq[StrField]
  14. def customDomainProperties: Seq[DomainExtension]
    Definition Classes
    DomainElement → CustomizableElement
  15. def description: StrField
  16. def documentations: Seq[CreativeWork]
    Definition Classes
    Api → DocumentedElement
  17. def endPoints: Seq[EndPoint]
  18. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  20. def extend: Seq[DomainElement]
    Definition Classes
    DomainElement
  21. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  22. def fromLocal(): Boolean
    Definition Classes
    AmfElement
  23. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  24. lazy val graph: Graph
    Definition Classes
    DomainElement
  25. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  26. val id: String
    Definition Classes
    AmfObject
  27. def identifier: StrField
  28. def isExternalLink: BoolField
    Definition Classes
    DomainElement
  29. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  30. def isTrackedBy(trackId: String): Boolean
    Definition Classes
    AmfElement
  31. def license: License
  32. def location(): Option[String]
    Definition Classes
    AmfElement
  33. def name: StrField
    Definition Classes
    NamedDomainElement
  34. def nameField: Field
    Definition Classes
    Api → NamedDomainElement
  35. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  36. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  37. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  38. def position(): Option[LexicalInformation]
    Definition Classes
    AmfElement
  39. def provider: Organization
  40. def removeServers(): Unit
    Definition Classes
    Api → ServerContainer
  41. def schemes: Seq[StrField]
  42. def security: Seq[SecurityRequirement]
    Definition Classes
    SecuredElement
  43. def servers: Seq[Server]
    Definition Classes
    Api → ServerContainer
  44. def set(field: Field, value: AmfElement, annotations: Annotations): Api.this.type
    Definition Classes
    AmfObject
  45. def set(field: Field, value: AmfElement): Api.this.type
    Definition Classes
    AmfObject
  46. def set(field: Field, values: Seq[String]): Api.this.type
    Definition Classes
    AmfObject
  47. def set(field: Field, value: Float): Api.this.type
    Definition Classes
    AmfObject
  48. def set(field: Field, value: Double): Api.this.type
    Definition Classes
    AmfObject
  49. def set(field: Field, value: Int): Api.this.type
    Definition Classes
    AmfObject
  50. def set(field: Field, value: Boolean): Api.this.type
    Definition Classes
    AmfObject
  51. def set(field: Field, value: String): Api.this.type
    Definition Classes
    AmfObject
  52. def setArray(field: Field, values: Seq[AmfElement], annotations: Annotations): Api.this.type
    Definition Classes
    AmfObject
  53. def setArray(field: Field, values: Seq[AmfElement]): Api.this.type
    Definition Classes
    AmfObject
  54. def setArrayWithoutId(field: Field, values: Seq[AmfElement], annotations: Annotations): Api.this.type
    Definition Classes
    AmfObject
  55. def setArrayWithoutId(field: Field, values: Seq[AmfElement]): Api.this.type
    Definition Classes
    AmfObject
  56. def setWithoutId(field: Field, value: AmfElement, annotations: Annotations): Api.this.type
    Definition Classes
    AmfObject
  57. final def simpleAdoption(parent: String): Api.this.type
    Definition Classes
    AmfObject
  58. def sourceVendor: Option[Vendor]
  59. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  60. def tags: Seq[Tag]
  61. def termsOfService: StrField
  62. def toString(): String
    Definition Classes
    AnyRef → Any
  63. def version: StrField
  64. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  65. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  66. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  67. def withAccepts(accepts: Seq[String]): Api.this.type
  68. def withContentType(contentType: Seq[String]): Api.this.type
  69. def withCustomDomainProperties(extensions: Seq[DomainExtension]): Api.this.type
    Definition Classes
    DomainElement → CustomizableElement
  70. def withCustomDomainProperty(extensions: DomainExtension): Api.this.type
    Definition Classes
    DomainElement → CustomizableElement
  71. def withDefaultServer(url: String): Server
  72. def withDescription(description: String): Api.this.type
  73. def withDocumentationTitle(title: String): CreativeWork
  74. def withDocumentationUrl(url: String): CreativeWork
  75. def withDocumentations(documentations: Seq[CreativeWork]): Api.this.type
  76. def withEndPoint(path: String): EndPoint
  77. def withEndPoints(endPoints: Seq[EndPoint]): Api.this.type
  78. def withExtends(extend: Seq[DomainElement]): Api.this.type
    Definition Classes
    DomainElement
  79. def withId(value: String): Api.this.type
    Definition Classes
    AmfObject
  80. def withIdentifier(identifier: String): Api.this.type
  81. def withIsExternalLink(isReference: Boolean): Api.this.type
    Definition Classes
    DomainElement
  82. def withLicense(license: License): Api.this.type
  83. def withName(name: String, a: Annotations): Api.this.type
    Definition Classes
    NamedDomainElement
  84. def withProvider(provider: Organization): Api.this.type
  85. def withSchemes(schemes: Seq[String]): Api.this.type
  86. def withSecurity(name: String): SecurityRequirement
    Definition Classes
    SecuredElement
  87. def withSecurity(security: Seq[SecurityRequirement]): Api.this.type
    Definition Classes
    SecuredElement
  88. def withServer(url: String): Server
  89. def withServers(servers: Seq[Server]): Api.this.type
    Definition Classes
    Api → ServerContainer
  90. def withTags(tags: Seq[Tag]): Api.this.type
  91. def withTermsOfService(terms: String): Api.this.type
  92. def withVersion(version: String): Api.this.type

Inherited from DocumentedElement

Inherited from ServerContainer

Inherited from SecuredElement

Inherited from NamedDomainElement

Inherited from DomainElement

Inherited from CustomizableElement

Inherited from AmfObject

Inherited from AmfElement

Inherited from AnyRef

Inherited from Any

Ungrouped