update swagger docs for magic

Author: d98762625

swagger.yml

@@ -1,7 +1,7 @@
 openapi: 3.0.0
 info:
   title: CyberChef API
-  description: Some API
+  description: A HTTP API that exposes some of CyberChef's functionality.
   version: 1.0.0
 
 
@@ -41,10 +41,64 @@ paths:
             application/json:
               schema:
                 type: "string"
-                example: "62 61 6b 65 20 73 6f 6d 65 74 68 69 6e 67"
+                value: "Object"
+              example:
+                type: "string"
+                value: "01001110,01111010,01001101,01100111,01001110,01101101,01011001,01100111,01001110,01101101,01010001,01100111,01001110,01101010,01010101,01100111,01001101,01101010,01000001,01100111,01001110,01101010,01101011,01100111,01001110,01101101,01010101,01100111,01001110,01111010,01000001,01100111,01001110,01111010,01010101,01100111,01001110,01111010,01010001,00111101"
         '400':
           description: Bad request
 
+  /magic:
+    post:
+      summary: Performs magic on some input
+      description: >
+        Take some input data and optional arguments for the [Magic operation](https://github.com/gchq/CyberChef/wiki/Automatic-detection-of-encoded-data-using-CyberChef-Magic) and return JSON of results of automatic encoding detection of the inputted data.
+
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/MagicInput"
+            example:
+              input: "WUagwsiae6mP8gNtCCLUFpCpCB26RmBDoDD8PacdAmzAzBVjkK2QstFXaKhpC6iUS7RHqXrJtFisoRSgoJ4whjm1arm864qaNq4RcfUmLHrcsAaZc5TXCYifNdgS83gDeejGX46gaiMyuBV6EskHt1scgJ88x2tNSotQDwbGY1mmCob2ARGFvCKYNqiN9ipMq1ZU1mgkdbNuGcb76aRtYWhCGUc8g93UJudhb8htsheZnwTpgqhx83SVJSZXMXUjJT2zmpC7uXWtumqokbdSi88YtkWDAc1Toouh2oH4D4ddmNKJWUDpMwmngUmK14xwmomccPQE9hM172APnSqwxdKQ172RkcAsysnmj5gGtRmVNNh2s359wr6mS2QRP"
+              args:
+                depth: 1
+
+      responses:
+        '200':
+          description: Magic operation ran successfully
+          content:
+            application/json:
+              schema:
+                type: "string"
+                value:
+                  $ref: "#/components/schemas/MagicResponse"
+              example:
+                type: 6
+                value:
+                  - recipe:
+                    - op: "From Base58"
+                      args:
+                        - "123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz"
+                        - false
+                    data: "x^Ü^Í^ÒÑqÃ0\fCWá\b^ÉcKò8mâì?B\u001eA^ÊUûÕ»^ÜOb@\u0010^ÀxìÖ^Ƶö^Ûµ§µ»õ^Çõ]×ÃzÓwÓ\u0015äÛ1^Ý3-§µKõ^×0t=¼½õdë\u001cÄ^Ö^ØS\u0000uÁ\u001f´Pñõ³*^ÌppuÝÅ\u0003"
+                    languageScores:
+                      - lang: zh
+                        score: 215110.97112616687
+                        probability: 0
+                    fileType: null
+                    isUTF8: true
+                    entropy: 5.6887987925007035
+                    matchingOps:
+                      - op: "From Base58"
+                        pattern: {}
+                        args:
+                          - 123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz
+                          - false
+                    useful: false
+
+
 components:
   schemas:
     SingleOpRecipe:
@@ -99,4 +153,40 @@ components:
         width: 16
         upperCaseHex: true
         includeFinalLength: false
+
+    MagicInput:
+      type: object
+      properties:
+        input: {}
+        args:
+          oneOf:
+            - $ref: "#/components/schemas/ArgArray"
+            - $ref: "#/components/schemas/ArgObject"
+    MagicResponse:
+      type: object
+      properties:
+        type:
+          type: int
+        value:
+          type: array
+          items:
+            $ref: "#/components/schemas/MagicResponseItem"
+    MagicResponseItem:
+      type: object
+      properties:
+        recipe:
+          type: array
+          items:
+            type: Object
+        data:
+          type: string
+        languageScores:
+          type: array
+          items:
+            type: Object
+        matchingOps:
+          type: array
+          items:
+            type: Object
+        useful: bool