public interface Metadata
| Modifier and Type | Method and Description |
|---|---|
retrofit2.Call<MetadataV3> |
fetchRoute(java.lang.String path) |
retrofit2.Call<MetadataV3> |
fetchRoute(java.lang.String path,
int num,
java.lang.String http_method,
java.lang.String classname,
java.lang.String schemaname,
java.lang.String _exclude_fields)
Return the REST API endpoint metadata, including documentation, for the endpoint specified by path or index.
|
retrofit2.Call<MetadataV3> |
fetchSchemaMetadata(java.lang.String schemaname) |
retrofit2.Call<MetadataV3> |
fetchSchemaMetadata(java.lang.String schemaname,
int num,
java.lang.String http_method,
java.lang.String path,
java.lang.String classname,
java.lang.String _exclude_fields)
Return the REST API schema metadata for specified schema.
|
retrofit2.Call<MetadataV3> |
fetchSchemaMetadataByClass(java.lang.String classname) |
retrofit2.Call<MetadataV3> |
fetchSchemaMetadataByClass(java.lang.String classname,
int num,
java.lang.String http_method,
java.lang.String path,
java.lang.String schemaname,
java.lang.String _exclude_fields)
Return the REST API schema metadata for specified schema class.
|
retrofit2.Call<MetadataV3> |
listRoutes() |
retrofit2.Call<MetadataV3> |
listRoutes(int num,
java.lang.String http_method,
java.lang.String path,
java.lang.String classname,
java.lang.String schemaname,
java.lang.String _exclude_fields)
Return the list of (almost) all REST API endpoints.
|
retrofit2.Call<MetadataV3> |
listSchemas() |
retrofit2.Call<MetadataV3> |
listSchemas(int num,
java.lang.String http_method,
java.lang.String path,
java.lang.String classname,
java.lang.String schemaname,
java.lang.String _exclude_fields)
Return list of all REST API schemas.
|
@GET(value="/3/Metadata/endpoints") retrofit2.Call<MetadataV3> listRoutes(@Field(value="num") int num, @Field(value="http_method") java.lang.String http_method, @Field(value="path") java.lang.String path, @Field(value="classname") java.lang.String classname, @Field(value="schemaname") java.lang.String schemaname, @Field(value="_exclude_fields") java.lang.String _exclude_fields)
num - Number for specifying an endpointhttp_method - HTTP method (GET, POST, DELETE) if fetching by pathpath - Path for specifying an endpointclassname - Class name, for fetching docs for a schema (DEPRECATED)schemaname - Schema name (e.g., DocsV1), for fetching docs for a schema_exclude_fields - Comma-separated list of JSON field paths to exclude from the result, used like:
"/3/Frames?_exclude_fields=frames/frame_id/URL,__meta"@GET(value="/3/Metadata/endpoints") retrofit2.Call<MetadataV3> listRoutes()
@GET(value="/3/Metadata/endpoints/{path}")
retrofit2.Call<MetadataV3> fetchRoute(@Path(value="path")
java.lang.String path,
@Field(value="num")
int num,
@Field(value="http_method")
java.lang.String http_method,
@Field(value="classname")
java.lang.String classname,
@Field(value="schemaname")
java.lang.String schemaname,
@Field(value="_exclude_fields")
java.lang.String _exclude_fields)
path - Path for specifying an endpointnum - Number for specifying an endpointhttp_method - HTTP method (GET, POST, DELETE) if fetching by pathclassname - Class name, for fetching docs for a schema (DEPRECATED)schemaname - Schema name (e.g., DocsV1), for fetching docs for a schema_exclude_fields - Comma-separated list of JSON field paths to exclude from the result, used like:
"/3/Frames?_exclude_fields=frames/frame_id/URL,__meta"@GET(value="/3/Metadata/endpoints/{path}")
retrofit2.Call<MetadataV3> fetchRoute(@Path(value="path")
java.lang.String path)
@GET(value="/3/Metadata/schemaclasses/{classname}")
retrofit2.Call<MetadataV3> fetchSchemaMetadataByClass(@Path(value="classname")
java.lang.String classname,
@Field(value="num")
int num,
@Field(value="http_method")
java.lang.String http_method,
@Field(value="path")
java.lang.String path,
@Field(value="schemaname")
java.lang.String schemaname,
@Field(value="_exclude_fields")
java.lang.String _exclude_fields)
classname - Class name, for fetching docs for a schema (DEPRECATED)num - Number for specifying an endpointhttp_method - HTTP method (GET, POST, DELETE) if fetching by pathpath - Path for specifying an endpointschemaname - Schema name (e.g., DocsV1), for fetching docs for a schema_exclude_fields - Comma-separated list of JSON field paths to exclude from the result, used like:
"/3/Frames?_exclude_fields=frames/frame_id/URL,__meta"@GET(value="/3/Metadata/schemaclasses/{classname}")
retrofit2.Call<MetadataV3> fetchSchemaMetadataByClass(@Path(value="classname")
java.lang.String classname)
@GET(value="/3/Metadata/schemas/{schemaname}")
retrofit2.Call<MetadataV3> fetchSchemaMetadata(@Path(value="schemaname")
java.lang.String schemaname,
@Field(value="num")
int num,
@Field(value="http_method")
java.lang.String http_method,
@Field(value="path")
java.lang.String path,
@Field(value="classname")
java.lang.String classname,
@Field(value="_exclude_fields")
java.lang.String _exclude_fields)
schemaname - Schema name (e.g., DocsV1), for fetching docs for a schemanum - Number for specifying an endpointhttp_method - HTTP method (GET, POST, DELETE) if fetching by pathpath - Path for specifying an endpointclassname - Class name, for fetching docs for a schema (DEPRECATED)_exclude_fields - Comma-separated list of JSON field paths to exclude from the result, used like:
"/3/Frames?_exclude_fields=frames/frame_id/URL,__meta"@GET(value="/3/Metadata/schemas/{schemaname}")
retrofit2.Call<MetadataV3> fetchSchemaMetadata(@Path(value="schemaname")
java.lang.String schemaname)
@GET(value="/3/Metadata/schemas") retrofit2.Call<MetadataV3> listSchemas(@Field(value="num") int num, @Field(value="http_method") java.lang.String http_method, @Field(value="path") java.lang.String path, @Field(value="classname") java.lang.String classname, @Field(value="schemaname") java.lang.String schemaname, @Field(value="_exclude_fields") java.lang.String _exclude_fields)
num - Number for specifying an endpointhttp_method - HTTP method (GET, POST, DELETE) if fetching by pathpath - Path for specifying an endpointclassname - Class name, for fetching docs for a schema (DEPRECATED)schemaname - Schema name (e.g., DocsV1), for fetching docs for a schema_exclude_fields - Comma-separated list of JSON field paths to exclude from the result, used like:
"/3/Frames?_exclude_fields=frames/frame_id/URL,__meta"@GET(value="/3/Metadata/schemas") retrofit2.Call<MetadataV3> listSchemas()