models

Type Members

1. case class Code(generatorGuid: UUID, source: String) extends Product with Serializable

   

   Generated source code.

2. case class Domain(name: String) extends Product with Serializable

   

   Represents a single domain name (e.g.

   Represents a single domain name (e.g. www.apidoc.me). When a new user registers and confirms their email, we automatically associate that user with a member of the organization associated with their domain. For example, if you confirm your account with an email address of [email protected], we will automatically add you as a member to the organization with domain gilt.com.

3. case class Error(code: String, message: String) extends Product with Serializable

   

4. case class Generator(guid: UUID, key: String, uri: String, name: String, language: Option[String] = None, description: Option[String] = None, visibility: Visibility, ownerGuid: UUID, enabled: Boolean) extends Product with Serializable

   

   An apidoc generator

5. case class Healthcheck(status: String) extends Product with Serializable

   

6. case class Membership(guid: UUID, user: User, organization: Organization, role: String) extends Product with Serializable

   

   A membership represents a user in a specific role to an organization.

   A membership represents a user in a specific role to an organization. Memberships cannot be created directly. Instead you first create a membership request, then that request is either accepted or declined.

7. case class MembershipRequest(guid: UUID, user: User, organization: Organization, role: String) extends Product with Serializable

   

   A membership request represents a user requesting to join an organization with a specific role (e.g.

   A membership request represents a user requesting to join an organization with a specific role (e.g. as a member or an admin). Membership requests can be reviewed by any current admin of the organization who can either accept or decline the request.

8. case class Organization(guid: UUID, key: String, name: String, domains: Seq[Domain] = Nil, metadata: Option[OrganizationMetadata] = None) extends Product with Serializable

   

   An organization is used to group a set of services together.

9. case class OrganizationMetadata(visibility: Option[Visibility] = None, packageName: Option[String] = None) extends Product with Serializable

   

   Supplemental (non-required) information about an organization

10. case class Service(guid: UUID, name: String, key: String, visibility: Visibility, description: Option[String] = None) extends Product with Serializable

    

    A service has a name and multiple versions of an API (Interface).

11. case class User(guid: UUID, email: String, name: Option[String] = None) extends Product with Serializable

    

    A user is a top level person interacting with the api doc server.

12. case class Validation(valid: Boolean, errors: Seq[String] = Nil) extends Product with Serializable

    

    Used only to validate json files - used as a resource where http status code defines success

13. case class Version(guid: UUID, version: String, json: String) extends Product with Serializable

    

    Represents a unique version of the service.

14. sealed trait Visibility extends AnyRef

    

    Controls who is able to view this version