Update copyright year and fix warnings
Signed-off-by: Akashdeep Dhar <akashdeep.dhar@gmail.com>
This commit is contained in:
parent
76d3c08836
commit
b66511640b
4 changed files with 129 additions and 129 deletions
|
@ -17,8 +17,8 @@ the keys denoted within parentheses are foreign keys.
|
|||
USER
|
||||
^^^^
|
||||
|
||||
Purpose
|
||||
"""""""
|
||||
Purpose of ``USER``
|
||||
"""""""""""""""""""
|
||||
|
||||
The table stores information of all the users enrolled to the service. For the
|
||||
most parts, the service will make use of Fedora Account System authentication
|
||||
|
@ -27,8 +27,8 @@ enrolled on the Fedora Account System to be able to make use of the service.
|
|||
While most users will have basic privileges of utilizing the service, some
|
||||
users will have elevated privileges of maintaining the service.
|
||||
|
||||
Resources
|
||||
"""""""""
|
||||
Resources of ``USER``
|
||||
"""""""""""""""""""""
|
||||
|
||||
The following keys must be populated in order to create an entry to the table.
|
||||
|
||||
|
@ -42,22 +42,22 @@ The following keys must be populated in order to create an entry to the table.
|
|||
moderate the users and establish fair usage. The data type considered here
|
||||
is boolean.
|
||||
|
||||
References
|
||||
""""""""""
|
||||
References of ``USER``
|
||||
""""""""""""""""""""""
|
||||
|
||||
As this table does not depend on any other table, it does not have any foreign
|
||||
keys.
|
||||
|
||||
Identifier
|
||||
""""""""""
|
||||
Identifier of ``USER``
|
||||
""""""""""""""""""""""
|
||||
|
||||
The ``UUID`` key is the primary key for the table.
|
||||
|
||||
APIKEY
|
||||
^^^^^^
|
||||
|
||||
Purpose
|
||||
"""""""
|
||||
Purpose of ``APIKEY``
|
||||
"""""""""""""""""""""
|
||||
|
||||
The table stores information of all the access tokens associated per entry on
|
||||
the user table. The access token is required to authenticate the user
|
||||
|
@ -66,8 +66,8 @@ hashed form of the same would be stored in the database. Users can manage the
|
|||
purpose of the created access token, set the validity of the same and revoke
|
||||
its usage in their discretion and these would be recorded.
|
||||
|
||||
Resources
|
||||
"""""""""
|
||||
Resources of ``APIKEY``
|
||||
"""""""""""""""""""""""
|
||||
|
||||
The following keys must be populated in order to create an entry to the table.
|
||||
|
||||
|
@ -93,22 +93,22 @@ The following keys must be populated in order to create an entry to the table.
|
|||
to protect or invalidate existing API keys. The data type considered here
|
||||
is boolean.
|
||||
|
||||
References
|
||||
""""""""""
|
||||
References of ``APIKEY``
|
||||
""""""""""""""""""""""""
|
||||
|
||||
This table depends on the user table and hence, it has one foreign key named
|
||||
``USER_UUID`` referencing the key ``UUID`` from the user table.
|
||||
|
||||
Identifier
|
||||
""""""""""
|
||||
Identifier of ``APIKEY``
|
||||
""""""""""""""""""""""""
|
||||
|
||||
The ``UUID`` key is the primary key for the table.
|
||||
|
||||
SERVICE
|
||||
^^^^^^^
|
||||
|
||||
Purpose
|
||||
"""""""
|
||||
Purpose of ``SERVICE``
|
||||
""""""""""""""""""""""
|
||||
|
||||
The table stores information of all the service entries associated per entry on
|
||||
the user table. A POST endpoint with the unique identifier as the route string
|
||||
|
@ -117,8 +117,8 @@ associated with the user who created the said service. The purpose of the
|
|||
service, templatable topic, templatable body, creation date and revocation
|
||||
status can be managed by the users and are recorded.
|
||||
|
||||
Resources
|
||||
"""""""""
|
||||
Resources of ``SERVICE``
|
||||
""""""""""""""""""""""""
|
||||
|
||||
The following keys must be populated in order to create an entry to the table.
|
||||
|
||||
|
@ -144,22 +144,22 @@ The following keys must be populated in order to create an entry to the table.
|
|||
populated with the creation date by fixture. The data type considered here
|
||||
is datetime.
|
||||
|
||||
References
|
||||
""""""""""
|
||||
References of ``SERVICE``
|
||||
"""""""""""""""""""""""""
|
||||
|
||||
This table depends on the user table and hence, it has one foreign key named
|
||||
``USER_UUID`` referencing the key ``UUID`` from the user table.
|
||||
|
||||
Identifier
|
||||
""""""""""
|
||||
Identifier of ``SERVICE``
|
||||
"""""""""""""""""""""""""
|
||||
|
||||
The ``UUID`` key is the primary key for the table.
|
||||
|
||||
MESSAGE
|
||||
^^^^^^^
|
||||
|
||||
Purpose
|
||||
"""""""
|
||||
Purpose of ``MESSAGE``
|
||||
""""""""""""""""""""""
|
||||
|
||||
The table stores information of all the message entries associated per entry on
|
||||
the service table. As the contents of the message can be easily retrieved from
|
||||
|
@ -168,8 +168,8 @@ message sent on the Fedora Messaging bus. The entries to this table would be
|
|||
created only when the messages originating from service events being triggered
|
||||
are shared on the Fedora Messaging bus successfully.
|
||||
|
||||
Resources
|
||||
"""""""""
|
||||
Resources of ``MESSAGE``
|
||||
""""""""""""""""""""""""
|
||||
|
||||
The following keys must be populated in order to create an entry to the table.
|
||||
|
||||
|
@ -186,13 +186,13 @@ The following keys must be populated in order to create an entry to the table.
|
|||
populated with the creation date by a fixture. The data type considered
|
||||
here is datetime.
|
||||
|
||||
References
|
||||
""""""""""
|
||||
References of ``MESSAGE``
|
||||
"""""""""""""""""""""""""
|
||||
|
||||
This table depends on the service table and hence, it has one foreign key named
|
||||
``SERVICE_UUID`` referencing the key ``UUID`` from the service table.
|
||||
|
||||
Identifier
|
||||
""""""""""
|
||||
Identifier of ``MESSAGE``
|
||||
"""""""""""""""""""""""""
|
||||
|
||||
The ``UUID`` key is the primary key for the table.
|
||||
|
|
|
@ -1,4 +1,4 @@
|
|||
.. _apis:
|
||||
.. _mpro:
|
||||
|
||||
Message producer
|
||||
================
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue