3998a6e469
Update REST API documentation
...
Updated and unified the documentation of the REST API.
2018-10-04 11:31:15 +03:00
d8d0b1a29c
Merge branch '2.2' into develop
2018-09-20 12:21:53 +03:00
f29d3d5588
MXS-2055: Fix monitor REST API documentation
...
Fixed the endpoint documentation.
2018-09-19 20:32:39 +03:00
0da0306ace
Merge branch '2.2' into develop
2018-08-15 18:08:52 +03:00
09239a1c7a
MXS-1929: Update REST API documentation for filters
...
Added the DELETE and clarified the POST documentation.
2018-08-13 10:28:01 +03:00
8bbc2c3f33
MXS-1929: Clarify service destruction
...
The prgress of service destruction can be monitored via the `sessions`
endpoint.
2018-08-13 10:28:01 +03:00
f93658e487
MXS-1929: Document REST API additions for services
...
Added documentation about creation and destruction of services as well as
updates to service parameters and relationships. The direct updating of
service relationships for filters is not yet implemented.
2018-08-10 09:53:33 +03:00
66061be58b
Remove duplicate REST API section
...
The listeners section was duplicated. Also fixed a typo.
2018-08-09 18:56:58 +03:00
3de0847806
MXS-1929: Update REST API documentation for filters
...
Added the creation of filter via the POST method.
2018-07-31 09:41:05 +03:00
490d8c0963
Merge branch '2.2' into develop
2018-04-30 12:38:19 +03:00
cca39b910d
MXS-1837: Fix typo in REST API documentation
...
The documentation now has correct resource definitions for stopping and
starting services.
2018-04-30 06:27:04 +03:00
f4bdf3012d
Merge branch '2.2' into develop
2018-04-23 14:20:32 +03:00
8829e6d0c5
Reorder REST API configuration documentation
...
The REST API configuration documentation is now located after all other
global parameters in its own section. Added it to the ToC and put a link
to it into the REST API overview document.
2018-04-23 14:02:54 +03:00
c90cfc0bee
MXS-1782: Add missing thread information
...
The load averages and open/total file descriptor counts were missing from
the REST API.
2018-04-17 09:43:56 +03:00
fb62c7957a
Change mysqlmon to mariadbmon
...
Some places had not been updated.
2018-01-05 11:47:46 +02:00
d64868f058
Change MySQL[Client|Backend] to MariaDB[Client|Backend]
2018-01-05 10:01:50 +02:00
3a78b716b8
Merge branch '2.2' into 2.2-mrm
2017-10-30 11:06:34 +02:00
0bfe89b86b
Update REST API documentation
...
Added relationships endpoint documentation.
2017-10-23 19:37:24 +03:00
b223fc9482
Fix REST API main document title
...
The title still stated that it was design documentation on the API instead
of being the authoritative documentation of it.
2017-10-23 17:34:11 +03:00
40cbf37d64
Add example to REST API module command documentation
...
Added an example that demonstrates how to call a module command with
parameters via the REST API.
2017-10-12 12:29:43 +03:00
a3ba81ddbe
Add example to REST API module command documentation
...
Added an example that demonstrates how to call a module command with
parameters via the REST API.
2017-10-04 14:30:31 +03:00
4c6e7a0dbc
MXS-1446: Add preliminary documentation for passive
...
The documentation only hints at the actual implementation and it needs to
be extended once the implementation details are known.
2017-09-27 19:32:58 +03:00
3ca172f380
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.
2017-09-11 12:49:11 +03:00
1a196bc865
MXS-1390: Add SSL documentation to servers resource
...
The servers resource now shows the SSL parameters in the example
output. It also lists the parameters in the list of valid values for
parameters in the server creation section.
2017-09-11 12:49:11 +03:00
6b27111eab
MXS-1390: Update monitor resource documentation
...
Added missing DELETE request documentation and cleaned up formatting.
2017-09-11 12:49:11 +03:00
d8e88af017
MXS-1390: Update MaxScale and service resource documentation
...
Added module command and individual listener resource
documentation. Cleaned up formatting of values in the MaxScale resource
document.
2017-09-11 12:49:11 +03:00
c0411445a8
MXS-1390: Update users resource documentation
...
Updated the users resource documentation with the new changes that were
added when user authorization was added.
2017-09-11 12:49:11 +03:00
a3402dfebf
MXS-1390: Update main REST API document
...
Updated the document and removed faulty information.
2017-09-11 12:49:11 +03:00
f189de47a3
MXS-1390: Update MaxScale resource documentation
...
Added missing resource documentation for the MaxScale resource and updated
the output of existing examples.
2017-09-07 10:02:14 +03:00
cc8fb995cd
MXS-1354: Make new users backwards compatible
...
The `add user` and `enable account` commands create fully privileged
administrative users like they did in 2.1. This makes the addition of
read-only users backwards compatible.
Updated and expanded the documentation on administrative interface
users. Added entries into the release notes as well as the upgrading
document about relevant changes between 2.1 and 2.2.
2017-08-19 09:27:15 +03:00
985fea43a0
MXS-1220: Fix /sessions/ response documentation
...
The response body listed listener sessions when only client sessions are
listed.
2017-07-18 11:37:18 +03:00
f4dacff27c
MXS-1300: Correct clear entry point documentation
...
Corrected the clear entry point documentation by changing the method from
POST to PUT. Fixed MaxCtrl to use the correct methods for set/clear.
2017-07-10 22:23:48 +03:00
35745ee925
MXS-1220: Add deletion of listeners
...
The listeners can now be deleted via the REST API. Documented the added
endpoint in the REST API documentation.
2017-07-10 22:23:46 +03:00
7e40c93cc4
MXS-1220: Add listener creation documentation
...
The documentation for creating listeners was not added.
2017-07-10 22:23:45 +03:00
e0076ca8a5
MXS-1220: Fix request methods for user creation
...
The creation of network users and enabling of UNIX accounts documented PUT
as the method for enabling them when the commands actually used POST.
2017-07-10 22:23:45 +03:00
c7b9b7ac4a
MXS-1220: Unify resource member naming
...
All resoures now use the `state` member to describe their internal
state. This includes servers, services and monitors. This means that the
`status` keyword can be reserved for something else and it can be removed
until it is needed again.
Changed the module maturity field to `maturity` to better describe its
purpose.
2017-07-10 22:23:45 +03:00
a8bfdac49c
MXS-1220: Use PUT to set/clear server
...
The correct method for set/clear endpoints is PUT, not POST, as the
resource always ends up in the desired state, regardless of its current
state.
2017-07-10 22:23:45 +03:00
f62e899b79
MXS-1220: Add missing start/stop documentation for service resources
...
The service resource start and stop endpoints weren't documented.
2017-07-10 22:23:44 +03:00
63d2eee0e3
MXS-1220: Add endpoint for set/clear of server status
...
The server status can now be manipulated via the REST API. Added tests for
the state manipulation. Fixed minor issues in related code.
2017-07-10 22:23:44 +03:00
27d8212c51
Fix typo in server resource
...
The 'statistics' was mistakenly written as 'statictics'.
2017-06-27 21:45:00 +03:00
e4a004097e
MXS-1220: Add support for PATCH
...
The PATCH method should now be used instead the PUT method to update
resources. As PUT request bodies should represent complete resources, the
use of PUT to update resources is no longer supported.
Altered tests to use PATCH instead of PUT for updating resources.
2017-06-05 13:37:08 +03:00
ba546fcd21
MXS-1220: Add execution of module commands to REST API
...
The module command self links now point to an endpoint that executes the
module command. Depending on the type of the module command, either a GET
or a POST request must be made.
2017-06-02 12:52:33 +03:00
c98f8369f2
MXS-1220: Remove redundant parameter documentation
...
As all requests support the only parameter `pretty`, there's no point in
documenting it separately for each resource.
2017-05-24 16:21:34 +03:00
43386333b3
MXS-1220: Add monitor POST documentation
...
The POST documentation for creation monitors was missing.
2017-05-24 16:21:34 +03:00
830e47bc8b
MXS-1220: Update service resource documentation
...
Updated service resource documentation. Fixed a few minor typos also in
the server resource documentation.
2017-05-24 15:05:11 +03:00
9ccb54c107
MXS-1220: Update links in REST API documentation
...
Added missing v1 prefixes to links.
2017-05-24 15:05:11 +03:00
c54710cfaa
MXS-1220: Update users resource documentation
...
Updated the users resource documentation.
2017-05-24 15:05:11 +03:00
3b8bda289e
Update Resources-Session.md
...
Removed unimplemented features and updated response content.
2017-05-17 10:14:57 +03:00
f1c790db52
MXS-1220: Add logging priorities to logs resoure
...
The logging priorities can now be queried and altered.
2017-05-17 10:14:57 +03:00
05cb49d48a
MXS-1220: Add error messages to bad request
...
Requests now contain a JSON API-conforming, human-readable error message.
2017-05-17 10:14:57 +03:00
