openapi: 3.1.0
info:
  title: PeopleSoft Update Manager API
  description: REST services for automated update image management, change package generation, and PeopleSoft Automated Updates (PAU).
  version: 1.0.0
  contact:
    name: Oracle Support
    email: support@oracle.com
    url: https://support.oracle.com
  license:
    name: Proprietary
    url: https://www.oracle.com/contracts/
servers:
- url: https://{hostname}:{port}/psft/api/pum/v1
  description: PeopleSoft Instance
  variables:
    hostname:
      description: PeopleSoft server hostname
      default: localhost
    port:
      description: PeopleSoft server port
      default: '8000'
externalDocs:
  description: PeopleSoft Update Manager Documentation
  url: https://docs.oracle.com/cd/E52319_01/infoportal/pum.html
tags:
- name: Updates
  description: Update and patch management operations
paths:
  /updates:
    get:
      summary: PeopleSoft List Available Updates
      description: Retrieve a list of available updates and change packages.
      operationId: listUpdates
      tags:
      - Updates
      security:
      - basicAuth: []
      responses:
        '200':
          description: Successful response with available updates
          content:
            application/json:
              schema:
                type: object
                properties:
                  updates:
                    type: array
                    items:
                      type: object
                      properties:
                        updateId:
                          type: string
                        description:
                          type: string
                        version:
                          type: string
                        status:
                          type: string
        '401':
          description: Unauthorized
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /updates/{updateId}/apply:
    post:
      summary: PeopleSoft Apply Update
      description: Initiate application of a specific update or change package.
      operationId: applyUpdate
      tags:
      - Updates
      security:
      - basicAuth: []
      parameters:
      - name: updateId
        in: path
        required: true
        description: The update identifier
        schema:
          type: string
        example: PS123456
      responses:
        '202':
          description: Update application initiated
        '401':
          description: Unauthorized
        '404':
          description: Update not found
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic