@apifreaks/openapi-specs 0.2.0 → 0.3.0

package/specs/pdf/pdf-resource-upload-binary.json

@@ -19,9 +19,7 @@
   "paths": {
     "/pdf/resource/upload-binary": {
       "post": {
-        "tags": [
-          "PDF Upload and Download APIs"
-        ],
+        "tags": ["PDF Upload and Download APIs"],
         "summary": "Upload a PDF in binary format",
         "description": "This API uploads PDF files to the API Freaks server in binary format.",
         "parameters": [
@@ -31,10 +29,7 @@
             "required": false,
             "schema": {
               "type": "string",
-              "enum": [
-                "json",
-                "xml"
-              ],
+              "enum": ["json", "xml"],
               "default": "json"
             },
             "description": "Specifies the desired format for the API response. Choose 'json' for a JSON object or 'xml' for an XML structure."
@@ -80,10 +75,15 @@
                   }
                 }
               }
+            },
+            "headers": {
+              "X-AF-Credits-Cost": {
+                "$ref": "#/components/headers/X-AF-Credits-Cost"
+              }
             }
           },
           "400": {
-            "description": "Bad Request \u2014 Missing file_name or empty body",
+            "description": "Bad Request — Missing file_name or empty body",
             "content": {
               "application/json": {
                 "examples": {
@@ -112,10 +112,15 @@
                   "$ref": "#/components/schemas/ErrorResponse"
                 }
               }
+            },
+            "headers": {
+              "X-AF-Credits-Cost": {
+                "$ref": "#/components/headers/X-AF-Credits-Cost"
+              }
             }
           },
           "415": {
-            "description": "Unsupported Media Type \u2014 File extension not supported",
+            "description": "Unsupported Media Type — File extension not supported",
             "content": {
               "application/json": {
                 "examples": {
@@ -134,6 +139,11 @@
                   "$ref": "#/components/schemas/ErrorResponse"
                 }
               }
+            },
+            "headers": {
+              "X-AF-Credits-Cost": {
+                "$ref": "#/components/headers/X-AF-Credits-Cost"
+              }
             }
           }
         },
@@ -159,10 +169,7 @@
     "schemas": {
       "BinaryResourceUploadResponse": {
         "type": "object",
-        "required": [
-          "fileName",
-          "fileId"
-        ],
+        "required": ["fileName", "fileId"],
         "properties": {
           "fileName": {
             "type": "string",
@@ -178,9 +185,7 @@
       "ErrorResponse": {
         "type": "object",
         "description": "Standard error envelope returned by the API on failed requests.",
-        "required": [
-          "message"
-        ],
+        "required": ["message"],
         "properties": {
           "error": {
             "type": "string",
@@ -205,6 +210,14 @@
           }
         }
       }
+    },
+    "headers": {
+      "X-AF-Credits-Cost": {
+        "description": "Specifies the number of credits consumed by the current request.",
+        "schema": {
+          "type": "integer"
+        }
+      }
     }
   },
   "security": [

package/specs/pdf/pdf-resource-upload.json

@@ -19,9 +19,7 @@
   "paths": {
     "/pdf/resource/upload": {
       "post": {
-        "tags": [
-          "PDF Upload and Download APIs"
-        ],
+        "tags": ["PDF Upload and Download APIs"],
         "summary": "Upload multiple PDFs and get file IDs",
         "description": "This API uploads multiple PDF files to the API Freaks server and generates their unique file IDs.",
         "operationId": "uploadResource",
@@ -32,10 +30,7 @@
             "required": false,
             "schema": {
               "type": "string",
-              "enum": [
-                "json",
-                "xml"
-              ],
+              "enum": ["json", "xml"],
               "default": "json"
             },
             "description": "Specifies the desired format for the API response. Choose 'json' for a JSON object or 'xml' for an XML structure."
@@ -97,10 +92,15 @@
                   }
                 }
               }
+            },
+            "headers": {
+              "X-AF-Credits-Cost": {
+                "$ref": "#/components/headers/X-AF-Credits-Cost"
+              }
             }
           },
           "400": {
-            "description": "Bad Request \u2014 Missing or invalid parameters",
+            "description": "Bad Request — Missing or invalid parameters",
             "content": {
               "application/json": {
                 "schema": {
@@ -119,10 +119,15 @@
                   }
                 }
               }
+            },
+            "headers": {
+              "X-AF-Credits-Cost": {
+                "$ref": "#/components/headers/X-AF-Credits-Cost"
+              }
             }
           },
           "415": {
-            "description": "Unsupported Media Type \u2014 File type not supported",
+            "description": "Unsupported Media Type — File type not supported",
             "content": {
               "application/json": {
                 "schema": {
@@ -141,6 +146,11 @@
                   }
                 }
               }
+            },
+            "headers": {
+              "X-AF-Credits-Cost": {
+                "$ref": "#/components/headers/X-AF-Credits-Cost"
+              }
             }
           }
         }
