@apifreaks/openapi-specs 0.1.0 → 0.1.2

package/dist/specs/pdf/pdf-unrestrict.yaml

@@ -0,0 +1,221 @@
+openapi: 3.1.1
+info:
+  title: PDF Unrestrict API Reference
+  version: 1.0.0
+  description: Remove all restrictions from a restricted PDF file using the owner password. Returns a task ID for tracking the unrestrict progress.
+  contact:
+    name: APIFreaks Support
+    url: https://apifreaks.com/contact
+    email: support@apifreaks.com
+servers:
+  - url: https://api.apifreaks.com/v1.0
+    description: PDF Unrestrict API Server
+paths:
+  /pdf/unrestrict:
+    post:
+      tags:
+        - PDF Security APIs
+      summary: Remove permission restrictions from a PDF while keeping it encrypted.
+      description: This API removes permission restrictions from a PDF while keeping it encrypted. If you want to remove all security (including encryption), use the `/pdf/decrypt` endpoint instead.
+      parameters:
+        - name: format
+          in: query
+          required: false
+          schema:
+            type: string
+            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.
+        - name: file_id
+          in: query
+          required: false
+          schema:
+            type: string
+          description: The unique ID of a PDF file already uploaded to the API Freaks server. Use this as an alternative to uploading a new file directly.
+        - name: destroy
+          in: query
+          required: false
+          schema:
+            type: boolean
+          description: If set to `true`, the input file(s) will be permanently deleted from the server immediately after the output PDF is generated.
+        - name: output
+          in: query
+          required: false
+          schema:
+            type: string
+          description: The desired name for the output unrestricted PDF file. If not provided, a default name will be assigned.
+        - name: file_password
+          in: query
+          required: true
+          schema:
+            type: string
+          description: The password to unlock the input file. Either the owner password or user password can be provided. The owner password takes precedence. Password Length should be between 6 and 128 characters.
+        - name: user_password
+          in: query
+          required: true
+          schema:
+            type: string
+          description: Sets the user password for the PDF file. Required — providing only owner_password without user_password is rejected. Password Length should be between 6 and 128 characters.
+        - name: owner_password
+          in: query
+          required: false
+          schema:
+            type: string
+          description: Sets the owner password for the PDF file. If the owner password is not provided, the `user_password` will also be used as the owner password. Password Length should be between 6 and 128 characters.
+        - name: webhook_url
+          in: query
+          required: false
+          schema:
+            type: string
+          description: The URL to which the webhook notification will be sent after the task is completed.
+        - name: webhook_failure_notification
+          in: query
+          required: false
+          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’s admin if part of one.
+        - name: X-Webhook-Authorization
+          in: header
+          required: false
+          schema:
+            type: string
+          description: 'Optional custom header for webhook requests. Format: `Key:Value` (e.g., `Authorization:Bearer token123`). This will be sent as an HTTP header in the webhook call.'
+      requestBody:
+        description: Multipart form-data body carrying the PDF file to unrestrict. Alternatively, reference an already-uploaded file via the file_id query parameter instead of uploading here.
+        required: false
+        content:
+          multipart/form-data:
+            schema:
+              $ref: '#/components/schemas/PdfFileUploadRequest'
+      responses:
+        '200':
+          description: PDF unrestrict successfully
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/PDFResponse'
+              examples:
+                success:
+                  summary: Task created
+                  value:
+                    taskId: 16cc979a-55b9-476c-bfef-0977314478ec
+                    inputIds:
+                      - 9c809ef8-583a-40f1-afe2-424d1d953b69
+        '400':
+          description: Bad Request — Missing/invalid parameters, file ID, or password
+          content:
+            application/json:
+              examples:
+                MissingParams:
+                  summary: Missing required file_password or user_password parameter
+                  value:
+                    error: Invalid Param Exception
+                    message: please pass correct parameters
+                    path: /v1.0/pdf/unrestrict
+                    status: 400
+                    timestamp: '2026-07-27T10:59:22.835Z'
+                MissingFileOrID:
+                  summary: Neither a file nor a file ID was provided
+                  value:
+                    timestamp: '2026-07-27T10:59:23.398Z'
+                    path: /v1.0/pdf/unrestrict-pdf
+                    status: 400
+                    error: Missing File or ID
+                    message: Please provide either a file or a file ID.
+                InvalidID:
+                  summary: file_id is malformed or does not exist
+                  value:
+                    error: Invalid File ID Provided
+                    message: Please provide a valid file ID
+                    path: /v1.0/pdf/unrestrict
+                    status: 400
+                    timestamp: '2026-07-27T10:59:23.936Z'
+                WeakPassword:
+                  summary: New password does not meet strength requirements
+                  value:
+                    timestamp: '2026-07-27T10:59:25.041Z'
+                    path: /v1.0/pdf/unrestrict-pdf
+                    status: 400
+                    error: Weak Password Provided
+                    message: Please provide a strong password. Refer to the documentation for password requirements.
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+        '415':
+          description: Unsupported Media Type — File type not supported
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+              examples:
+                UnsupportedFileType:
+                  summary: Uploaded file is not a supported type
+                  value:
+                    timestamp: '2026-07-27T10:59:24.507Z'
+                    path: /v1.0/pdf/unrestrict-pdf
+                    status: 415
+                    error: Unsupported File Type
+                    message: The provided file type is not supported. Refer to the documentation for valid file types.
+      operationId: unrestrictPdf
+components:
+  securitySchemes:
+    ApiKeyAuthHeader:
+      type: apiKey
+      in: header
+      name: X-apiKey
+      description: Pass your API key via the X-apiKey request header.
+    ApiKeyAuthQuery:
+      type: apiKey
+      in: query
+      name: apiKey
+      description: Pass your API key via the apiKey query parameter.
+  schemas:
+    PDFResponse:
+      type: object
+      description: Response containing the task ID and input file IDs for a PDF processing task.
+      required:
+        - taskId
+      properties:
+        taskId:
+          type: string
+          description: Task ID of the requested task, used to check the task status.
+        inputIds:
+          type: array
+          items:
+            type: string
+          description: File IDs for the input files provided for the task. Not returned when destroy parameter is true.
+    PdfFileUploadRequest:
+      type: object
+      description: Multipart form-data request body containing the PDF file to process.
+      required: []
+      properties:
+        file:
+          type: string
+          format: binary
+          description: Raw PDF file bytes sent as a multipart/form-data field named 'file'. Omit this field entirely and pass file_id in the query string instead to use an already-uploaded file.
+    ErrorResponse:
+      type: object
+      description: Standard error envelope returned by the API on failed requests.
+      required:
+        - message
+      properties:
+        error:
+          type: string
+          description: Short error category or exception type.
+        message:
+          type: string
+          description: Human-readable error message describing the failure.
+        path:
+          type: string
+          description: API endpoint path that produced the error.
+        status:
+          type: integer
+          description: HTTP status code returned with the error.
+        timestamp:
+          type: string
+          format: date-time
+          description: Timestamp when the error occurred (ISO 8601).
+security:
+  - ApiKeyAuthHeader: []
+  - ApiKeyAuthQuery: []

