Apache PDFBox Signatures API

openapi: 3.0.3
info:
  title: Apache PDFBox Documents Signatures API
  description: Apache PDFBox is an open-source Java library for working with PDF documents. This API represents the REST service interface for PDF creation, manipulation, text extraction, and digital signatures.
  version: 3.0.0
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
  contact:
    url: https://pdfbox.apache.org/
servers:
- url: https://{host}/pdfbox
  description: Apache PDFBox REST service
  variables:
    host:
      default: localhost:8080
tags:
- name: Signatures
paths:
  /documents/{documentId}/sign:
    post:
      operationId: signDocument
      summary: Apache PDFBox Sign Document
      description: Apply a digital signature to a PDF document.
      tags:
      - Signatures
      parameters:
      - $ref: '#/components/parameters/documentId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SignRequest'
      responses:
        '200':
          description: Signed document info
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentInfo'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    DocumentInfo:
      type: object
      properties:
        documentId:
          type: string
          example: doc-abc123
        title:
          type: string
          example: My Document
        pageCount:
          type: integer
          example: 10
        fileSize:
          type: integer
          example: 204800
        version:
          type: string
          example: '1.4'
    SignRequest:
      type: object
      properties:
        keystorePath:
          type: string
          example: keystore.p12
        password:
          type: string
          example: keystore-password
        reason:
          type: string
          example: Document approval
        location:
          type: string
          example: San Francisco, CA
  parameters:
    documentId:
      name: documentId
      in: path
      required: true
      schema:
        type: string
      description: Document identifier
      example: doc-abc123
x-generated-from: documentation