@apifreaks/openapi-specs 0.1.0 → 0.1.2

package/dist/specs/pdf/pdf-resource-upload-binary.yaml

@@ -0,0 +1,152 @@
+openapi: 3.1.1
+info:
+  title: PDF Binary Resource Upload API Reference
+  version: 1.0.0
+  description: Upload a PDF file as raw binary data in the request body. Returns file metadata including the file ID, file name, size, and type. This endpoint accepts the raw file bytes directly instead of multipart form-data.
+  contact:
+    name: APIFreaks Support
+    url: https://apifreaks.com/contact
+    email: support@apifreaks.com
+servers:
+  - url: https://api.apifreaks.com/v1.0
+    description: PDF Binary Resource Upload API Server
+paths:
+  /pdf/resource/upload-binary:
+    post:
+      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:
+        - 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_name
+          in: query
+          required: true
+          schema:
+            type: string
+          description: |-
+            The desired name for the uploaded PDF file. This name will be used for storage on the server.
+
+
+             **NOTE**: Please ensure file_name has extension `.pdf`.
+      requestBody:
+        description: Raw PDF file bytes sent directly as the request body (not multipart).
+        required: true
+        content:
+          application/octet-stream:
+            schema:
+              type: string
+              format: binary
+              description: The PDF file to be uploaded to the API Freaks server in binary format.
+      responses:
+        '200':
+          description: PDF upload successfully
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/BinaryResourceUploadResponse'
+              examples:
+                success:
+                  summary: File uploaded
+                  value:
+                    fileName: binarytest.pdf
+                    fileId: b0fbf78c-8fe2-49b6-ad3d-63efb4ac8e58
+        '400':
+          description: Bad Request — Missing file_name or empty body
+          content:
+            application/json:
+              examples:
+                missingFileName:
+                  summary: Missing file_name query parameter
+                  value:
+                    error: Invalid Param Exception
+                    message: please pass correct parameters
+                    path: /v1.0/pdf/resource/upload-binary
+                    status: 400
+                    timestamp: '2026-07-27T10:48:14.902Z'
+                emptyBody:
+                  summary: Empty request body
+                  value:
+                    timestamp: '2026-07-27T10:48:16.046Z'
+                    path: /v1.0/pdf/upload-binary
+                    status: 400
+                    error: Invalid Parameter
+                    message: Invalid parameter value provided for 'dataBufferFlux'.
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+        '415':
+          description: Unsupported Media Type — File extension not supported
+          content:
+            application/json:
+              examples:
+                UnsupportedFileType:
+                  summary: Unsupported file type
+                  value:
+                    timestamp: '2026-07-27T10:48:15.449Z'
+                    path: /v1.0/pdf/upload-binary
+                    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: uploadResourceBinary
+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:
+    BinaryResourceUploadResponse:
+      type: object
+      required:
+        - fileName
+        - fileId
+      properties:
+        fileName:
+          type: string
+          description: The name of the uploaded file.
+        fileId:
+          type: string
+          description: The unique identifier assigned to the uploaded file.
+      description: Binary resource upload response containing file metadata.
+    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/pdf-resource-upload.yaml

@@ -0,0 +1,163 @@
+openapi: 3.1.1
+info:
+  title: PDF Resource Upload API Reference
+  version: 1.0.0
+  description: Upload one or more PDF files to the server using multipart form-data. Returns an array of file metadata objects, one per uploaded file, each containing a `fileName` and a `fileId` for use in subsequent PDF processing operations (merge, split, compress, status checks, download, delete). Repeat the `file` form field to upload multiple files in a single request. Unsupported file types return a `415` error instead of a partial upload.
+  contact:
+    name: APIFreaks Support
+    url: https://apifreaks.com/contact
+    email: support@apifreaks.com
+servers:
+  - url: https://api.apifreaks.com/v1.0
+    description: PDF Resource Upload API Server
+paths:
+  /pdf/resource/upload:
+    post:
+      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
+      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.
+      requestBody:
+        description: Multipart form-data body carrying the PDF file(s) to upload. Repeat the file field to upload multiple files in one request.
+        required: true
+        content:
+          multipart/form-data:
+            schema:
+              $ref: '#/components/schemas/ResourceUploadRequest'
+            examples:
+              typicalUpload:
+                summary: Upload a single PDF file
+                value:
+                  file: <binary PDF file content>
+      responses:
+        '200':
+          description: PDF upload successful
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ResourceUploadResponse'
+              examples:
+                typicalSuccess:
+                  summary: Single file uploaded
+                  value:
+                    files:
+                      - fileName: test.pdf
+                        fileId: b61a80d1-9b2d-4748-b3d1-04d747dedc8c
+                multipleFiles:
+                  summary: Multiple files uploaded in one request
+                  value:
+                    files:
+                      - fileName: test.pdf
+                        fileId: 9922d104-25a0-432c-8c26-2be2ba14798a
+                      - fileName: test.pdf
+                        fileId: 8a6b3332-6fe0-42b0-a808-df7a36926a79
+        '400':
+          description: Bad Request — Missing or invalid parameters
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+              examples:
+                missingFile:
+                  summary: No file provided in the request body
+                  value:
+                    timestamp: '2026-07-27T10:42:36.770Z'
+                    path: /v1.0/pdf/upload
+                    status: 400
+                    error: Missing or Invalid Parameters
+                    message: One or more required parameters are missing or incorrect.
+        '415':
+          description: Unsupported Media Type — File type not supported
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+              examples:
+                unsupportedFileType:
+                  summary: Unsupported file type
+                  value:
+                    timestamp: '2026-07-27T10:47:37.481Z'
+                    path: /v1.0/pdf/upload
+                    status: 415
+                    error: Unsupported File Type
+                    message: The provided file type is not supported. Refer to the documentation for valid file types.
+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:
+    ResourceUploadResponse:
+      type: object
+      required:
+        - files
+      properties:
+        files:
+          type: array
+          items:
+            type: object
+            required:
+              - fileName
+              - fileId
+            properties:
+              fileName:
+                type: string
+                description: Name of the uploaded file.
+              fileId:
+                type: string
+                description: Unique ID of the uploaded file, used to reference it in processing operations.
+          description: Array of uploaded file metadata objects.
+      description: Resource upload response containing file metadata.
+    ResourceUploadRequest:
+      type: object
+      description: Multipart form-data request body containing the file to upload.
+      required: []
+      properties:
+        file:
+          type: string
+          format: binary
+          description: Raw PDF file bytes sent as a multipart/form-data field named 'file'. Repeat this field to upload multiple files in one request.
+    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/pdf-restrict.yaml

