hcq/MaxScale
hcq/MaxScale
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
14,985 Commits 1 Branch 0 Tags
Commit Graph

87 Commits

Author SHA1 Message Date
Markus Mäkelä
b953e0c395
Merge branch '2.3' into 2.4 2020-12-01 06:36:34 +02:00
Markus Mäkelä
080232e7ef
MXS-3245: Document REST API responses 2020-11-30 11:27:48 +02:00
Markus Mäkelä
5a33d45d4d
Merge branch '2.3' into 2.4 2020-11-16 09:25:43 +02:00
Markus Mäkelä
9dd736d4eb
MXS-3245: Document /v1/maxscale/ REST API responses 2020-11-16 09:20:51 +02:00
Markus Mäkelä
c49f17f428
MXS-3295: Fix layout of the classify endpoint 
The values were stored in the parameters object which is used for
configuration parameters in other endpoints. The proper place for them is
inside the attributes object.
 2020-11-16 09:20:50 +02:00
Markus Mäkelä
702e88d3d6
MXS-3240: Document /maxscale/threads/:id values 
The values are somewhat cryptic without documentation.
 2020-10-19 15:08:07 +03:00
Markus Mäkelä
65bfda445d
MXS-3013: Document /v1/services/:service/reload 2020-06-01 19:40:49 +03:00
Markus Mäkelä
deae315dce
Correct PUT /server documentation 
The stale state was nonsensical and the drain state was missing.
 2020-05-11 08:19:48 +03:00
Markus Mäkelä
6fdb7ed089
Merge remote-tracking branch 'origin/2.3' into 2.4 2020-03-30 10:23:35 +03:00
Markus Mäkelä
a412ed6211
Fix monitor REST API documentation 
The DELETE documentation had the wrong endpoint.
 2020-03-30 08:53:54 +03:00
Markus Mäkelä
80a8fd55be
Merge branch '2.3' into 2.4 2020-03-19 15:13:19 +02:00
Markus Mäkelä
a8e2584bfc
Fix REST API servers documentation 
Always use plural form of the objects. PATCH example used PUT.
 2020-03-19 15:13:02 +02:00
Markus Mäkelä
b555115fa2
Merge branch '2.3' into 2.4 2020-01-07 11:12:02 +02:00
Markus Mäkelä
edb49d6f35
MXS-2824: Document basic user privileges 
The documentation was not clear on what the difference between admin and
basic accounts is.
 2020-01-07 10:40:41 +02:00
Markus Mäkelä
2f3afa943c
Add missing quotes to REST API documentation 
The example data is JSON, not JavaScript, which means that object keys
must be double-quoted.
 2019-12-12 10:09:12 +02:00
Markus Mäkelä
8960d2df8f
Merge branch '2.3' into 2.4 2019-07-04 09:39:52 +03:00
Markus Mäkelä
a3bbba0a3d
Update REST API ETag documentation 
The ETag docuemntation did not mention what sort of changes triggered ETag
updates.
 2019-07-03 10:25:30 +03:00
Markus Mäkelä
60d2bfc538
Update REST-API documentation 
The /users/inet endpoint now supports PATCH.
 2019-06-28 13:54:12 +03:00
Markus Mäkelä
1d87a1c3bc
MXS-2483: Document REST API corrections 
The protocol parameter must always be explicitly defined.
 2019-05-28 14:34:50 +03:00
Esa Korhonen
e3b5ba9620 MXS-1973 Support reverse DNS for client hostnames in MaxCtrl 
May slow maxscale down when used. Only supported for "list sessions",
"show sessions" and "show session <id>".
 2019-05-08 15:04:44 +03:00
Markus Mäkelä
5ac24de6b0
Remove log_to_shm 
The feature was removed in 2.3 and was ignored if configured.
 2019-05-06 16:05:50 +03:00
Markus Mäkelä
810dc06d5c
Document removal of ndbclustermon and mmmon 2019-04-24 14:06:27 +03:00
Markus Mäkelä
3e41a601f8
MXS-2411: Implicitly use latest API version 
The request API prefix is now simply ignored as it has no meaning as long
as there is a single version of the API.
 2019-04-18 13:58:34 +03:00
Markus Mäkelä
2f243b8f08
MXS-2349: Document socket 
Added documentation for the parameter and changed the minimum required
server definition in the REST API.
 2019-04-16 11:52:38 +03:00
Markus Mäkelä
a102efa01f
Backport: Document the force option for set 
Added documentation for the new option and mentioned it in the release
notes.
 2019-04-09 09:43:19 +03:00
Markus Mäkelä
b54e67223f
MXS-2423: Add missing parameters to maxscale endpoint 
Also updated the REST API documentation to include the newer output
(automating this update would be valuable).
 2019-04-05 13:33:16 +03:00
Markus Mäkelä
4e796189b2
Document REST API policies 
Added the API versioning guarantees that are currently promised.
 2018-11-05 13:43:22 +02:00
Johan Wikman
868c6c4e4b MXS-1779 Add REST-API documentation 2018-10-31 10:19:40 +02:00
Markus Mäkelä
cd92b6d4d7
MXS-2122: Close listener socket on destruction 
Even though directly closing the socket is not very neat in the
architectural sense of things, it allows the best of both worlds: the
socket is instantly closed and is open for reuse while the listener struct
is still available as a reference.

This change needs to be revised when the listeners are refactored into
separate objects.

Updated documentation to reflect the change in behavior.
 2018-10-31 09:53:50 +02:00
Markus Mäkelä
3998a6e469
Update REST API documentation 
Updated and unified the documentation of the REST API.
 2018-10-04 11:31:15 +03:00
Markus Mäkelä
d8d0b1a29c
Merge branch '2.2' into develop 2018-09-20 12:21:53 +03:00
Markus Mäkelä
f29d3d5588
MXS-2055: Fix monitor REST API documentation 
Fixed the endpoint documentation.
 2018-09-19 20:32:39 +03:00
Markus Mäkelä
0da0306ace
Merge branch '2.2' into develop 2018-08-15 18:08:52 +03:00
Markus Mäkelä
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
Markus Mäkelä
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
Markus Mäkelä
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
Markus Mäkelä
66061be58b
Remove duplicate REST API section 
The listeners section was duplicated. Also fixed a typo.
 2018-08-09 18:56:58 +03:00
Markus Mäkelä
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
Markus Mäkelä
490d8c0963
Merge branch '2.2' into develop 2018-04-30 12:38:19 +03:00
Markus Mäkelä
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
Markus Mäkelä
f4bdf3012d
Merge branch '2.2' into develop 2018-04-23 14:20:32 +03:00
Markus Mäkelä
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
Markus Mäkelä
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
Johan Wikman
fb62c7957a Change mysqlmon to mariadbmon 
Some places had not been updated.
 2018-01-05 11:47:46 +02:00
Johan Wikman
d64868f058 Change MySQL[Client|Backend] to MariaDB[Client|Backend] 2018-01-05 10:01:50 +02:00
Markus Mäkelä
3a78b716b8 Merge branch '2.2' into 2.2-mrm 2017-10-30 11:06:34 +02:00
Markus Mäkelä
0bfe89b86b Update REST API documentation 
Added relationships endpoint documentation.
 2017-10-23 19:37:24 +03:00
Markus Mäkelä
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
Markus Mäkelä
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
Markus Mäkelä
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