add rename_relationship metadata api docs (#3389)

hasura · Dec 17, 2019 · 756d8ab · 756d8ab
1 parent deeae45
commit 756d8ab
Show file tree

Hide file tree

Showing 2 changed files with 54 additions and 0 deletions.
diff --git a/docs/graphql/manual/api-reference/schema-metadata-api/index.rst b/docs/graphql/manual/api-reference/schema-metadata-api/index.rst
@@ -137,6 +137,11 @@ The various types of queries are listed in the following table:
      - 1
      - Drop an existing relationship
 
+   * - :ref:`rename_relationship`
+     - :ref:`rename_relationship_args <rename_relationship_syntax>`
+     - 1
+     - Modify name of an existing relationship
+
    * - :ref:`set_relationship_comment`
      - :ref:`set_relationship_comment_args <set_relationship_comment_syntax>`
      - 1

diff --git a/docs/graphql/manual/api-reference/schema-metadata-api/relationship.rst b/docs/graphql/manual/api-reference/schema-metadata-api/relationship.rst
@@ -453,3 +453,52 @@ Args syntax
      - false
      - Text
      - Comment
+
+.. _rename_relationship:
+
+rename_relationship
+-------------------
+
+``rename_relationship`` is used to modify the name of an existing relationship.
+
+An example:
+
+.. code-block:: http
+
+   POST /v1/query HTTP/1.1
+   Content-Type: application/json
+   X-Hasura-Role: admin
+
+   {
+       "type": "rename_relationship",
+       "args": {
+           "table": "article",
+           "name": "article_details",
+           "new_name": "article_detail"
+       }
+   }
+
+.. _rename_relationship_syntax:
+
+Args syntax
+^^^^^^^^^^^
+
+.. list-table::
+   :header-rows: 1
+
+   * - Key
+     - Required
+     - Schema
+     - Description
+   * - table
+     - true
+     - :ref:`TableName`
+     - Name of the table
+   * - name
+     - true
+     - :ref:`RelationshipName`
+     - The relationship
+   * - new_name
+     - true
+     - :ref:`RelationshipName`
+     - New relationship name