Documenation fixes: Updated json formatting, links in readme, and add…

…ed sphinx dependencies
eclipse-volttron · Oct 3, 2023 · 0cf49c3 · 0cf49c3
1 parent 252f863
commit 0cf49c3
Show file tree

Hide file tree

Showing 23 changed files with 100 additions and 639 deletions.
diff --git a/README.md b/README.md
@@ -66,7 +66,7 @@ and web_secret_key should not be included. If SSL is not desired,
 provide a web_secret_key instead and remove the lines for the web_ssl_cert
 and web_ssl_key. Any string can be used for the web_secret_key.
 
-Full VOLTTRON documentation is available at [VOLTTRON Readthedocs](https://volttron.readthedocs.io)
+Full VOLTTRON documentation is available at [VOLTTRON Readthedocs](https://eclipse-volttron.readthedocs.io/)
 
 
 ## Use
@@ -77,7 +77,7 @@ configuration shown above). This will create a file called web-users.json in the
 
 Additionally, the web service provides a RESTful API which can be used by other applications. Full documentation for
 the API is available on 
-[Readthedocs](https://volttron.readthedocs.io/en/modular/external-docs/volttron-lib-web/docs/source/index.html).
+[Readthedocs](https://eclipse-volttron.readthedocs.io/en/latest/external-docs/volttron-lib-web/docs/source/index.html).
 
 Note that it is necessary for most API endpoints to have previously created a username and password for authentication
 by visiting the /admin page or by manually copying or creating a web-users.json file. Authentication can then be

diff --git a/docs/source/authentication-endpoints.rst b/docs/source/authentication-endpoints.rst
@@ -47,7 +47,7 @@ Request:
 - Content Type: ``application/json``
 - Body:
 
-  .. code-block:: JSON
+  .. code-block:: javascript
 
         {
             "username": "<username>",
@@ -61,7 +61,7 @@ Response:
     - Content Type: ``application/json``
     - Body:
 
-      .. code-block:: JSON
+      .. code-block:: javascript
 
             {
                 "refresh_token": "<jwt_refresh_token>",
@@ -90,7 +90,7 @@ Request:
 - Authorization: ``BEARER <jwt_refresh_token>``
 - Body (optional):
 
-  .. code-block:: JSON
+  .. code-block:: javascript
 
         {
           "current_access_token": "<jwt_access_token>"
@@ -103,7 +103,7 @@ Response:
     - Content Type: ``application/json``
     - Body:
 
-      .. code-block:: JSON
+      .. code-block:: javascript
 
             {
                 "access_token": "<new_jwt_access_token>"

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -65,7 +65,7 @@ creating a user and password:
 
 .. image:: files/create_admin_user.png
 
-.. code-block:: json
+.. code-block:: javascript
 
     {
     "my_user":{
@@ -98,7 +98,7 @@ to be readable and discoverable:
 Get requests to non-leaf nodes typically return a `route-options` JSON object which gives additional possible paths
 within the API. For instance, a GET request send to the path `/vui` will return:
 
-.. code-block:: json
+.. code-block:: javascript
 
     {
     "route_options": {

diff --git a/docs/source/platform-endpoints.rst b/docs/source/platform-endpoints.rst
@@ -28,6 +28,7 @@ through the following links:
     All endpoints in this tree require authorization using a JWT bearer
     token provided by the ``POST /authenticate`` or ``PUT /authenticate``
     endpoints.
+
 --------------------------------------------------------------------------------
 
 GET /platforms
@@ -51,7 +52,7 @@ Response:
     - Content Type: ``application/json``
     - Body:
 
-      .. code-block:: JSON
+      .. code-block:: javascript
 
             {
                 "route_options": {
@@ -64,13 +65,14 @@ Response:
     - Content Type: ``application/json``
     - Body:
 
-      .. code-block:: JSON
+      .. code-block:: javascript
 
             {
              "error": "<Error Message>"
             }
 
 * **With invalid BEARER token:** ``401 Unauthorized``
+
 ---------------------------------------------------------------------------------------------------------------------
 
 GET /platforms/:platform
@@ -98,7 +100,7 @@ Response:
     - Content Type: ``application/json``
     - Body:
 
-      .. code-block:: JSON
+      .. code-block:: javascript
 
             {
                 "route_options": {
@@ -111,7 +113,7 @@ Response:
     - Content Type: ``application/json``
     - Body:
 
-      .. code-block:: JSON
+      .. code-block:: javascript
 
             {
              "error": "<Error Message>"

diff --git a/docs/source/platforms/agent-endpoints.rst b/docs/source/platforms/agent-endpoints.rst
@@ -50,7 +50,7 @@ Response:
     - Content Type: ``application/json``
     - Body:
 
-      .. code-block:: JSON
+      .. code-block:: javascript
 
             {
                 "route_options": {
@@ -63,7 +63,7 @@ Response:
     - Content Type: ``application/json``
     - Body:
 
-      .. code-block:: JSON
+      .. code-block:: javascript
 
             {
                 "error": "<Error Message>"
@@ -91,7 +91,7 @@ Response:
     - Content Type: ``application/json``
     - Body:
 
-      .. code-block:: JSON
+      .. code-block:: javascript
 
             {
                 "route_options": {
@@ -104,7 +104,7 @@ Response:
     - Content Type: ``application/json``
     - Body:
 
-      .. code-block:: JSON
+      .. code-block:: javascript
 
             {
              "error": "<Error Message>"

diff --git a/docs/source/platforms/agents/config-endpoints.rst b/docs/source/platforms/agents/config-endpoints.rst
@@ -30,7 +30,7 @@ Response
     - Content Type: ``application/json``
     - Body:
 
-      .. code-block:: JSON
+      .. code-block:: javascript
 
             {
                 "route_options": {
@@ -43,7 +43,7 @@ Response
     - Content Type: ``application/json``
     - Body:
 
-      .. code-block:: JSON
+      .. code-block:: javascript
 
             {
                 "error": "<Error Message>"
@@ -54,7 +54,7 @@ Response
 --------------------------------------------------------------------------------------------------
 
 POST /platforms/:platform/agents/:vip_identity/configs/
-=======================================================
+========================================================
 
 Save a new configuration file to the config store.
 
@@ -86,7 +86,7 @@ Response
     - Content Type: ``application/json``
     - Body:
 
-      .. code-block:: JSON
+      .. code-block:: javascript
 
             {
                 "error": "<Error Message>"
@@ -97,7 +97,7 @@ Response
 -----------------------------------------------------------------------------------------
 
 DELETE /platforms/:platform/agents/:vip_identity/configs/
-=====================================================================
+==========================================================
 
 Remove the configuration store for an agent. This endpoint will return ``409 Conflict`` if
 the store for this agent is not empty. To remove all existing configurations for an agent from the config store
@@ -119,7 +119,7 @@ Response
     - Content Type: ``application/json``
     - Body:
 
-      .. code-block:: JSON
+      .. code-block:: javascript
 
             {
                 "error": "<Error Message>"
@@ -155,7 +155,7 @@ Response
     - Content Type: ``application/json``
     - Body:
 
-      .. code-block:: JSON
+      .. code-block:: javascript
 
             {
                 "error": "<Error Message>"
@@ -190,7 +190,7 @@ Response
     - Content Type: ``application/json``
     - Body:
 
-      .. code-block:: JSON
+      .. code-block:: javascript
 
             {
                 "error": "<Error Message>"
@@ -219,7 +219,7 @@ Response
     - Content Type: ``application/json``
     - Body:
 
-      .. code-block:: JSON
+      .. code-block:: javascript
 
             {
                 "error": "<Error Message>"

diff --git a/docs/source/platforms/agents/enabled-endpoints.rst b/docs/source/platforms/agents/enabled-endpoints.rst
@@ -31,7 +31,7 @@ Response:
     - Content Type: application/json
     - Body:
 
-      .. code-block:: json
+      .. code-block:: javascript
 
             {
                 "status": true|false,
@@ -41,7 +41,7 @@ Response:
     - Content Type: ``application/json``
     - Body:
 
-      .. code-block:: JSON
+      .. code-block:: javascript
 
             {
                 "error": "<Error Message>"
@@ -75,7 +75,7 @@ Response:
     - Content Type: ``application/json``
     - Body:
 
-      .. code-block:: JSON
+      .. code-block:: javascript
 
             {
                 "error": "<Error Message>"
@@ -105,7 +105,7 @@ Response:
     - Content Type: ``application/json``
     - Body:
 
-      .. code-block:: JSON
+      .. code-block:: javascript
 
           {
               "error": "<Error Message>"

diff --git a/docs/source/platforms/agents/health-endpoints.rst b/docs/source/platforms/agents/health-endpoints.rst
@@ -30,7 +30,7 @@ Response:
     - Content Type: application/json
     - Body:
 
-      .. code-block:: json
+      .. code-block:: javascript
 
             {
                 "status": "<status_message>",
@@ -41,7 +41,7 @@ Response:
     - Content Type: ``application/json``
     - Body:
 
-      .. code-block:: JSON
+      .. code-block:: javascript
 
             {
                 "error": "<Error Message>"

diff --git a/docs/source/platforms/agents/rpc-endpoints.rst b/docs/source/platforms/agents/rpc-endpoints.rst
@@ -33,7 +33,7 @@ Response:
     - Content Type: ``application/json``
     - Body:
 
-      .. code-block:: JSON
+      .. code-block:: javascript
 
             {
                 "route_options": {
@@ -46,7 +46,7 @@ Response:
     - Content Type: ``application/json``
     - Body:
 
-      .. code-block:: JSON
+      .. code-block:: javascript
 
             {
                 "error": "<Error Message>"
@@ -81,7 +81,7 @@ Response:
     - Content Type: ``application/json``
     - Body:
 
-      .. code-block:: JSON
+      .. code-block:: javascript
 
             {
                 "params": {
@@ -106,7 +106,7 @@ Response:
     - Content Type: ``application/json``
     - Body:
 
-      .. code-block:: JSON
+      .. code-block:: javascript
 
             {
                 "error": "<Error Message>"
@@ -132,7 +132,7 @@ Request:
 * Authorization: ``BEARER <jwt_access_token>``
 * Body:
 
-  .. code-block:: JSON
+  .. code-block:: javascript
 
         {
             "<param_name>": "<value>",
@@ -150,7 +150,7 @@ Response:
     - Content Type: ``application/json``
     - Body:
 
-      .. code-block:: JSON
+      .. code-block:: javascript
 
             {
                 "error": "<Error Message>"

diff --git a/docs/source/platforms/agents/running-endpoints.rst b/docs/source/platforms/agents/running-endpoints.rst
@@ -30,16 +30,17 @@ Response:
         - Content Type: application/json
         - Body:
 
-          .. code-block:: json
+          .. code-block:: javascript
 
                 {
                     "status": true|false
                 }
+
     * **With valid BEARER token on failure:** ``400 Bad Request``
         - Content Type: ``application/json``
         - Body:
 
-          .. code-block:: JSON
+          .. code-block:: javascript
 
                 {
                     "error": "<Error Message>"
@@ -73,7 +74,7 @@ Response:
         - Content Type: ``application/json``
         - Body:
 
-          .. code-block:: JSON
+          .. code-block:: javascript
 
                 {
                     "error": "<Error Message>"
@@ -103,7 +104,7 @@ Response:
         - Content Type: ``application/json``
         - Body:
 
-          .. code-block:: JSON
+          .. code-block:: javascript
 
                 {
                     "error": "<Error Message>"