water.bindings.proxies.retrofit

Interface Metadata

public interface Metadata

Method Summary

Methods

Modifier and Type	Method and Description
retrofit2.Call<MetadataV3>	fetchRoute(int num) Return the REST API endpoint metadata, including documentation, for the endpoint specified by number.
retrofit2.Call<MetadataV3>	fetchRoute(java.lang.String path) Return the REST API endpoint metadata, including documentation, for the endpoint specified by path.
retrofit2.Call<MetadataV3>	fetchSchemaMetadata(java.lang.String schemaname) Return the REST API schema metadata for specified schema.
retrofit2.Call<MetadataV3>	fetchSchemaMetadataByClass(java.lang.String classname) Return the REST API schema metadata for specified schema class.
retrofit2.Call<MetadataV3>	listRoutes() Return a list of all the REST API endpoints.
retrofit2.Call<MetadataV3>	listSchemas() Return list of all REST API schemas.

Method Detail

fetchRoute

@GET(value="/3/Metadata/endpoints/(?[0-9]+)")
retrofit2.Call<MetadataV3> fetchRoute(@Path(value="num")
                                        int num)

Return the REST API endpoint metadata, including documentation, for the endpoint specified by number.

fetchRoute

@GET(value="/3/Metadata/endpoints/{path}")
retrofit2.Call<MetadataV3> fetchRoute(@Path(value="path")
                                        java.lang.String path)

Return the REST API endpoint metadata, including documentation, for the endpoint specified by path.

listRoutes

@GET(value="/3/Metadata/endpoints")
retrofit2.Call<MetadataV3> listRoutes()

Return a list of all the REST API endpoints.

fetchSchemaMetadataByClass

@GET(value="/3/Metadata/schemaclasses/{classname}")
retrofit2.Call<MetadataV3> fetchSchemaMetadataByClass(@Path(value="classname")
                                                        java.lang.String classname)

Return the REST API schema metadata for specified schema class.

fetchSchemaMetadata

@GET(value="/3/Metadata/schemas/{schemaname}")
retrofit2.Call<MetadataV3> fetchSchemaMetadata(@Path(value="schemaname")
                                                 java.lang.String schemaname)

Return the REST API schema metadata for specified schema.

listSchemas

@GET(value="/3/Metadata/schemas")
retrofit2.Call<MetadataV3> listSchemas()

Return list of all REST API schemas.