diffgram · jaiwiwjwjwisn · May 1, 2024 · May 1, 2024 · May 1, 2024 · May 1, 2024
diff --git a/default/Dockerfile b/default/Dockerfile
@@ -1,23 +1,43 @@
+# Use the official Python 3.11.1 image as the base image
 FROM python:3.11.1-bullseye
+
+# Set a label for the image with the Python version
 LABEL python_version=python3.11.1
 
+# Set an environment variable for the Docker context
 ENV DOCKER_CONTEXT=True
 
-# Set virtualenv environment variables. This is equivalent to running
-# source /env/bin/activate
+# Set up the man directories for the man pages
 RUN seq 1 8 | xargs -I{} mkdir -p /usr/share/man/man{}
 RUN for i in {1..8}; do mkdir -p "/usr/share/man/man$i"; done
+
+# Update the package lists for upgrades and new package installations
 RUN apt-get update
+
+# Install necessary packages for the application
 RUN apt-get install -y libpq-dev python3-dev build-essential postgresql postgresql-contrib
+
+# Copy the requirements.txt file from the default directory to the app directory
 ADD default/requirements.txt /app/
+
+# Upgrade pip to the latest version
 RUN pip3 install --upgrade pip
+
+# Install the required packages from the requirements.txt file
 RUN pip3 install -r /app/requirements.txt
 
+# Copy the default directory and shared directory to the app directory
 ADD default/ /app/
 ADD shared /app/shared
 
+# Set the working directory to the app directory
 WORKDIR /app/
+
+# Make the db-init.sh script executable
 RUN ["chmod", "+x", "/app/db-init.sh"]
 
+# Expose port 8080 for the application
 EXPOSE 8080
-CMD exec gunicorn --bind :8080 --timeout 120 --worker-class sync --workers 5 --no-sendfile main:app
+
+# Set the default command to run the application using Gunicorn
+CMD exec gunicorn --bind :8080 --timeout 120 --worker-class sync --workers 5 --no-sendfile main:app
diff --git a/default/docs/actions/action_run_list.yml b/default/docs/actions/action_run_list.yml
@@ -1,22 +1,85 @@
-
 ---
-summary: Action Runs List
-description: Gets the actions runs associated with the given action ID.
-tags:
-  - Workflows & Actions
-parameters:
-  - name: project_string_id
-    in: path
-    type: string
-    required: true
-  - name: action_id
-    in: path
-    type: number
-    required: true
-responses:
-  200:
-    description: The list of action runs.
-    schema:
-      type: array
-      items:
-        $ref: './default/docs/actions/schemas.yaml#/definitions/ActionRun'
+# OpenAPI specification for the API endpoint.
+openapi: 3.0.0
+info:
+  title: My API
+  version: 1.0.0
+
+# This is the summary for the API endpoint. It provides a brief description of what the endpoint does.
+paths:
+  /projects/{project_string_id}/actions/{action_id}/runs:
+    get:
+      # The summary field provides a brief description of the endpoint.
+      summary: Get Action Runs List
+      # The description field provides more detailed information about the endpoint.
+      description: This endpoint retrieves the list of action runs associated with the given action ID in the specified project.
+
+      # The tags field is used to categorize the endpoint and make it easier to find in documentation.
+      tags:
+        - Workflows_and_Actions # Indicates that this endpoint is related to workflows and actions.
+
+      # The parameters field lists the expected inputs for the endpoint.
+      parameters:
+        - name: project_string_id # The name of the parameter.
+          in: path # The location of the parameter (in this case, in the URL path).
+          description: The unique identifier of the project.
+          required: true # Whether or not the parameter is required.
+          schema:
+            type: string
+
+        - name: action_id # The name of the parameter.
+          in: path # The location of the parameter (in this case, in the URL path).
+          description: The unique identifier of the action.
+          required: true # Whether or not the parameter is required.
+          schema:
+            type: integer
+
+      # The responses field describes the possible responses from the endpoint.
+      responses:
+        '200':
+          description: Successful operation.
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/ActionRun'
+
+        '400':
+          description: Bad Request.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+
+        '404':
+          description: Not Found.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+
+# The components field is used to define reusable components such as schemas and responses.
+components:
+  schemas:
+    ActionRun:
+      type: object
+      properties:
+        id:
+          type: integer
+        status:
+          type: string
+        created_at:
+          type: string
+          format: date-time
+        updated_at:
+          type: string
+          format: date-time
+
+    ErrorResponse:
+      type: object
+      properties:
+        error:
+          type: string
+        message:
+          type: string
diff --git a/default/docs/actions/action_template_get.yml b/default/docs/actions/action_template_get.yml
@@ -1,20 +1,26 @@
-
 ---
