Package

org.coursera.naptime

schema

Permalink

package schema

Visibility
  1. Public
  2. All

Type Members

  1. final class ArbitraryBytesBody extends ScalaRecordTemplate with Product

    Permalink

    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 ArbitraryRecord extends ScalaRecordTemplate with Product

    Permalink

    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()
  3. sealed abstract class ArbitraryValue extends ScalaUnionTemplate with Product

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

    Permalink

    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()
  5. final class AttributeArray extends IndexedSeq[Attribute] with Product with GenTraversable[Attribute] with ScalaArrayTemplate

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

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

    Permalink

    The schema for a particular resource's Naptime handler.

    The schema for a particular resource's Naptime handler.

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

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

    Permalink
  10. final class JsValue extends ScalaRecordTemplate with Product

    Permalink

    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()
  11. final class Parameter extends ScalaRecordTemplate with Product

    Permalink

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

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

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

    Permalink
    Annotations
    @Generated()
  13. final class ParameterDataSchema extends ScalaRecordTemplate with Product

    Permalink

    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()
  14. sealed abstract class RelationType extends ScalaEnumTemplateSymbol

    Permalink
  15. final class Resource extends ScalaRecordTemplate with Product

    Permalink

    The schema for representing a Naptime resource.

    The schema for representing a Naptime resource.

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

    Permalink

    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()
  17. final class ResourceDataSchemaMap extends Iterable[(String, ResourceDataSchema)] with Map[String, ResourceDataSchema] with MapLike[String, ResourceDataSchema, Map[String, ResourceDataSchema]] with DataTemplate[DataMap]

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

    Permalink
  19. final class ResourceSchemas extends ScalaRecordTemplate with Product

    Permalink

    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()
  20. final class ReverseRelationAnnotation extends ScalaRecordTemplate with Product

    Permalink

    The schema for a reverse-relation annotation.

    The schema for a reverse-relation annotation.

    Annotations
    @Generated()

Value Members

  1. object ArbitraryBytesBody extends RecordCompanion[ArbitraryBytesBody]

    Permalink
  2. object ArbitraryRecord extends RecordCompanion[ArbitraryRecord]

    Permalink
  3. object ArbitraryValue extends UnionCompanion[ArbitraryValue] with UnionWithTyperefCompanion[ArbitraryValue]

    Permalink
  4. object Attribute extends RecordCompanion[Attribute]

    Permalink
  5. object AttributeArray extends ArrayCompanion[AttributeArray]

    Permalink
  6. object CustomBodyType extends UnionCompanion[CustomBodyType] with UnionWithTyperefCompanion[CustomBodyType]

    Permalink
  7. object Handler extends RecordCompanion[Handler]

    Permalink
  8. object HandlerArray extends ArrayCompanion[HandlerArray]

    Permalink
  9. object HandlerKind extends ScalaEnumTemplate[HandlerKind]

    Permalink
    Annotations
    @Generated()
  10. object JsValue extends RecordCompanion[JsValue]

    Permalink
  11. object Parameter extends RecordCompanion[Parameter]

    Permalink
  12. object ParameterArray extends ArrayCompanion[ParameterArray]

    Permalink
  13. object ParameterDataSchema extends RecordCompanion[ParameterDataSchema]

    Permalink
  14. object RelationType extends ScalaEnumTemplate[RelationType]

    Permalink
    Annotations
    @Generated()
  15. object Resource extends RecordCompanion[Resource]

    Permalink
  16. object ResourceDataSchema extends RecordCompanion[ResourceDataSchema]

    Permalink
  17. object ResourceDataSchemaMap extends MapCompanion[ResourceDataSchemaMap]

    Permalink
  18. object ResourceKind extends ScalaEnumTemplate[ResourceKind]

    Permalink

    An enumeration of the main types of resources.

    An enumeration of the main types of resources.

    Annotations
    @Generated()
  19. object ResourceSchemas extends RecordCompanion[ResourceSchemas]

    Permalink
  20. object ReverseRelationAnnotation extends RecordCompanion[ReverseRelationAnnotation]

    Permalink

Ungrouped