jenkins-bot has submitted this change and it was merged.

Change subject: Fix documentation in README
......................................................................


Fix documentation in README

* The entry point is actually named `service-checker-swagger`.
* `x-amples` is actually a list of request/response entries.

Change-Id: I7dffd45c50dea46059fde5ee829bf0a258694f56
---
M README.rst
1 file changed, 6 insertions(+), 5 deletions(-)

Approvals:
  Giuseppe Lavagetto: Looks good to me, approved
  jenkins-bot: Verified



diff --git a/README.rst b/README.rst
index b624e17..c363130 100644
--- a/README.rst
+++ b/README.rst
@@ -22,7 +22,8 @@
 Usage
 -----
 
-Once installed, you will have the ``service-checker`` binary in your path.
+Once installed, you will have the ``service-checker-swagger`` binary
+in your path.
 
 Suppose you have a webservice running on localhost port 8080, which
 reponds for HTTP host ``awesomeservice.local`` and it
@@ -31,19 +32,19 @@
 
 .. code:: bash
 
-    $ service-checker 127.0.0.1 awesomeservice.local:8080 -s /swagger
+    $ service-checker-swagger 127.0.0.1 awesomeservice.local:8080 -s /swagger
     All endpoints are healthy
 
 
 Spec format support
 -------------------
 
-``service-checker`` checks each of the paths in your swagger/OpenAPI
+``service-checker-swagger`` checks each of the paths in your swagger/OpenAPI
 specification for an ``x-amples`` section and uses it to do live requests
 to the API and checks that the response corresponds to the base. The
 ``x-amples`` section is an extension to the swagger spec that has been
 introduced by `swagger-test <https://github.com/earldouglas/swagger-test>`_
-and that consists of a ``request`` and a ``response`` sections.
+and that consists of items with ``request`` and ``response`` sections.
 
 Url templating according to RFC 6570 is partially supported via the
 ``params`` section of the ``x-amples`` section.
@@ -60,7 +61,7 @@
    "/pets/{id}": {
        "get": {
           "x-monitor": true,
-          "x-amples": {
+          "x-amples": [ {
             "request": {
               "params": {"id": 10},
               "headers": { "Accept": "application/json", },

-- 
To view, visit https://gerrit.wikimedia.org/r/307911
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings

Gerrit-MessageType: merged
Gerrit-Change-Id: I7dffd45c50dea46059fde5ee829bf0a258694f56
Gerrit-PatchSet: 1
Gerrit-Project: operations/software/service-checker
Gerrit-Branch: master
Gerrit-Owner: Legoktm <legoktm.wikipe...@gmail.com>
Gerrit-Reviewer: Giuseppe Lavagetto <glavage...@wikimedia.org>
Gerrit-Reviewer: jenkins-bot <>

_______________________________________________
MediaWiki-commits mailing list
MediaWiki-commits@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits

Reply via email to