api-platform-api-domain
API
Generated with
api-platform-api-domain/uk.gov.hmrc.apiplatform.modules.apis.domain.models

uk.gov.hmrc.apiplatform.modules.apis.domain.models

package uk.gov.hmrc.apiplatform.modules.apis.domain.models

Members list

Type members

Classlikes

sealed trait ApiAccess

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Controlled
object Internal
class Private
object Public
object ApiAccess

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
ApiAccess.type
enum ApiAccessType

Attributes

Companion
object
Supertypes
trait Enum
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ApiAccessType

Attributes

Companion
enum
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
case class ApiAvailability(endpointsEnabled: Boolean, access: ApiAccess, loggedIn: Boolean, authorised: Boolean)

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ApiAvailability

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
enum ApiCategory(val displayText: String)

Attributes

Companion
object
Supertypes
trait Enum
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ApiCategory

Attributes

Companion
enum
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
case class ApiDefinition(serviceName: ServiceName, serviceBaseUrl: ServiceBaseUrl, name: Name, description: Description, context: ApiContext, versions: Map[ApiVersionNbr, ApiVersion], isTestSupport: Boolean, lastPublishedAt: Option[Instant], categories: List[ApiCategory])

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ApiDefinition

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
enum ApiStatus

Attributes

Companion
object
Supertypes
trait Enum
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ApiStatus

Attributes

Companion
enum
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
ApiStatus.type
case class ApiVersion(versionNbr: ApiVersionNbr, status: ApiStatus, access: ApiAccess, endpoints: List[Endpoint], endpointsEnabled: Boolean, awsRequestId: Option[String], versionSource: ApiVersionSource = ...)

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ApiVersion

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
ApiVersion.type
enum ApiVersionSource

Attributes

Companion
object
Supertypes
trait Enum
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ApiVersionSource

Attributes

Companion
enum
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
object ApiVersions

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
enum AuthType

Attributes

Companion
object
Supertypes
trait Enum
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object AuthType

Attributes

Companion
enum
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
AuthType.type
case class Endpoint(uriPattern: UriPattern, endpointName: Name, method: HttpMethod, authType: AuthType, throttlingTier: ResourceThrottlingTier = ..., scope: Option[Scope], queryParameters: List[QueryParameter])

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Endpoint

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Endpoint.type
case class ExtendedApiDefinition(serviceName: ServiceName, serviceBaseUrl: ServiceBaseUrl, name: Name, description: Description, context: ApiContext, versions: List[ExtendedApiVersion], isTestSupport: Boolean, lastPublishedAt: Option[Instant], categories: List[ApiCategory])

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ExtendedApiDefinition

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class ExtendedApiVersion(version: ApiVersionNbr, status: ApiStatus, endpoints: List[Endpoint], productionAvailability: Option[ApiAvailability], sandboxAvailability: Option[ApiAvailability])

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ExtendedApiVersion

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
enum HttpMethod

Attributes

Companion
object
Supertypes
trait Enum
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object HttpMethod

Attributes

Companion
enum
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
HttpMethod.type
sealed trait Locator[T]

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Both[T]
class Production[T]
class Sandbox[T]
object Locator

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
Locator.type
object LocatorSyntax

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
object MappedApiDefinitions

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
case class QueryParameter(name: String, required: Boolean = ...)

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object QueryParameter

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
enum ResourceThrottlingTier

Attributes

Companion
object
Supertypes
trait Enum
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ResourceThrottlingTier

Attributes

Companion
enum
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
object Scope

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
Scope.type
object ServiceName

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
case class StoredApiDefinition(serviceName: ServiceName, serviceBaseUrl: ServiceBaseUrl, name: Name, description: Description, context: ApiContext, versions: List[ApiVersion], isTestSupport: Boolean, lastPublishedAt: Option[Instant], categories: List[ApiCategory])

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object StoredApiDefinition

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type

Types

opaque type MappedApiDefinitions
opaque type Scope
opaque type ServiceName
Generated with