package/dist/specs/pdf/rotate-pdf-pages.yaml

@@ -0,0 +1,207 @@
+openapi: 3.1.1
+info:
+  title: PDF Rotate API - Instantly Change Page Orientation
+  version: 1.0.0
+  description: Rotate pages in a PDF file by 90, 180, or 270 degrees. Supports individual page rotation or batch rotation. Returns a task ID.
+  contact:
+    name: APIFreaks Support
+    url: https://apifreaks.com/contact
+    email: support@apifreaks.com
+servers:
+  - url: https://api.apifreaks.com/v1.0
+    description: PDF Rotate API Server
+paths:
+  /pdf/rotate:
+    post:
+      tags:
+        - PDF Operations APIs
+      summary: Rotate pages in a PDF
+      description: This API rotates pages of a PDF by a specified angle (in multiples of 90 degrees).
+      parameters:
+        - name: format
+          in: query
+          required: false
+          schema:
+            type: string
+            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.
+        - name: file_id
+          in: query
+          required: false
+          schema:
+            type: string
+          description: The unique ID of a PDF file already uploaded to the API Freaks server. Use this as an alternative to uploading a new file directly.
+        - name: destroy
+          in: query
+          required: false
+          schema:
+            type: boolean
+          description: If set to `true`, the input file(s) will be permanently deleted from the server immediately after the output PDF is generated.
+        - name: output
+          in: query
+          required: false
+          schema:
+            type: string
+          description: The desired name for the output PDF file after rotation. If not provided, a default name will be assigned.
+        - name: pages
+          in: query
+          required: false
+          schema:
+            type: string
+          description: 'Specifies which pages to rotate. Accepts individual page numbers (e.g., ''1,7'') and/or ascending page ranges (e.g., ''3-5''). Use commas to separate entries and hyphens for ranges. Reverse ranges (e.g., ''5-3'') are not allowed. Alternatively, provide only one of the following keywords: ''even'' (rotate all even-numbered pages), ''odd'' (rotate all odd-numbered pages), ''last'' (rotate only the last page), or ''all'' (rotate all pages). Examples: ''1,3-5'', ''odd'', ''all''. Mixing special keywords with specific pages/ranges is not allowed.'
+        - name: rotate
+          in: query
+          required: true
+          schema:
+            type: integer
+          description: 'The angle in degrees to rotate the selected pages. Must be one of the following values: 0, 90, 180, 270, -90, -180, or -270. All rotations are applied clockwise.'
+        - name: webhook_url
+          in: query
+          required: false
+          schema:
+            type: string
+          description: The URL to which the webhook notification will be sent after the task is completed.
+        - name: webhook_failure_notification
+          in: query
+          required: false
+          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’s admin if part of one.
+        - name: X-Webhook-Authorization
+          in: header
+          required: false
+          schema:
+            type: string
+          description: 'Optional custom header for webhook requests. Format: `Key:Value` (e.g., `Authorization:Bearer token123`). This will be sent as an HTTP header in the webhook call.'
+      requestBody:
+        description: Multipart form-data body carrying the PDF file to rotate. Alternatively, reference an already-uploaded file via the file_id query parameter instead of uploading here.
+        required: false
+        content:
+          multipart/form-data:
+            schema:
+              $ref: '#/components/schemas/PdfFileUploadRequest'
+      responses:
+        '200':
+          description: Rotate 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:
+                $ref: '#/components/schemas/PDFResponse'
+              examples:
+                success:
+                  summary: Task created
+                  value:
+                    taskId: b59d27fa-9865-4ad8-8e7c-818eb263892b
+                    inputIds:
+                      - 0fb39c16-db08-4ac8-bb5f-51656f934aaa
+        '400':
+          description: Bad Request — Missing/invalid parameters or file ID
+          content:
+            application/json:
+              examples:
+                MissingRotate:
+                  summary: Missing required rotate parameter
+                  value:
+                    error: Invalid Param Exception
+                    message: please pass correct parameters
+                    path: /v1.0/pdf/rotate
+                    status: 400
+                    timestamp: '2026-07-27T10:54:37.098Z'
+                InvalidRotation:
+                  summary: rotate value is not a supported angle
+                  value:
+                    timestamp: '2026-07-27T10:54:37.663Z'
+                    path: /v1.0/pdf/rotate
+                    status: 400
+                    error: Invalid Rotation Angle
+                    message: Please provide a valid rotation angle. Refer to the documentation for valid rotation angles.
+                InvalidID:
+                  summary: file_id is malformed or does not exist
+                  value:
+                    error: Invalid File ID Provided
+                    message: Please provide a valid file ID
+                    path: /v1.0/pdf/rotate
+                    status: 400
+                    timestamp: '2026-07-27T10:54:38.253Z'
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+        '415':
+          description: Unsupported Media Type — File type not supported
+          content:
+            application/json:
+              examples:
+                UnsupportedFileType:
+                  summary: Uploaded file is not a supported type
+                  value:
+                    timestamp: '2026-07-27T10:54:38.800Z'
+                    path: /v1.0/pdf/rotate
+                    status: 415
+                    error: Unsupported File Type
+                    message: The provided file type is not supported. Refer to the documentation for valid file types.
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+      operationId: rotatePdfPages
+components:
+  securitySchemes:
+    ApiKeyAuthHeader:
+      type: apiKey
+      in: header
+      name: X-apiKey
+      description: Pass your API key via the X-apiKey request header.
+    ApiKeyAuthQuery:
+      type: apiKey
+      in: query
+      name: apiKey
+      description: Pass your API key via the apiKey query parameter.
+  schemas:
+    PDFResponse:
+      type: object
+      description: Response containing the task ID and input file IDs for a PDF processing task.
+      required:
+        - taskId
+      properties:
+        taskId:
+          type: string
+          description: Task ID of the requested task, used to check the task status.
+        inputIds:
+          type: array
+          items:
+            type: string
+          description: File IDs for the input files provided for the task. Not returned when destroy parameter is true.
+    PdfFileUploadRequest:
+      type: object
+      description: Multipart form-data request body containing the PDF file to process.
+      required: []
+      properties:
+        file:
+          type: string
+          format: binary
+          description: Raw PDF file bytes sent as a multipart/form-data field named 'file'. Omit this field entirely and pass file_id in the query string instead to use an already-uploaded file.
+    ErrorResponse:
+      type: object
+      description: Standard error envelope returned by the API on failed requests.
+      required:
+        - message
+      properties:
+        error:
+          type: string
+          description: Short error category or exception type.
+        message:
+          type: string
+          description: Human-readable error message describing the failure.
+        path:
+          type: string
+          description: API endpoint path that produced the error.
+        status:
+          type: integer
+          description: HTTP status code returned with the error.
+        timestamp:
+          type: string
+          format: date-time
+          description: Timestamp when the error occurred (ISO 8601).
+security:
+  - ApiKeyAuthHeader: []
+  - ApiKeyAuthQuery: []