@@ -0,0 +1,246 @@
+openapi: 3.1.1
+info:
+  title: PDF Restrict API Reference
+  version: 1.0.0
+  description: Restrict a PDF file with permission controls. Set printing, copying, and editing restrictions with an owner password.
+  contact:
+    name: APIFreaks Support
+    url: https://apifreaks.com/contact
+    email: support@apifreaks.com
+servers:
+  - url: https://api.apifreaks.com/v1.0
+    description: PDF Restrict API Server
+paths:
+  /pdf/restrict:
+    post:
+      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:
+        - 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 restricted PDF file. If not provided, a default name will be assigned.
+        - name: file_password
+          in: query
+          required: false
+          schema:
+            type: string
+          description: The password to unlock the input file if it is already secured. Provide the owner password if available; otherwise, the user password. 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 password users will use to open the PDF. If this is not set, only the owner password will be configured, and anyone can open the PDF file with the provided restrictions enabled. Password Length should be between 6 and 128 characters.
+        - name: owner_password
+          in: query
+          required: false
+          schema:
+            type: string
+          description: Sets the password that allows full access to the PDF (e.g., removing restrictions). If not provided, the `user_password` (if set) will also be used as the owner password. Password Length should be between 6 and 128 characters.
+        - name: restrictions
+          in: query
+          required: true
+          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:
+
+
+            * **print_high** – Disables high-quality printing.
+            * **print_low** – Disables low-resolution printing.
+            * **edit_document_assembly** – Prevents reordering or inserting pages.
+            * **fill_form_fields** – Disallows filling in PDF form fields.
+            * **edit_annotations** – Disables adding or modifying annotations or comments.
+            * **modify_content** – Prevents modifying existing content in the PDF.
+            * **copy_and_extract_content** – Disables copying text or images from the PDF.
+            * **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
+          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 restrict. 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 restrict successfully
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/PDFResponse'
+              examples:
+                success:
+                  summary: Task created
+                  value:
+                    taskId: 42839406-7e1b-4f64-96bb-d94bb054e8d3
+                    inputIds:
+                      - 2c682ade-eccc-4ab5-9c06-d16e415cbecb
+        '400':
+          description: Bad Request — Missing/invalid parameters, file ID, or password
+          content:
+            application/json:
+              examples:
+                MissingParams:
+                  summary: Missing required user_password or restrictions parameter
+                  value:
+                    error: Invalid Param Exception
+                    message: please pass correct parameters
+                    path: /v1.0/pdf/restrict
+                    status: 400
+                    timestamp: '2026-07-27T10:57:14.449Z'
+                MissingFileOrID:
+                  summary: Neither a file nor a file ID was provided
+                  value:
+                    timestamp: '2026-07-27T10:57:25.953Z'
+                    path: /v1.0/pdf/restrict-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:
+                    timestamp: '2026-07-27T10:57:24.835Z'
+                    path: /v1.0/pdf/restrict
+                    status: 400
+                    error: Invalid File ID Provided
+                    message: Please provide a valid file ID
+                WeakPassword:
+                  summary: Password does not meet strength requirements
+                  value:
+                    timestamp: '2026-07-27T10:57:15.634Z'
+                    path: /v1.0/pdf/restrict-pdf
+                    status: 400
+                    error: Weak Password Provided
+                    message: Please provide a strong password. Refer to the documentation for password requirements.
+                InvalidRestriction:
+                  summary: Unrecognized restriction keyword
+                  value:
+                    timestamp: '2026-07-27T10:57:16.268Z'
+                    path: /v1.0/pdf/restrict-pdf
+                    status: 400
+                    error: Invalid PDF Restriction
+                    message: Please provide valid PDF restrictions. Refer to the documentation for valid PDF restrictions.
+              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:57:25.374Z'
+                    path: /v1.0/pdf/restrict-pdf
+                    status: 415
+                    error: Unsupported File Type
+                    message: The provided file type is not supported. Refer to the documentation for valid file types.
+      operationId: restrictPdf
+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: []