package models
Ordering
- Alphabetic
Visibility
- Public
- Protected
Type Members
- sealed trait ApiAccess extends AnyRef
- sealed trait ApiAccessType extends AnyRef
- case class ApiAvailability(endpointsEnabled: Boolean, access: ApiAccess, loggedIn: Boolean, authorised: Boolean) extends Product with Serializable
- sealed trait ApiCategory extends AnyRef
- case class ApiDefinition(serviceName: ServiceName, serviceBaseUrl: String, name: String, description: String, context: ApiContext, versions: Map[ApiVersionNbr, ApiVersion], requiresTrust: Boolean = false, isTestSupport: Boolean = false, lastPublishedAt: Option[Instant] = None, categories: List[ApiCategory]) extends Product with Serializable
- sealed trait ApiStatus extends AnyRef
- case class ApiVersion(versionNbr: ApiVersionNbr, status: ApiStatus, access: ApiAccess = ApiAccess.PUBLIC, endpoints: List[Endpoint], endpointsEnabled: Boolean = true, awsRequestId: Option[String] = None, versionSource: ApiVersionSource = ApiVersionSource.UNKNOWN) extends Product with Serializable
- sealed trait ApiVersionSource extends AnyRef
- sealed trait AuthType extends AnyRef
- case class Endpoint(uriPattern: String, endpointName: String, method: HttpMethod, authType: AuthType, throttlingTier: ResourceThrottlingTier = ResourceThrottlingTier.UNLIMITED, scope: Option[String] = None, queryParameters: List[QueryParameter] = List.empty) extends Product with Serializable
- case class ExtendedApiDefinition(serviceName: ServiceName, serviceBaseUrl: String, name: String, description: String, context: ApiContext, versions: List[ExtendedApiVersion], requiresTrust: Boolean, isTestSupport: Boolean, lastPublishedAt: Option[Instant], categories: List[ApiCategory] = List.empty) extends Product with Serializable
- case class ExtendedApiVersion(version: ApiVersionNbr, status: ApiStatus, endpoints: List[Endpoint], productionAvailability: Option[ApiAvailability], sandboxAvailability: Option[ApiAvailability]) extends Product with Serializable
- sealed trait HttpMethod extends AnyRef
- sealed trait Locator[T] extends AnyRef
- final case class MappedApiDefinitions(wrapped: Map[ApiContext, ApiDefinition]) extends AnyVal with Product with Serializable
- case class QueryParameter(name: String, required: Boolean = false) extends Product with Serializable
- sealed trait ResourceThrottlingTier extends AnyRef
- final case class ServiceName(value: String) extends AnyVal with Product with Serializable
- case class StoredApiDefinition(serviceName: ServiceName, serviceBaseUrl: String, name: String, description: String, context: ApiContext, versions: List[ApiVersion], requiresTrust: Boolean = false, isTestSupport: Boolean = false, lastPublishedAt: Option[Instant] = None, categories: List[ApiCategory]) extends Product with Serializable
- sealed trait SubscriptionThrottlingTier extends AnyRef
Value Members
- object ApiAccess
- object ApiAccessType
- object ApiAvailability extends Serializable
- object ApiCategory
- object ApiDefinition extends Serializable
- object ApiStatus
- object ApiVersion extends Serializable
- object ApiVersionSource
- object ApiVersions
- object AuthType
- object Endpoint extends Serializable
- object ExtendedApiDefinition extends Serializable
- object ExtendedApiVersion extends Serializable
- object HttpMethod
- object Locator
- object LocatorSyntax
- object MappedApiDefinitions extends Serializable
- object QueryParameter extends Serializable
- object ResourceThrottlingTier
- object ServiceName extends Serializable
- object StoredApiDefinition extends Serializable
- object SubscriptionThrottlingTier