@@ -165,18 +175,13 @@
     "schemas": {
       "ResourceUploadResponse": {
         "type": "object",
-        "required": [
-          "files"
-        ],
+        "required": ["files"],
         "properties": {
           "files": {
             "type": "array",
             "items": {
               "type": "object",
-              "required": [
-                "fileName",
-                "fileId"
-              ],
+              "required": ["fileName", "fileId"],
               "properties": {
                 "fileName": {
                   "type": "string",
@@ -208,9 +213,7 @@
       "ErrorResponse": {
         "type": "object",
         "description": "Standard error envelope returned by the API on failed requests.",
-        "required": [
-          "message"
-        ],
+        "required": ["message"],
         "properties": {
           "error": {
             "type": "string",
@@ -235,6 +238,14 @@
           }
         }
       }
+    },
+    "headers": {
+      "X-AF-Credits-Cost": {
+        "description": "Specifies the number of credits consumed by the current request.",
+        "schema": {
+          "type": "integer"
+        }
+      }
     }
   },
   "security": [

package/specs/pdf/pdf-restrict.json

@@ -19,9 +19,7 @@
   "paths": {
     "/pdf/restrict": {
       "post": {
-        "tags": [
-          "PDF Security APIs"
-        ],
+        "tags": ["PDF Security APIs"],
         "summary": "Apply permission restrictions on a PDF file",
         "description": "This API applies permission restrictions on a PDF file, such as disabling printing, copying, or editing. This can include password protection to enforce restrictions.",
         "parameters": [
@@ -31,10 +29,7 @@
             "required": false,
             "schema": {
               "type": "string",
-              "enum": [
-                "json",
-                "xml"
-              ],
+              "enum": ["json", "xml"],
               "default": "json"
             },
             "description": "Specifies the desired format for the API response. Choose 'json' for a JSON object or 'xml' for an XML structure."
@@ -100,7 +95,7 @@
             "schema": {
               "type": "string"
             },
-            "description": "A comma-separated list of restrictions to apply to the PDF. These define what the end-user is *not* allowed to do with the PDF. Available options are:\n\n\n* **print_high** \u2013 Disables high-quality printing.\n* **print_low** \u2013 Disables low-resolution printing.\n* **edit_document_assembly** \u2013 Prevents reordering or inserting pages.\n* **fill_form_fields** \u2013 Disallows filling in PDF form fields.\n* **edit_annotations** \u2013 Disables adding or modifying annotations or comments.\n* **modify_content** \u2013 Prevents modifying existing content in the PDF.\n* **copy_and_extract_content** \u2013 Disables copying text or images from the PDF.\n* **use_accessibility** \u2013 Prevents screen readers or accessibility tools from accessing content. An invalid restriction keyword returns a 400 with error \"Invalid PDF Restriction\"."
+            "description": "A comma-separated list of restrictions to apply to the PDF. These define what the end-user is *not* allowed to do with the PDF. Available options are:\n\n\n* **print_high** – Disables high-quality printing.\n* **print_low** – Disables low-resolution printing.\n* **edit_document_assembly** – Prevents reordering or inserting pages.\n* **fill_form_fields** – Disallows filling in PDF form fields.\n* **edit_annotations** – Disables adding or modifying annotations or comments.\n* **modify_content** – Prevents modifying existing content in the PDF.\n* **copy_and_extract_content** – Disables copying text or images from the PDF.\n* **use_accessibility** – Prevents screen readers or accessibility tools from accessing content. An invalid restriction keyword returns a 400 with error \"Invalid PDF Restriction\"."
           },
           {
             "name": "webhook_url",
@@ -118,7 +113,7 @@
             "schema": {
               "type": "boolean"
             },
-            "description": "If true, a notification will also be sent by email in case the webhook request fails all the retries.  The email notification will be sent to the requesting user or their organization\u2019s admin if part of one."
+            "description": "If true, a notification will also be sent by email in case the webhook request fails all the retries.  The email notification will be sent to the requesting user or their organization’s admin if part of one."
           },
           {
             "name": "X-Webhook-Authorization",
@@ -154,17 +149,20 @@
                     "summary": "Task created",
                     "value": {
                       "taskId": "42839406-7e1b-4f64-96bb-d94bb054e8d3",
-                      "inputIds": [
-                        "2c682ade-eccc-4ab5-9c06-d16e415cbecb"
-                      ]
+                      "inputIds": ["2c682ade-eccc-4ab5-9c06-d16e415cbecb"]
                     }
                   }
                 }
               }
+            },
+            "headers": {
+              "X-AF-Credits-Cost": {
+                "$ref": "#/components/headers/X-AF-Credits-Cost"
+              }
             }
           },
           "400": {
-            "description": "Bad Request \u2014 Missing/invalid parameters, file ID, or password",
+            "description": "Bad Request — Missing/invalid parameters, file ID, or password",
             "content": {
               "application/json": {
                 "examples": {
@@ -223,10 +221,15 @@
                   "$ref": "#/components/schemas/ErrorResponse"
                 }
               }
+            },
+            "headers": {
+              "X-AF-Credits-Cost": {
+                "$ref": "#/components/headers/X-AF-Credits-Cost"
+              }
             }
           },
           "415": {
-            "description": "Unsupported Media Type \u2014 File type not supported",
+            "description": "Unsupported Media Type — File type not supported",
             "content": {
               "application/json": {
                 "schema": {
@@ -245,6 +248,11 @@
                   }
                 }
               }
+            },
+            "headers": {
+              "X-AF-Credits-Cost": {
+                "$ref": "#/components/headers/X-AF-Credits-Cost"
+              }
             }
           }
         },
@@ -271,9 +279,7 @@
       "PDFResponse": {
         "type": "object",
         "description": "Response containing the task ID and input file IDs for a PDF processing task.",
-        "required": [
-          "taskId"
-        ],
+        "required": ["taskId"],
         "properties": {
           "taskId": {
             "type": "string",
@@ -303,9 +309,7 @@
       "ErrorResponse": {
         "type": "object",
         "description": "Standard error envelope returned by the API on failed requests.",
-        "required": [
-          "message"
-        ],
+        "required": ["message"],
         "properties": {
           "error": {
             "type": "string",
@@ -330,6 +334,14 @@
           }
         }
       }
+    },
+    "headers": {
+      "X-AF-Credits-Cost": {
+        "description": "Specifies the number of credits consumed by the current request.",
+        "schema": {
+          "type": "integer"
+        }
+      }
     }
   },
   "security": [

package/specs/pdf/pdf-split-pages.json

@@ -19,9 +19,7 @@
   "paths": {
     "/pdf/split": {
       "post": {
-        "tags": [
-          "PDF Operations APIs"
-        ],
+        "tags": ["PDF Operations APIs"],
         "summary": "Split a PDF into smaller files",
         "description": "This API splits a PDF into multiple parts based on specified page numbers or ranges.",
         "parameters": [
@@ -31,10 +29,7 @@
             "required": false,
             "schema": {
               "type": "string",
-              "enum": [
-                "json",
-                "xml"
-              ],
+              "enum": ["json", "xml"],
               "default": "json"
             },
             "description": "Specifies the desired format for the API response. Choose 'json' for a JSON object or 'xml' for an XML structure."
@@ -78,7 +73,7 @@
               },
               "default": []
             },
-            "description": "Defines the page numbers or ranges where the PDF should be split. Provide individual pages and/or ranges in any order (for example: \"1-4,9-5,16-last\"). Separate entries with commas and use hyphens for ranges.\n\nSpecial keywords (use alone):\n\n\u2022 `even` \u2014 split at every even-numbered page\n\n\u2022 `odd` \u2014 split at every odd-numbered page\n\n\u2022 `all` \u2014 split the PDF into single-page files\n\nThe keyword `last` can be used anywhere in the string, in combination with page numbers or ranges (for example: \"5-last\", \"last-2\", \"1,last,9\").\n\nExamples:\n- \"1,4-2,last\"\n- \"odd\"\n- \"all\"\n- \"last,2-5\"\n\nInvalid example: \"1,odd\" (mixing a keyword other than \"last\" with specific pages/ranges is not allowed). You can pass multiple pages entries to produce multiple output files."
+            "description": "Defines the page numbers or ranges where the PDF should be split. Provide individual pages and/or ranges in any order (for example: \"1-4,9-5,16-last\"). Separate entries with commas and use hyphens for ranges.\n\nSpecial keywords (use alone):\n\n• `even` — split at every even-numbered page\n\n• `odd` — split at every odd-numbered page\n\n• `all` — split the PDF into single-page files\n\nThe keyword `last` can be used anywhere in the string, in combination with page numbers or ranges (for example: \"5-last\", \"last-2\", \"1,last,9\").\n\nExamples:\n- \"1,4-2,last\"\n- \"odd\"\n- \"all\"\n- \"last,2-5\"\n\nInvalid example: \"1,odd\" (mixing a keyword other than \"last\" with specific pages/ranges is not allowed). You can pass multiple pages entries to produce multiple output files."
           },
           {
             "name": "webhook_url",
@@ -96,7 +91,7 @@
             "schema": {
               "type": "boolean"
             },
-            "description": "If true, a notification will also be sent by email in case the webhook request fails all the retries.  The email notification will be sent to the requesting user or their organization\u2019s admin if part of one."
+            "description": "If true, a notification will also be sent by email in case the webhook request fails all the retries.  The email notification will be sent to the requesting user or their organization’s admin if part of one."
           },
           {
             "name": "X-Webhook-Authorization",
@@ -121,7 +116,7 @@
         },
         "responses": {
           "200": {
-            "description": "Split task created successfully. Malformed or out-of-range page specifications are not rejected synchronously \u2014 the task is created, then fails asynchronously; poll the task status endpoint and check for status \"failed\" with an error/message pair.",
+            "description": "Split task created successfully. Malformed or out-of-range page specifications are not rejected synchronously — the task is created, then fails asynchronously; poll the task status endpoint and check for status \"failed\" with an error/message pair.",
             "content": {
               "application/json": {
                 "schema": {
@@ -132,17 +127,20 @@
                     "summary": "Task created",
                     "value": {
                       "taskId": "a533a95c-b3fb-49f0-abb1-bef2f3e805ef",
-                      "inputIds": [
-                        "62f910b6-69ce-4cbc-8285-eee5f16467be"
-                      ]
+                      "inputIds": ["62f910b6-69ce-4cbc-8285-eee5f16467be"]
                     }
                   }
                 }
               }
+            },
+            "headers": {
+              "X-AF-Credits-Cost": {
+                "$ref": "#/components/headers/X-AF-Credits-Cost"
+              }
             }
           },
           "400": {
-            "description": "Bad Request \u2014 Invalid file ID",
+            "description": "Bad Request — Invalid file ID",
             "content": {
               "application/json": {
                 "examples": {
@@ -161,10 +159,15 @@
                   "$ref": "#/components/schemas/ErrorResponse"
                 }
               }
+            },
+            "headers": {
+              "X-AF-Credits-Cost": {
+                "$ref": "#/components/headers/X-AF-Credits-Cost"
+              }
             }
           },
           "415": {
-            "description": "Unsupported Media Type \u2014 File type not supported",
+            "description": "Unsupported Media Type — File type not supported",
             "content": {
               "application/json": {
                 "examples": {
@@ -183,6 +186,11 @@
                   "$ref": "#/components/schemas/ErrorResponse"
                 }
               }
+            },
+            "headers": {
+              "X-AF-Credits-Cost": {
+                "$ref": "#/components/headers/X-AF-Credits-Cost"
+              }
             }
           }
         },
@@ -209,9 +217,7 @@
       "PDFResponse": {
         "type": "object",
         "description": "Response containing the task ID and input file IDs for a PDF processing task.",
-        "required": [
-          "taskId"
-        ],
+        "required": ["taskId"],
         "properties": {
           "taskId": {
             "type": "string",
@@ -241,9 +247,7 @@
       "ErrorResponse": {
         "type": "object",
         "description": "Standard error envelope returned by the API on failed requests.",
-        "required": [
-          "message"
-        ],
+        "required": ["message"],
         "properties": {
           "error": {
             "type": "string",
@@ -268,6 +272,14 @@
           }
         }
       }
+    },
+    "headers": {
+      "X-AF-Credits-Cost": {
+        "description": "Specifies the number of credits consumed by the current request.",
+        "schema": {
+          "type": "integer"
+        }
+      }
     }
   },
   "security": [

package/specs/pdf/pdf-task-status.json

@@ -84,6 +84,11 @@
                   }
                 }
               }
+            },
+            "headers": {
+              "X-AF-Credits-Cost": {
+                "$ref": "#/components/headers/X-AF-Credits-Cost"
+              }
             }
           },
           "400": {
@@ -106,6 +111,11 @@
                   "$ref": "#/components/schemas/ErrorResponse"
                 }
               }
+            },
+            "headers": {
+              "X-AF-Credits-Cost": {
+                "$ref": "#/components/headers/X-AF-Credits-Cost"
+              }
             }
           },
           "404": {
@@ -128,6 +138,11 @@
                   "$ref": "#/components/schemas/ErrorResponse"
                 }
               }
+            },
+            "headers": {
+              "X-AF-Credits-Cost": {
+                "$ref": "#/components/headers/X-AF-Credits-Cost"
+              }
             }
           }
         },
@@ -239,6 +254,14 @@
           }
         }
       }
+    },
+    "headers": {
+      "X-AF-Credits-Cost": {
+        "description": "Specifies the number of credits consumed by the current request.",
+        "schema": {
+          "type": "integer"
+        }
+      }
     }
   },
   "security": [