-summary: Get Action Template
-description: Gets the given action template by ID.
-tags:
+summary:        # A one-sentence summary of what the API call does
+Get Action Template
+
+description:    # A more detailed description of the API call's functionality
+Gets the given action template by ID. This operation is useful when you need to retrieve a specific action template from a project.
+
+tags:           # Tags help categorize and organize the API documentation
   - Workflows & Actions
-parameters:
-  - name: project_string_id
-    in: path
-    type: string
-    required: true
-  - name: action_template_id
-    in: path
-    type: number
-    required: true
-responses:
+
+parameters:     # Parameters are inputs the API needs to make the call
+  - name: project_string_id   # The name of the parameter
+    in: path                  # The location of the parameter (in this case, it's part of the URL path)
+    type: string              # The data type of the parameter
+    required: true            # Whether or not this parameter is required
+
+  - name: action_template_id  # The name of the parameter
+    in: path                  # The location of the parameter (in this case, it's part of the URL path)
+    type: number              # The data type of the parameter
+    required: true            # Whether or not this parameter is required
+
+responses:       # The possible responses the API can return
   200:
-    description: The action template object.
+    description: The action template object.  # A short description of the response
     schema:
-      $ref: './default/docs/actions/schemas.yaml#/definitions/ActionTemplate'
+      $ref: './default/docs/actions/schemas.yaml#/definitions/ActionTemplate'  # A reference to the schema defining the structure of the response
diff --git a/default/docs/actions/action_template_list.yml b/default/docs/actions/action_template_list.yml
@@ -1,18 +1,22 @@
-
 ---
-summary: Action Templates List
-description: Gets the list of action templates on the project.
-tags:
+summary: # (summary) A brief summary of the endpoint's purpose.
+description: # (description) A detailed explanation of the endpoint's functionality.
+  This action retrieves the list of action templates for a specific project.
+
+tags: # (tags) Categorizes the endpoint for easier navigation in the API documentation.
   - Workflows & Actions
-parameters:
-  - name: project_string_id
-    in: path
-    type: string
-    required: true
-responses:
-  200:
-    description: The list of action templates.
-    schema:
-      type: array
-      items:
-        $ref: './default/docs/actions/schemas.yaml#/definitions/ActionTemplate'
+
+parameters: # (parameters) Describes the required input for this endpoint.
+  - name: project_string_id # (name) The name of the parameter.
+    in: path # (in) The location of the parameter in the API call.
+    type: string # (type) The data type of the parameter.
+    required: true # (required) Whether or not the parameter is mandatory.
+
+responses: # (responses) Describes the possible HTTP status codes and their associated data structures.
+  200: # (200) The standard HTTP success status code.
+    description: # (description) A brief explanation of the response.
+      The list of action templates is returned in this response.
+    schema: # (schema) Describes the structure of the response body.
+      type: array # (type) The data type of the response.
+      items: # (items) Describes the structure of each item in the array.
+        $ref: './default/docs/actions/schemas.yaml#/definitions/ActionTemplate' # (ref) A reference to the ActionTemplate schema.