Packages

abstract class Api extends NamedDomainElement with ServerContainer with DocumentedElement

Web Api internal model

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

Inherited from DocumentedElement

Inherited from ServerContainer

Inherited from NamedDomainElement

Inherited from DomainElement

Inherited from AmfObject

Inherited from AmfElement

Inherited from AnyRef

Inherited from Any

Ungrouped