[
https://issues.apache.org/jira/browse/FALCON-151?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Raghav Kumar Gautam reassigned FALCON-151:
------------------------------------------
Assignee: Raghav Kumar Gautam
> Document the REST APIs for Falcon
> ---------------------------------
>
> Key: FALCON-151
> URL: https://issues.apache.org/jira/browse/FALCON-151
> Project: Falcon
> Issue Type: Improvement
> Components: docs
> Affects Versions: 0.3
> Reporter: Venkatesh Seetharam
> Assignee: Raghav Kumar Gautam
> Priority: Minor
>
> There are 3 resources:
> * entities
> * instance
> * admin
> *Methods allowed on Entity Resource*
> {code}
> VALIDATE("api/entities/validate/", HttpMethod.POST,
> MediaType.TEXT_XML),
> SUBMIT("api/entities/submit/", HttpMethod.POST, MediaType.TEXT_XML),
> UPDATE("api/entities/update/", HttpMethod.POST, MediaType.TEXT_XML),
> SUBMITandSCHEDULE("api/entities/submitAndSchedule/", HttpMethod.POST,
> MediaType.TEXT_XML),
> SCHEDULE("api/entities/schedule/", HttpMethod.POST,
> MediaType.TEXT_XML),
> SUSPEND("api/entities/suspend/", HttpMethod.POST, MediaType.TEXT_XML),
> RESUME("api/entities/resume/", HttpMethod.POST, MediaType.TEXT_XML),
> DELETE("api/entities/delete/", HttpMethod.DELETE, MediaType.TEXT_XML),
> STATUS("api/entities/status/", HttpMethod.GET, MediaType.TEXT_XML),
> DEFINITION("api/entities/definition/", HttpMethod.GET,
> MediaType.TEXT_XML),
> LIST("api/entities/list/", HttpMethod.GET, MediaType.TEXT_XML),
> DEPENDENCY("api/entities/dependencies/", HttpMethod.GET,
> MediaType.TEXT_XML);
> {code}
> *Methods allowed on Feed/Process Instance Resource*
> {code}
> RUNNING("api/instance/running/", HttpMethod.GET,
> MediaType.APPLICATION_JSON),
> STATUS("api/instance/status/", HttpMethod.GET,
> MediaType.APPLICATION_JSON),
> KILL("api/instance/kill/", HttpMethod.POST,
> MediaType.APPLICATION_JSON),
> SUSPEND("api/instance/suspend/", HttpMethod.POST,
> MediaType.APPLICATION_JSON),
> RESUME("api/instance/resume/", HttpMethod.POST,
> MediaType.APPLICATION_JSON),
> RERUN("api/instance/rerun/", HttpMethod.POST,
> MediaType.APPLICATION_JSON),
> LOG("api/instance/logs/", HttpMethod.GET, MediaType.APPLICATION_JSON);
> {code}
> *Methods allowed on Admin Resource*
> {code}
> STACK("api/admin/stack", HttpMethod.GET, MediaType.TEXT_PLAIN),
> VERSION("api/admin/version", HttpMethod.GET, MediaType.TEXT_PLAIN);
> {code}
> Wonder why entity resource returns XML but others JSON. Must be because
> entities themselves are defined as XML.
--
This message was sent by Atlassian JIRA
(v6.1#6144)