Skip to content

Commit

Permalink
reformat tables in quickstart
Browse files Browse the repository at this point in the history
  • Loading branch information
@mahenzon
mahenzon committed Dec 21, 2023
1 parent ed6d07d commit 5671c3f
Showing 1 changed file with 59 additions and 59 deletions.
118 changes: 59 additions & 59 deletions docs/quickstart.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,61 +24,61 @@ An example of FastAPI-JSONAPI API looks like this:

This example provides the following API:

+----------------+--------+----------------+---------------------------------+
| url | method | endpoint | action |
+================+========+================+=================================+
| /users | GET | user_list | Retrieve a collection of users |
+----------------+--------+----------------+---------------------------------+
| /users | POST | user_list | Create a user |
+----------------+--------+----------------+---------------------------------+
| /users/<int:id> | GET | user_detail | Retrieve details of a user |
+----------------+--------+----------------+---------------------------------+
| /users/<int:id> | PATCH | user_detail | Update a user |
+----------------+--------+----------------+---------------------------------+
| /users/<int:id> | DELETE | user_detail | Delete a user |
+----------------+--------+----------------+---------------------------------+
+-----------------+--------+-------------+--------------------------------+
| url | method | endpoint | action |
+=================+========+=============+================================+
| /users | GET | user_list | Retrieve a collection of users |
+-----------------+--------+-------------+--------------------------------+
| /users | POST | user_list | Create a user |
+-----------------+--------+-------------+--------------------------------+
| /users/<int:id> | GET | user_detail | Retrieve details of a user |
+-----------------+--------+-------------+--------------------------------+
| /users/<int:id> | PATCH | user_detail | Update a user |
+-----------------+--------+-------------+--------------------------------+
| /users/<int:id> | DELETE | user_detail | Delete a user |
+-----------------+--------+-------------+--------------------------------+

in developing

