Serialized Form

  • Package io.inversion

    • Exception io.inversion.ApiException

      class ApiException extends RuntimeException implements Serializable

      • Serialized Fields

    • Class io.inversion.Collection

      class Collection extends Rule<Collection> implements Serializable

      • Serialized Fields

        • aliases
          Set<String> aliases
          Additional names that should cause this Collection to match to a Request.

          For example, in an e-commerce environment, you may overload the "orders" collection with aliases "cart", "basket", and "bag".

        • exclude
          boolean exclude
          Set this to true to prevent it from being automatically exposed through your Api.
        • indexes
          ArrayList<Index> indexes
          Representation of underlying Db datasource indexes.
        • pluralDisplayName
          String pluralDisplayName
        • properties
          ArrayList<Property> properties
          Properties map database column names to JSON property names.
        • relationships
          ArrayList<Relationship> relationships
          Relationships like resources in one collection to the resources in another collection.
        • schemaRef
          String schemaRef
          A reference to an externa OpenAPI schema that will be used in OpenAPI/documentation generation.
        • singularDisplayName
          String singularDisplayName
        • tableName
          String tableName
          The backend datasource name that this Collection operates on.

          The tableName might be "ORDER_DETAIL" but the Collection might be named "orderDetails".

    • Class io.inversion.Index

      class Index extends Object implements Serializable

    • Class io.inversion.Property

      class Property extends Object implements Serializable

      • Serialized Fields

        • autoGenerated
          boolean autoGenerated
        • collection
          Collection collection
        • columnName
          String columnName
        • description
          String description
        • documented
          boolean documented
        • exclude
          boolean exclude
        • hint
          String hint
        • jsonType
          String jsonType
        • name
          String name
        • nullable
          boolean nullable
        • pk
          Property pk
          If this Property is a foreign key, this will be populated with the referenced primary key from the referred Collection
        • readOnly
          boolean readOnly
        • regex
          String regex
        • required
          boolean required
        • revisionColumn
          boolean revisionColumn
        • timestampColumn
          boolean timestampColumn
        • type
          String type

    • Class io.inversion.Relationship

      class Relationship extends Object implements Serializable