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
- final case class ApiContext(value: String) extends AnyVal with Product with Serializable
- case class ApiDefinition(serviceName: String, serviceBaseUrl: String, name: String, description: String, context: ApiContext, versions: List[ApiVersion], requiresTrust: Option[Boolean], isTestSupport: Option[Boolean] = None, lastPublishedAt: Option[Instant] = None, categories: Option[List[ApiCategory]] = None) extends Product with Serializable
- final case class ApiIdentifier(context: ApiContext, versionNbr: ApiVersionNbr) extends Product with Serializable
- sealed trait ApiStatus extends AnyRef
- case class ApiVersion(version: ApiVersionNbr, status: ApiStatus, access: Option[ApiAccess] = Some(ApiAccess.PUBLIC), endpoints: List[Endpoint], endpointsEnabled: Option[Boolean] = None, awsRequestId: Option[String] = None, versionSource: ApiVersionSource = ApiVersionSource.UNKNOWN) extends Product with Serializable
- final case class ApiVersionNbr(value: String) extends AnyVal with 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, scope: Option[String] = None, queryParameters: Option[List[QueryParameter]] = None) extends Product with Serializable
- case class ExtendedAPIDefinition(serviceName: String, serviceBaseUrl: String, name: String, description: String, context: ApiContext, requiresTrust: Boolean, isTestSupport: Boolean, versions: List[ExtendedAPIVersion], lastPublishedAt: Option[Instant]) 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
- case class QueryParameter(name: String, required: Boolean = false) extends Product with Serializable
- sealed trait ResourceThrottlingTier extends AnyRef
- sealed trait SubscriptionThrottlingTier extends AnyRef
Value Members
- object ApiAccess
- object ApiAccessType
- object ApiAvailability extends Serializable
- object ApiCategory
- object ApiContext extends Serializable
- object ApiDefinition extends Serializable
- object ApiIdentifier extends Serializable
- object ApiStatus
- object ApiVersion extends Serializable
- object ApiVersionNbr extends Serializable
- object ApiVersionSource
- object AuthType
- object Endpoint extends Serializable
- object ExtendedAPIDefinition extends Serializable
- object ExtendedAPIVersion extends Serializable
- object HttpMethod
- object QueryParameter extends Serializable
- object ResourceThrottlingTier
- object SubscriptionThrottlingTier