Merge pull request #42 from arteevraina/api-docs

docs: updating the API documentation

flask/auth.py

@@ -23,9 +23,9 @@
     env_var["host"] = host
     env_var["salt"] = salt
     env_var["sudo_password"] = sudo_password
-    # smtp = smtplib.SMTP('smtp.gmail.com', 587)
-    # smtp.starttls()
-    # smtp.login(fortran_email, fortran_password)
+    smtp = smtplib.SMTP('smtp.gmail.com', 587)
+    smtp.starttls()
+    smtp.login(fortran_email, fortran_password)
 
 except KeyError as err:
     print("Add SALT to .env file")

flask/documentation/add_namespace_admin.yaml

@@ -0,0 +1,58 @@
+description: Adds admins to namespace.
+
+parameters:
+  - name: uuid
+    in: formData
+    description: The uuid of the user
+    required: true
+    type: string
+  - name: username
+    in: formData
+    description: The username of the user to be added as a new admin
+    required: true
+    type: string
+  - name: namespace
+    in: formData
+    description: The name of the namespace
+    required: true
+    type: string
+
+responses:
+  200:
+    description: Admin added successfully or admin already added
+    schema:
+      type: object
+      properties:
+        code:
+          type: integer
+          description: Response status code
+        message:
+          type: string
+          description: Response message
+  404:
+    description: Namespace or Admin not found
+    schema:
+      type: object
+      properties:
+        message:
+          type: string
+        code:
+          type: integer
+  400:
+    description: Invalid request body or missing parameters
+    schema:
+      type: object
+      properties:
+        message:
+          type: string
+        code:
+          type: integer
+  401:
+    description: Unauthorized access
+    schema:
+      type: object
+      properties:
+        message:
+          type: string
+        code:
+          type: integer

flask/documentation/add_namespace_maintainer.yaml

@@ -0,0 +1,57 @@
+description: Adds maintainers to the namespace
+parameters:
+  - name: uuid
+    in: formData
+    description: The uuid of the user
+    required: true
+    type: string
+
+  - name: username
+    in: formData
+    description: The username of the user to be added as a new maintainer
+    required: true
+    type: string
+
+  - name: namespace
+    in: formData
+    description: The name of the namespace
+    required: true
+    type: string
+
+responses:
+  200:
+    description: Maintainer added successfully or maintainer already added
+    schema:
+      type: object
+      properties:
+        code:
+          type: integer
+          description: Response status code
+        message:
+          type: string
+          description: Response message
+  404:
+    description: Namespace or Maintainer not found
+    schema:
+      type: object
+      properties:
+        message:
+          type: string
+        code:
+          type: integer
+  400:
+    description: Invalid request body or missing parameters
+    schema:
+      type: object
+      properties:
+        message:
+          type: string
+        code:
+          type: integer
+  401:
+    description: Unauthorized access
+    schema:
+      type: object
+      properties:
+        message:
+          type: string

flask/documentation/add_package_maintainer.yaml

@@ -0,0 +1,62 @@
+description: Adds a maintainer to the package.
+parameters:
+  - name: uuid
+    in: formData
+    description: The uuid of the user
+    required: true
+    type: string
+  - name: package
+    in: formData
+    description: The name of the package
+    required: true
+    type: string
+  - name: namespace
+    in: formData
+    description: The name of the namespace
+    required: true
+    type: string
+  - name: username
+    in: formData
+    description: The username of the user to be added as a new maintainer
+    required: true
+    type: string
+
+responses:
+  200:
+    description: Maintainer added successfully or maintainer already added
+    schema:
+      type: object
+      properties:
+        code:
+          type: integer
+          description: Response status code
+        message:
+          type: string
+          description: Response message
+  404:
+    description: Namespace or Package or Maintainer not found
+    schema:
+      type: object
+      properties:
+        message:
+          type: string
+        code:
+          type: integer
+  400:
+    description: Invalid request body or missing parameters
+    schema:
+      type: object
+      properties:
+        message:
+          type: string
+        code:
+          type: integer
+  401:
+    description: Unauthorized access
+    schema:
+      type: object
+      properties:
+        message:
+          type: string
+        code:
+          type: integer

flask/documentation/check_admin_user.yaml

@@ -0,0 +1,45 @@
+description: Checks if user is an admin.
+parameters:
+  - name: uuid
+    in: formData
+    description: The uuid of the user
+    required: true
+    type: string
+
+responses:
+  200:
+    description: User is an admin
+    schema:
+      type: object
+      properties:
+        code:
+          type: string
+          description: Response status code
+        message:
+          type: string
+          description: Response message
+        isAdmin:
+          type: boolean
+          description: Whether the user is an admin
+  404:
+    description: User not found
+    schema:
+      type: object
+      properties:
+        code:
+          type: string
+          description: Response status code
+        message:
+          type: string
+          description: Error message
+  401:
+    description: Unauthorized
+    schema:
+      type: object
+      properties:
+        code:
+          type: string
+          description: Response status code
+        message:
+          type: string
+          description: Error message

flask/documentation/create_namespace.yaml

@@ -0,0 +1,52 @@
+description: Create a new namespace.
+parameters:
+  - name: uuid
+    in: formData
+    required: true
+    type: string
+    description: UUID of the user
+  - name: namespace
+    in: formData
+    required: true
+    type: string
+    description: Name of the namespace
+  - name: namespace_description
+    in: formData
+    required: true
+    type: string
+    description: Description of the namespace
+
+responses:
+  200:
+    description: Namespace created successfully
+    schema:
+      type: object
+      properties:
+        code:
+          type: string
+          description: Response status code
+        message:
+          type: string
+          description: Response message
+  400:
+    description: Bad request
+    schema:
+      type: object
+      properties:
+        code:
+          type: string
+          description: Response status code
+        message:
+          type: string
+          description: Response message
+  401:
+    description: Unauthorized
+    schema:
+      type: object
+      properties:
+        code:
+          type: string
+          description: Response status code
+        message:
+          type: string
+          description: Response message

flask/documentation/create_namespace_upload_token.yaml

@@ -0,0 +1,61 @@
+description: Creates namespace upload token.
+parameters:
+  - name: uuid
+    in: formData
+    description: UUID of the user.
+    required: true
+    type: string
+  - name: namespace_name
+    in: path
+    description: Namespace name
+    required: true
+    type: string
+
+responses:
+  200:
+    description: Namespace created successfully
+    schema:
+      type: object
+      properties:
+        code:
+          type: string
+          description: Response status code
+        message:
+          type: string
+          description: Response message
+        uploadToken:
+          type: string
+          description: Upload token for the namespace
+  401:
+    description: Unauthorized
+    schema:
+      type: object
+      properties:
+        code:
+          type: string
+          description: Response status code
+        message:
+          type: string
+          description: Response message
+  404:
+    description: Namespace not found
+    schema:
+      type: object
+      properties:
+        code:
+          type: string
+          description: Response status code
+        message:
+          type: string
+          description: Response message
+  500:
+    description: Internal Server Error
+    schema:
+      type: object
+      properties:
+        code:
+          type: string
+          description: Response status code
+        message:
+          type: string
+          description: Response message