Added unit_roles and projects API documentation

thoth-tech · May 17, 2024 · df4f1bd · df4f1bd
1 parent 955a300
commit df4f1bd
Show file tree

Hide file tree

Showing 5 changed files with 1,391 additions and 8 deletions.
diff --git a/astro.config.mjs b/astro.config.mjs
@@ -78,9 +78,17 @@ export default defineConfig({
               link: '/backend/api/csv',
             },
             {
-              label: 'projects',
+              label: 'projects API operation list',
               link: '/backend/api/projects',
             },
+            {
+              label: 'projects (1)',
+              link: '/backend/api/projects_1',
+            },
+            {
+              label: 'projects (2)',
+              link: '/backend/api/projects_2',
+            },
             {
               label: 'setting',
               link: '/backend/api/setting',

diff --git a/src/content/docs/backend/API/projects.md b/src/content/docs/backend/API/projects.md
@@ -11,8 +11,7 @@ This markdown document provides detailed documentation for the "projects" API en
 
 This "projects" API has the following operations.
 
-
-## Detail of Operations related to projects.
+## This page consist of list of Operations related to projects (26 operations).
 
 - **GET** /api/projects/{id}/task_def_id/{task_definition_id}/submission_files
 - **GET** /api/projects/{id}/task_def_id/{task_definition_id}/submission_details
@@ -36,8 +35,13 @@ This "projects" API has the following operations.
 - **PUT** /api/projects/{id}
 - **PUT** /api/projects/{project_id}/task_def_id/{task_definition_id}/assess_extension/{task_comment_id}
 - **POST** /api/projects/{project_id}/task_def_id/{task_definition_id}/request_extension
-- **POST** /api/projects/{project_id}/task_def_id/{task_definition_id}/comments/{task_comment_id}/discussion_comment/reply
-- **GET** /api/projects/{project_id}/task_def_id/{task_definition_id}/comments/{task_comment_id}/discussion_comment/response
-- **GET** /api/projects/{project_id}/task_def_id/{task_definition_id}/comments/{task_comment_id}/discussion_comment/prompt_number/{prompt_number}
+- **POST** /api/projects/{project_id}/task_def_id/{task_definition_id}/comments/
+{task_comment_id}/discussion_comment/reply
+- **GET** /api/projects/{project_id}/task_def_id/{task_definition_id}/comments/
+{task_comment_id}/discussion_comment/response
+- **GET** /api/projects/{project_id}/task_def_id/{task_definition_id}/comments/
+{task_comment_id}/discussion_comment/prompt_number/{prompt_number}
 - **POST** /api/projects/{project_id}/task_def_id/{task_definition_id}/discussion_comments
 
+-------------------------------------------
+**See following pages for detailed operations related to Projects API**