Changeset 462 for TFP-WebServer/WebServer/src/WebAPI/APIs

Timestamp:

Aug 14, 2023, 9:16:51 PM (16 months ago)

Author:

alloc

Message:

More OpenAPI specs added

Location:

TFP-WebServer/WebServer/src/WebAPI/APIs

Files:

• Command.openapi.yaml (modified) (2 diffs)
• Permissions/Blacklist.openapi.yaml (modified) (5 diffs)
• Permissions/CommandPermissions.openapi.yaml (added)
• Permissions/RegisterUser.openapi.yaml (added)
• Permissions/UserPermissions.openapi.yaml (added)
• Permissions/WebApiTokens.openapi.yaml (added)
• Permissions/WebModules.openapi.yaml (added)
• Permissions/WebUsers.openapi.yaml (added)
• Permissions/Whitelist.openapi.yaml (added)

TFP-WebServer/WebServer/src/WebAPI/APIs/Command.openapi.yaml

@@ -88 +88 @@
       description: Simple style command result
 
+    CommandExecutedResponse:
+      type: object
+      properties:
+        data:
+          oneOf:
+            - $ref: '#/components/schemas/CommandExecutedResultFull'
+            - $ref: '#/components/schemas/CommandExecutedResultSimple'
+        meta:
+          $ref: './openapi.yaml#/components/schemas/ResultEnvelopeMeta'
+      required:
+        - data
+        - meta
 
   requestBodies:
@@ -167 +179 @@
             application/json:
               schema:
-                oneOf:
-                  - $ref: '#/components/schemas/CommandExecutedResultFull'
-                  - $ref: '#/components/schemas/CommandExecutedResultSimple'
+                $ref: '#/components/schemas/CommandExecutedResponse'
             text/plain:
               schema: 

TFP-WebServer/WebServer/src/WebAPI/APIs/Permissions/Blacklist.openapi.yaml

@@ -42 +42 @@
             type: object
             properties:
-              x:
-                type: integer
+              bannedUntil:
+                type: string
+                format: date-time
+              banReason:
+                type: string
                 examples:
-                  - -43
-              y:
-                type: integer
+                  - Cheating not allowed!
+              name:
+                type: string
                 examples:
-                  - 842
-              icon:
-                type: string
-                format: uuid
-                examples:
-                  - https://upload.wikimedia.org/wikipedia/commons/thumb/1/11/Blue_question_mark_icon.svg/1200px-Blue_question_mark_icon.svg.png
+                  - TheFunPimp
             required:
-              - x
-              - y
+              - bannedUntil
       required: true
-
-
-  parameters:
-    UserIdPathParameter:
-      name: id
-      in: path
-      required: true
-      schema:
-        $ref: '#/components/schemas/TypeUserIdString'
 
 
@@ -80 +68 @@
       responses:
         200:
-          description: List of found markers
+          description: List of blacklist entries
           content:
             application/json:
@@ -93 +81 @@
                   - data
                   - meta
+        403:
+          $ref: './openapi.yaml#/components/responses/Unauthorized'
+      security:
+        - apiTokenName: [ ]
+          apiTokenSecret: [ ]
+        - sessionCookie: [ ]
 
 
@@ -119 +113 @@
       operationId: blacklist.post.id
       parameters:
-        - $ref: '#/components/parameters/UserIdPathParameter'
+        - $ref: './openapi.yaml#/components/parameters/UserIdPathParameter'
       requestBody:
         $ref: '#/components/requestBodies/BlacklistBodyIn'
       responses:
         201:
-          description: Marker with updated values
+          description: Blacklist entry created or updated
           $ref: './openapi.yaml#/components/responses/HttpEmptyEnvelopedResponse'
         400:
-          description: >-
-            Invalid request body, errorCode will be one of 'NO_OR_INVALID_X',
-            'NO_OR_INVALID_Y'
+          description: Invalid request body, errorCode will be 'NO_OR_INVALID_BANNED_UNTIL'
           $ref: './openapi.yaml#/components/responses/HttpEmptyEnvelopedResponse'
         403:
@@ -145 +137 @@
       operationId: blacklist.delete.id
       parameters:
-        - $ref: '#/components/parameters/UserIdPathParameter'
+        - $ref: './openapi.yaml#/components/parameters/UserIdPathParameter'
       responses:
         204:
-          description: Deleted marker
+          description: Deleted blacklist entry
           $ref: './openapi.yaml#/components/responses/HttpEmptyEnvelopedResponse'
         404:
-          description: Marker ID not found
+          description: User ID not found
           $ref: './openapi.yaml#/components/responses/HttpEmptyEnvelopedResponse'
         403: