zou 0.20.82__py3-none-any.whl → 0.20.84__py3-none-any.whl

zou/app/blueprints/index/resources.py

@@ -17,7 +17,7 @@ from zou.app.utils.redis import get_redis_url
 class IndexResource(Resource):
     def get(self):
         """
-        Get API name and version.
+        Get API name and version
         ---
         tags:
           - Index
@@ -106,39 +106,40 @@ class BaseStatusResource(Resource):
 class StatusResource(BaseStatusResource):
     def get(self):
         """
-        Retrieve API name, version and status.
-        ---
-        tags:
-          - Index
-        responses:
-          '200':
-            description: API name, version and status
-            content:
-              application/json:
-                schema:
-                  type: object
-                  properties:
-                    name:
-                      type: string
-                      example: "Zou"
-                    version:
-                      type: string
-                      example: "0.20.0"
-                    database-up:
-                      type: boolean
-                      example: true
-                    key-value-store-up:
-                      type: boolean
-                      example: true
-                    event-stream-up:
-                      type: boolean
-                      example: true
-                    job-queue-up:
-                      type: boolean
-                      example: true
-                    indexer-up:
-                      type: boolean
-                      example: true
+        Get status of the API services
+         ---
+         description: Get status of the database, key value store, event stream, job queue, indexer
+         tags:
+           - Index
+         responses:
+           '200':
+             description: Status of the API services
+             content:
+               application/json:
+                 schema:
+                   type: object
+                   properties:
+                     name:
+                       type: string
+                       example: "Zou"
+                     version:
+                       type: string
+                       example: "0.20.0"
+                     database-up:
+                       type: boolean
+                       example: true
+                     key-value-store-up:
+                       type: boolean
+                       example: true
+                     event-stream-up:
+                       type: boolean
+                       example: true
+                     job-queue-up:
+                       type: boolean
+                       example: true
+                     indexer-up:
+                       type: boolean
+                       example: true
         """
         (
             api_name,
@@ -164,13 +165,14 @@ class StatusResource(BaseStatusResource):
 class StatusResourcesResource(BaseStatusResource):
     def get(self):
         """
-        Retrieve date and CPU, memory and jobs stats.
+        Get resource usage stats
         ---
+        description: Get CPU usage for each core, memory repartition and number of jobs in the job queue.
         tags:
           - Index
         responses:
           '200':
-            description: Date and CPU, memory and jobs stats
+            description: CPU, memory and jobs stats
             content:
               application/json:
                 schema:
@@ -261,8 +263,9 @@ class StatusResourcesResource(BaseStatusResource):
 class TxtStatusResource(BaseStatusResource):
     def get(self):
         """
-        Retrieve API name, version and status as txt.
+        Get status of the API services as text
         ---
+        description: Get status of the database, key value store, event stream, job queue, the indexer as a text.
         tags:
           - Index
         responses:
@@ -313,8 +316,9 @@ indexer-up: %s
 class InfluxStatusResource(BaseStatusResource):
     def get(self):
         """
-        Retrieve status of database and time.
+        Get status of the API services for InfluxDB
         ---
+        description: Get status of the database, key value store, event stream, job queue, indexer as a JSON object.
         tags:
           - Index
         responses:
@@ -371,8 +375,9 @@ class StatsResource(Resource):
     @jwt_required()
     def get(self):
         """
-        Retrieve main stats.
+        Get usage stats
         ---
+        description: Get the amount of projects, assets, shots, tasks, and persons.
         tags:
           - Index
         responses:
@@ -407,13 +412,14 @@ class StatsResource(Resource):
 class ConfigResource(Resource):
     def get(self):
         """
-        Get basic configuration for the current instance.
+        Get the configuration of the Kitsu instance
         ---
+        description: The configuration includes self-hosted status, Crisp token, indexer configuration, SAML status, and dark theme status.
         tags:
           - Index
         responses:
           '200':
-            description: Configuration object including self-hosted status, Crisp token, indexer configuration, SAML status, and dark theme status
+            description: Configuration object
             content:
               application/json:
                 schema:
@@ -475,8 +481,9 @@ class ConfigResource(Resource):
 class TestEventsResource(Resource):
     def get(self):
         """
-        Generate a main:test event.
+        Generate a test event
         ---
+        description: Generate a `main:test` event to test the event stream with the Python client or similar.
         tags:
           - Index
         responses:

zou/app/blueprints/news/resources.py

@@ -96,8 +96,9 @@ class ProjectNewsResource(Resource, NewsMixin, ArgsMixin):
     @jwt_required()
     def get(self, project_id):
         """
-        Retrieve all news related to a given project
+        Get project latest news
         ---
+        description: Get the 50 latest news object (activity feed) for a project
         tags:
           - News
         parameters:
@@ -108,6 +109,7 @@ class ProjectNewsResource(Resource, NewsMixin, ArgsMixin):
               type: string
               format: uuid
             example: a24a6ea4-ce75-4665-a070-57453082c25
+            description: Unique identifier of the project
           - in: query
             name: before
             required: false
@@ -115,6 +117,7 @@ class ProjectNewsResource(Resource, NewsMixin, ArgsMixin):
               type: string
               format: date
             example: "2022-07-12"
+            description: Filter news before this date
           - in: query
             name: after
             required: false
@@ -122,6 +125,7 @@ class ProjectNewsResource(Resource, NewsMixin, ArgsMixin):
               type: string
               format: date
             example: "2022-07-12"
+            description: Filter news after this date
           - in: query
             name: page
             required: false
@@ -129,6 +133,7 @@ class ProjectNewsResource(Resource, NewsMixin, ArgsMixin):
               type: integer
               default: 1
             example: 1
+            description: Page number for pagination
           - in: query
             name: limit
             required: false
@@ -136,6 +141,7 @@ class ProjectNewsResource(Resource, NewsMixin, ArgsMixin):
               type: integer
               default: 50
             example: 50
+            description: Number of news items per page
           - in: query
             name: person_id
             required: false
@@ -143,6 +149,7 @@ class ProjectNewsResource(Resource, NewsMixin, ArgsMixin):
               type: string
               format: uuid
             example: a24a6ea4-ce75-4665-a070-57453082c25
+            description: Filter news by specific team member
           - in: query
             name: task_type_id
             required: false
@@ -150,6 +157,7 @@ class ProjectNewsResource(Resource, NewsMixin, ArgsMixin):
               type: string
               format: uuid
             example: a24a6ea4-ce75-4665-a070-57453082c25
+            description: Filter news by task type
           - in: query
             name: task_status_id
             required: false
@@ -157,6 +165,7 @@ class ProjectNewsResource(Resource, NewsMixin, ArgsMixin):
               type: string
               format: uuid
             example: a24a6ea4-ce75-4665-a070-57453082c25
+            description: Filter news by task status
           - in: query
             name: episode_id
             required: false
@@ -164,6 +173,7 @@ class ProjectNewsResource(Resource, NewsMixin, ArgsMixin):
               type: string
               format: uuid
             example: a24a6ea4-ce75-4665-a070-57453082c25
+            description: Filter news by specific episode
           - in: query
             name: only_preview
             required: false
@@ -171,6 +181,7 @@ class ProjectNewsResource(Resource, NewsMixin, ArgsMixin):
               type: boolean
               default: false
             example: false
+            description: Show only news related to preview uploads
         responses:
           '200':
             description: All news related to given project
@@ -187,8 +198,10 @@ class ProjectNewsResource(Resource, NewsMixin, ArgsMixin):
                           id:
                             type: string
                             format: uuid
+                            description: Unique news item identifier
                           title:
                             type: string
+                            description: News item title
                           content:
                             type: string
                           created_at:
@@ -213,8 +226,10 @@ class NewsResource(Resource, NewsMixin, ArgsMixin):
     @jwt_required()
     def get(self):
         """
-        Retrieve all news from user's open projects
+        Get open projects news
         ---
+        description: Returns the latest news and activity feed from all 
+          projects the user has access to.
         tags:
           - News
         parameters:
@@ -225,6 +240,7 @@ class NewsResource(Resource, NewsMixin, ArgsMixin):
               type: string
               format: uuid
             example: a24a6ea4-ce75-4665-a070-57453082c25
+            description: Filter news by specific project
           - in: query
             name: before
             required: false
@@ -232,6 +248,7 @@ class NewsResource(Resource, NewsMixin, ArgsMixin):
               type: string
               format: date
             example: "2022-07-12"
+            description: Filter news before this date
           - in: query
             name: after
             required: false
@@ -239,6 +256,7 @@ class NewsResource(Resource, NewsMixin, ArgsMixin):
               type: string
               format: date
             example: "2022-07-12"
+            description: Filter news after this date
           - in: query
             name: page
             required: false
@@ -246,6 +264,7 @@ class NewsResource(Resource, NewsMixin, ArgsMixin):
               type: integer
               default: 1
             example: 1
+            description: Page number for pagination
           - in: query
             name: limit
             required: false
@@ -253,6 +272,7 @@ class NewsResource(Resource, NewsMixin, ArgsMixin):
               type: integer
               default: 50
             example: 50
+            description: Number of news items per page
           - in: query
             name: person_id
             required: false
@@ -260,6 +280,7 @@ class NewsResource(Resource, NewsMixin, ArgsMixin):
               type: string
               format: uuid
             example: a24a6ea4-ce75-4665-a070-57453082c25
+            description: Filter news by specific team member
           - in: query
             name: task_type_id
             required: false
@@ -267,6 +288,7 @@ class NewsResource(Resource, NewsMixin, ArgsMixin):
               type: string
               format: uuid
             example: a24a6ea4-ce75-4665-a070-57453082c25
+            description: Filter news by task type
           - in: query
             name: task_status_id
             required: false
@@ -274,6 +296,7 @@ class NewsResource(Resource, NewsMixin, ArgsMixin):
               type: string
               format: uuid
             example: a24a6ea4-ce75-4665-a070-57453082c25
+            description: Filter news by task status
           - in: query
             name: episode_id
             required: false
@@ -281,6 +304,7 @@ class NewsResource(Resource, NewsMixin, ArgsMixin):
               type: string
               format: uuid
             example: a24a6ea4-ce75-4665-a070-57453082c25
+            description: Filter news by specific episode
           - in: query
             name: only_preview
             required: false
@@ -288,9 +312,10 @@ class NewsResource(Resource, NewsMixin, ArgsMixin):
               type: boolean
               default: false
             example: false
+            description: Show only news related to preview uploads
         responses:
           '200':
-            description: All news from user's open projects
+            description: News feed successfully retrieved
             content:
               application/json:
                 schema:
@@ -300,28 +325,13 @@ class NewsResource(Resource, NewsMixin, ArgsMixin):
                       type: array
                       items:
                         type: object
-                        properties:
-                          id:
-                            type: string
-                            format: uuid
-                          title:
-                            type: string
-                          content:
-                            type: string
-                          created_at:
-                            type: string
-                            format: date-time
-                          author_id:
-                            type: string
-                            format: uuid
-                          project_id:
-                            type: string
-                            format: uuid
+                      description: Array of news items
                     stats:
                       type: object
-                      properties:
-                        total:
-                          type: integer
+                      description: News statistics
+                    total:
+                      type: integer
+                      description: Total number of news items
         """
         open_project_ids = []
         if permissions.has_admin_permissions():
@@ -336,8 +346,10 @@ class ProjectSingleNewsResource(Resource):
     @jwt_required()
     def get(self, project_id, news_id):
         """
-        Retrieve a single given news related to a given project
+        Get news item
         ---
+        description: Retrieves detailed information about a specific news item 
+          from a givenproject.
         tags:
           - News
         parameters:
@@ -348,6 +360,7 @@ class ProjectSingleNewsResource(Resource):
               type: string
               format: uuid
             example: a24a6ea4-ce75-4665-a070-57453082c25
+            description: Unique identifier of the project
           - in: path
             name: news_id
             required: true
@@ -355,9 +368,10 @@ class ProjectSingleNewsResource(Resource):
               type: string
               format: uuid
             example: a24a6ea4-ce75-4665-a070-57453082c25
+            description: Unique identifier of the news item
         responses:
           '200':
-            description: Single given news related to given project
+            description: News item successfully retrieved
             content:
               application/json:
                 schema:
@@ -366,21 +380,27 @@ class ProjectSingleNewsResource(Resource):
                     id:
                       type: string
                       format: uuid
+                      description: Unique news item identifier
                     title:
                       type: string
+                      description: News item title
                     content:
                       type: string
+                      description: News item content
                     created_at:
                       type: string
                       format: date-time
+                      description: Creation timestamp
                     author_id:
                       type: string
                       format: uuid
+                      description: Author's user ID
                     project_id:
                       type: string
                       format: uuid
-          '404':
-            description: News or project not found
+                      description: Project identifier
+          404:
+            description: News item or project not found
         """
         projects_service.get_project(project_id)
         user_service.check_project_access(project_id)