MXS-1390: Clean up services resource documentation

Cleaned up the documentation and reformatted the parameter list of
listener creation to be made out of links.

Added some comments to the resource declarations in resource.cc to prevent
the order of them from being altered.
This commit is contained in:
Markus Mäkelä
2017-09-09 11:52:09 +03:00
parent 1a196bc865
commit 3ca172f380
3 changed files with 29 additions and 33 deletions

View File

@ -777,6 +777,10 @@ public:
r->add_constraint(Resource::REQUIRE_BODY);
}
/**
* NOTE: all POST resources added after this DO NOT require a request body.
*/
/** For all module commands that modify state/data */
m_post.push_back(SResource(new Resource(cb_modulecmd, 4, "maxscale", "modules", ":module", "?")));
m_post.push_back(SResource(new Resource(cb_flush, 3, "maxscale", "logs", "flush")));
@ -795,6 +799,10 @@ public:
r->add_constraint(Resource::REQUIRE_BODY);
}
/**
* NOTE: all PATCH resources added after this DO NOT require a request body.
*/
/** Change resource states */
m_put.push_back(SResource(new Resource(cb_stop_monitor, 3, "monitors", ":monitor", "stop")));
m_put.push_back(SResource(new Resource(cb_start_monitor, 3, "monitors", ":monitor", "start")));