org.coursera.naptime

schema

package schema

Visibility
  1. Public
  2. All

Type Members

  1. final class ArbitraryBytesBody extends ScalaRecordTemplate with Product

    If a resource would like to return arbitrary bodies, it should have this as its schema.

    If a resource would like to return arbitrary bodies, it should have this as its schema. (e.g. if a resource would like to return an image as part of an operation. TODO(saeta): Determine if we want to even include this in Naptime, or if we want to support this in some other manner.

    Annotations
    @Generated()
  2. final class Attribute extends ScalaRecordTemplate with Product

    Extra data related to an entity including deprecation information or documentation.

    Extra data related to an entity including deprecation information or documentation. Other uses of attributes include annotations to override defaults for code-generated clients. TODO(saeta): Move this to a proper scala type with a coercer and extra information.

    Annotations
    @Generated()
  3. final class AttributeArray extends IndexedSeq[Attribute] with Product with GenTraversable[Attribute] with ScalaArrayTemplate

    Annotations
    @Generated()
  4. sealed abstract class CustomBodyType extends ScalaUnionTemplate with Product

    Annotations
    @Generated()
  5. final class Handler extends ScalaRecordTemplate with Product

    The schema for a particular resource's Naptime handler.

    The schema for a particular resource's Naptime handler.

    Annotations
    @Generated()
  6. final class HandlerArray extends IndexedSeq[Handler] with Product with GenTraversable[Handler] with ScalaArrayTemplate

    Annotations
    @Generated()
  7. sealed abstract class HandlerKind extends ScalaEnumTemplateSymbol

  8. final class JsValue extends ScalaRecordTemplate with Product

    An empty record that allows us to package arbitrary Javascript data in a structured manner.

    An empty record that allows us to package arbitrary Javascript data in a structured manner. Note: this is entirely an escape hatch from the Schema type system. Use judiciously!

    Annotations
    @Generated()
  9. final class Parameter extends ScalaRecordTemplate with Product

    Information regarding a [query] parameter to a Naptime Handler.

    Information regarding a [query] parameter to a Naptime Handler.

    Annotations
    @Generated()
  10. final class ParameterArray extends IndexedSeq[Parameter] with Product with GenTraversable[Parameter] with ScalaArrayTemplate

    Annotations
    @Generated()
  11. final class Resource extends ScalaRecordTemplate with Product

    The schema for representing a Naptime resource.

    The schema for representing a Naptime resource.

    Annotations
    @Generated()
  12. final class ResourceDataSchema extends ScalaRecordTemplate with Product

    Marker type identifying a Pegasus data schema.

    Marker type identifying a Pegasus data schema. Because Pegasus data schemas are not self describing, they are represented in Courier with this record. Instances of this record will, however, be non-empty-- their underlying DataMap will contain the JSON representation of a Pegasus data schema.

    Annotations
    @Generated()
  13. final class ResourceDataSchemaMap extends Iterable[(String, ResourceDataSchema)] with Map[String, ResourceDataSchema] with MapLike[String, ResourceDataSchema, Map[String, ResourceDataSchema]] with DataTemplate[DataMap]

    Annotations
    @Generated()
  14. sealed abstract class ResourceKind extends ScalaEnumTemplateSymbol

  15. final class ResourceSchemas extends ScalaRecordTemplate with Product

    The schema of a naptime resource plus the data schemas used in that resourceSchema.

    The schema of a naptime resource plus the data schemas used in that resourceSchema.

    Annotations
    @Generated()

Value Members

  1. object ArbitraryBytesBody extends RecordCompanion

  2. object Attribute extends RecordCompanion

  3. object AttributeArray extends ArrayCompanion

  4. object CustomBodyType extends UnionCompanion with UnionWithTyperefCompanion

  5. object Handler extends RecordCompanion

  6. object HandlerArray extends ArrayCompanion

  7. object HandlerKind extends ScalaEnumTemplate[HandlerKind]

    Annotations
    @Generated()
  8. object JsValue extends RecordCompanion

  9. object Parameter extends RecordCompanion

  10. object ParameterArray extends ArrayCompanion

  11. object Resource extends RecordCompanion

  12. object ResourceDataSchema extends RecordCompanion

  13. object ResourceDataSchemaMap

  14. object ResourceKind extends ScalaEnumTemplate[ResourceKind]

    An enumeration of the main types of resources.

    An enumeration of the main types of resources.

    Annotations
    @Generated()
  15. object ResourceSchemas extends RecordCompanion

Ungrouped