+-------------------------------------------+--------+------------------+------------------------------------------------------+
| url | method | endpoint | action |
+===========================================+========+==================+======================================================+
| /users/<int:id>/group | GET | computer_list | Retrieve a collection computers related to a user |
+-------------------------------------------+--------+------------------+------------------------------------------------------+
| /users/<int:id>/group | POST | computer_list | Create a computer related to a user |
+-------------------------------------------+--------+------------------+------------------------------------------------------+
| /users/<int:id>/relationships/group | GET | user_computers | Retrieve relationships between a user and computers |
+-------------------------------------------+--------+------------------+------------------------------------------------------+
| /users/<int:id>/relationships/computers | POST | user_computers | Create relationships between a user and computers |
+-------------------------------------------+--------+------------------+------------------------------------------------------+
| /users/<int:id>/relationships/computers | PATCH | user_computers | Update relationships between a user and computers |
+-------------------------------------------+--------+------------------+------------------------------------------------------+
| /users/<int:id>/relationships/computers | DELETE | user_computers | Delete relationships between a user and computers |
+-------------------------------------------+--------+------------------+------------------------------------------------------+
| /computers | GET | computer_list | Retrieve a collection of computers |
+-------------------------------------------+--------+------------------+------------------------------------------------------+
| /computers | POST | computer_list | Create a computer |
+-------------------------------------------+--------+------------------+------------------------------------------------------+
| /computers/<int:id> | GET | computer_detail | Retrieve details of a computer |
+-------------------------------------------+--------+------------------+------------------------------------------------------+
| /computers/<int:id> | PATCH | computer_detail | Update a computer |
+-------------------------------------------+--------+------------------+------------------------------------------------------+
| /computers/<int:id> | DELETE | computer_detail | Delete a computer |
+-------------------------------------------+--------+------------------+------------------------------------------------------+
| /computers/<int:id>/owner | GET | user_detail | Retrieve details of the owner of a computer |
+-------------------------------------------+--------+------------------+------------------------------------------------------+
| /computers/<int:id>/owner | PATCH | user_detail | Update the owner of a computer |
+-------------------------------------------+--------+------------------+------------------------------------------------------+
| /computers/<int:id>/owner | DELETE | user_detail | Delete the owner of a computer |
+-------------------------------------------+--------+------------------+------------------------------------------------------+
| /computers/<int:id>/relationships/owner | GET | user_computers | Retrieve relationships between a user and computers |
+-------------------------------------------+--------+------------------+------------------------------------------------------+
| /computers/<int:id>/relationships/owner | POST | user_computers | Create relationships between a user and computers |
+-------------------------------------------+--------+------------------+------------------------------------------------------+
| /computers/<int:id>/relationships/owner | PATCH | user_computers | Update relationships between a user and computers |
+-------------------------------------------+--------+------------------+------------------------------------------------------+
| /computers/<int:id>/relationships/owner | DELETE | user_computers | Delete relationships between a user and computers |
+-------------------------------------------+--------+------------------+------------------------------------------------------+
+-----------------------------------------+--------+-----------------+-----------------------------------------------------+
| url | method | endpoint | action |
+=========================================+========+=================+=====================================================+
| /users/<int:id>/group | GET | computer_list | Retrieve a collection computers related to a user |
+-----------------------------------------+--------+-----------------+-----------------------------------------------------+
| /users/<int:id>/group | POST | computer_list | Create a computer related to a user |
+-----------------------------------------+--------+-----------------+-----------------------------------------------------+
| /users/<int:id>/relationships/group | GET | user_computers | Retrieve relationships between a user and computers |
+-----------------------------------------+--------+-----------------+-----------------------------------------------------+
| /users/<int:id>/relationships/computers | POST | user_computers | Create relationships between a user and computers |
+-----------------------------------------+--------+-----------------+-----------------------------------------------------+
| /users/<int:id>/relationships/computers | PATCH | user_computers | Update relationships between a user and computers |
+-----------------------------------------+--------+-----------------+-----------------------------------------------------+
| /users/<int:id>/relationships/computers | DELETE | user_computers | Delete relationships between a user and computers |
+-----------------------------------------+--------+-----------------+-----------------------------------------------------+
| /computers | GET | computer_list | Retrieve a collection of computers |
+-----------------------------------------+--------+-----------------+-----------------------------------------------------+
| /computers | POST | computer_list | Create a computer |
+-----------------------------------------+--------+-----------------+-----------------------------------------------------+
| /computers/<int:id> | GET | computer_detail | Retrieve details of a computer |
+-----------------------------------------+--------+-----------------+-----------------------------------------------------+
| /computers/<int:id> | PATCH | computer_detail | Update a computer |
+-----------------------------------------+--------+-----------------+-----------------------------------------------------+
| /computers/<int:id> | DELETE | computer_detail | Delete a computer |
+-----------------------------------------+--------+-----------------+-----------------------------------------------------+
| /computers/<int:id>/owner | GET | user_detail | Retrieve details of the owner of a computer |
+-----------------------------------------+--------+-----------------+-----------------------------------------------------+
| /computers/<int:id>/owner | PATCH | user_detail | Update the owner of a computer |
+-----------------------------------------+--------+-----------------+-----------------------------------------------------+
| /computers/<int:id>/owner | DELETE | user_detail | Delete the owner of a computer |
+-----------------------------------------+--------+-----------------+-----------------------------------------------------+
| /computers/<int:id>/relationships/owner | GET | user_computers | Retrieve relationships between a user and computers |
+-----------------------------------------+--------+-----------------+-----------------------------------------------------+
| /computers/<int:id>/relationships/owner | POST | user_computers | Create relationships between a user and computers |
+-----------------------------------------+--------+-----------------+-----------------------------------------------------+
| /computers/<int:id>/relationships/owner | PATCH | user_computers | Update relationships between a user and computers |
+-----------------------------------------+--------+-----------------+-----------------------------------------------------+
| /computers/<int:id>/relationships/owner | DELETE | user_computers | Delete relationships between a user and computers |
+-----------------------------------------+--------+-----------------+-----------------------------------------------------+


Save `this file <https://github.com/mts-ai/FastAPI-JSONAPI/blob/main/examples/api_for_sqlalchemy/main.py>`_ as api.py and run it using your Python interpreter. Note that we've enabled
Expand Down Expand Up @@ -154,13 +154,13 @@ Response:
Relationships
-------------

| Now let's use relationships tools.
| First, create 3 computers named "Halo", "Nestor" and "Commodore".
|
| Done?
| Ok. So let's continue this tutorial.
|
| We assume that Halo has id=2, Nestor id=3 and Commodore id=4.
> Now let's use relationships tools.
> First, create 3 computers named "Halo", "Nestor" and "Commodore".
>
> Done?
> Ok. So let's continue this tutorial.
>
> We assume that Halo has id=2, Nestor id=3 and Commodore id=4.

Create object with related object(s)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down

0 comments on commit 5671c3f

Please sign in to comment.