water.api

Class DocsBase<I extends Iced,S extends DocsBase<I,S>>

java.lang.Object

water.Iced

water.api.Schema<I,DocsBase<I,S>>

water.api.DocsBase<I,S>

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable, java.lang.Cloneable, Freezable

Direct Known Subclasses:

DocsV1

public class DocsBase<I extends Iced,S extends DocsBase<I,S>>
extends Schema<I,DocsBase<I,S>>

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class water.api.Schema

Schema.Meta

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	classname
java.lang.String	http_method
java.lang.String	markdown
int	num
java.lang.String	path
RouteBase[]	routes
java.lang.String	schemaname
SchemaMetadataBase[]	schemas

Fields inherited from class water.api.Schema

__meta, _impl_class, _version_pattern

Constructor Summary

Constructors

Constructor and Description
DocsBase()

Method Summary

Methods inherited from class water.api.Schema

acceptsFrame, createAndFillImpl, createImpl, extractVersion, fillFromImpl, fillFromParms, fillImpl, getHighestSupportedVersion, getImplClass, getImplClass, getLatestVersion, getSchemaVersion, markdown, markdown, markdown, markdown, newInstance, register, registerAllSchemasIfNecessary, schema, schema, schema, schema, schema, schemaClass, schemaClass, schemaClass, schemaClass, schemas

Methods inherited from class water.Iced

clone, frozenType, read_impl, read, readExternal, readJSON_impl, readJSON, toJsonString, write_impl, write, writeExternal, writeHTML_impl, writeHTML, writeJSON_impl, writeJSON

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

num

@API(help="Number for specifying an endpoint",
     json=false)
public int num

http_method

@API(help="HTTP method (GET, POST, DELETE) if fetching by path",
     json=false)
public java.lang.String http_method

path

@API(help="Path for specifying an endpoint",
     json=false)
public java.lang.String path

classname

@API(help="Class name, for fetching docs for a schema (DEPRECATED)",
     json=false)
public java.lang.String classname

schemaname

@API(help="Schema name (e.g., DocsV1), for fetching docs for a schema",
     json=false)
public java.lang.String schemaname

routes

@API(help="List of endpoint routes",
     direction=OUTPUT)
public RouteBase[] routes

schemas

@API(help="List of schemas",
     direction=OUTPUT)
public SchemaMetadataBase[] schemas

markdown

@API(help="Table of Contents Markdown",
     direction=OUTPUT)
public java.lang.String markdown

Constructor Detail

DocsBase

public DocsBase()