Oracle WebLogic Server Library Deployments API

openapi: 3.2.0
info:
  title: Oracle Weblogic Library Deployments API
  version: '1.0'
  description: 'Operations tagged Library Deployments across 2 of this provider''s published API definitions: oracle-weblogic-deployment-openapi.yml, weblogic-library-deployments-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: http://localhost:7001/management/weblogic/latest
  description: WebLogic Administration Server (default)
- url: http://{host}:{port}/management/weblogic/{version}
  description: WebLogic Administration Server (configurable)
  variables:
    host:
      default: localhost
    port:
      default: '7001'
    version:
      default: latest
- url: https://{host}:{port}/management/weblogic/latest
  description: WebLogic Server Administration Server
  variables:
    host:
      default: localhost
      description: Hostname of the WebLogic Administration Server
    port:
      default: '7001'
      description: Port of the WebLogic Administration Server
security:
- basicAuth: []
tags:
- name: Library Deployments
  description: Deploy and manage shared library deployments
paths:
  /edit/libDeployments:
    get:
      operationId: listLibDeployments
      summary: Oracle WebLogic Server List all shared library deployments
      description: Returns all shared library deployments configured in the domain.
      tags:
      - Library Deployments
      parameters:
      - $ref: '#/components/parameters/Fields'
      - $ref: '#/components/parameters/Links'
      responses:
        '200':
          description: Collection of library deployments
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/LibDeployment'
    post:
      operationId: deployLibrary
      summary: Oracle WebLogic Server Deploy a shared library
      description: Deploys a shared library that can be referenced by applications. Requires an active edit session.
      tags:
      - Library Deployments
      parameters:
      - $ref: '#/components/parameters/XRequestedBy'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LibDeploymentCreateRequest'
      responses:
        '201':
          description: Library deployed
          headers:
            Location:
              schema:
                type: string
                format: uri
    servers:
    - url: http://localhost:7001/management/weblogic/latest
      description: WebLogic Administration Server (default)
    - url: http://{host}:{port}/management/weblogic/{version}
      description: WebLogic Administration Server (configurable)
      variables:
        host:
          default: localhost
        port:
          default: '7001'
        version:
          default: latest
  /edit/libDeployments/{libName}:
    get:
      operationId: getLibDeployment
      summary: Oracle WebLogic Server Get shared library deployment details
      tags:
      - Library Deployments
      parameters:
      - $ref: '#/components/parameters/LibName'
      responses:
        '200':
          description: Library deployment details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LibDeployment'
    delete:
      operationId: undeployLibrary
      summary: Oracle WebLogic Server Remove a shared library deployment
      tags:
      - Library Deployments
      parameters:
      - $ref: '#/components/parameters/LibName'
      - $ref: '#/components/parameters/XRequestedBy'
      responses:
        '204':
          description: Library undeployed
    servers:
    - url: http://localhost:7001/management/weblogic/latest
      description: WebLogic Administration Server (default)
    - url: http://{host}:{port}/management/weblogic/{version}
      description: WebLogic Administration Server (configurable)
      variables:
        host:
          default: localhost
        port:
          default: '7001'
        version:
          default: latest
  /edit/libraries:
    get:
      operationId: listLibraries
      summary: Oracle WebLogic Server APIs List all shared library deployments
      description: Returns all shared library deployment configurations in the domain.
      tags:
      - Library Deployments
      responses:
        '200':
          description: List of shared library deployments
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/LibraryDeployment'
        '401':
          $ref: '#/components/responses/Unauthorized'
    post:
      operationId: createLibrary
      summary: Oracle WebLogic Server APIs Create a shared library deployment
      description: Creates a new shared library deployment. Requires an active edit session.
      tags:
      - Library Deployments
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LibraryDeploymentCreate'
      responses:
        '201':
          description: Library deployment created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LibraryDeployment'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
    servers:
    - url: https://{host}:{port}/management/weblogic/latest
      description: WebLogic Server Administration Server
      variables:
        host:
          default: localhost
          description: Hostname of the WebLogic Administration Server
        port:
          default: '7001'
          description: Port of the WebLogic Administration Server
  /edit/libraries/{libraryName}:
    get:
      operationId: getLibrary
      summary: Oracle WebLogic Server APIs Get a shared library deployment
      description: Returns the configuration of a specific shared library deployment.
      tags:
      - Library Deployments
      parameters:
      - $ref: '#/components/parameters/libraryName'
      responses:
        '200':
          description: Library deployment configuration
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LibraryDeployment'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
    delete:
      operationId: deleteLibrary
      summary: Oracle WebLogic Server APIs Remove a shared library deployment
      description: Removes a shared library deployment from the domain. Requires an active edit session.
      tags:
      - Library Deployments
      parameters:
      - $ref: '#/components/parameters/libraryName'
      responses:
        '200':
          description: Library deployment removed
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
    servers:
    - url: https://{host}:{port}/management/weblogic/latest
      description: WebLogic Server Administration Server
      variables:
        host:
          default: localhost
          description: Hostname of the WebLogic Administration Server
        port:
          default: '7001'
          description: Port of the WebLogic Administration Server
components:
  parameters:
    Links:
      name: links
      in: query
      description: Comma-separated list of link relations to include
      schema:
        type: string
    LibName:
      name: libName
      in: path
      required: true
      description: Name of the shared library
      schema:
        type: string
    XRequestedBy:
      name: X-Requested-By
      in: header
      required: true
      description: CSRF protection header
      schema:
        type: string
        example: MyClient
    Fields:
      name: fields
      in: query
      description: Comma-separated list of property names to include
      schema:
        type: string
    libraryName:
      name: libraryName
      in: path
      required: true
      description: The name of the shared library deployment
      schema:
        type: string
  schemas:
    Link:
      type: object
      properties:
        rel:
          type: string
        href:
          type: string
          format: uri
        title:
          type: string
    Identity:
      type: object
      properties:
        identity:
          type: array
          items:
            type: string
    LibDeploymentCreateRequest:
      type: object
      required:
      - name
      properties:
        name:
          type: string
          description: Library name
        sourceURL:
          type: string
          description: URL or file path to the library archive
        targets:
          type: array
          items:
            $ref: '#/components/schemas/Identity'
    LibDeployment:
      type: object
      properties:
        identity:
          type: array
          items:
            type: string
        name:
          type: string
          description: Library name
        sourcePath:
          type: string
          description: Path to the library archive
        targets:
          type: array
          items:
            $ref: '#/components/schemas/Identity'
        deploymentOrder:
          type: integer
        links:
          type: array
          items:
            $ref: '#/components/schemas/Link'
    LibraryDeploymentCreate:
      type: object
      properties:
        name:
          type: string
          description: Library name
        sourcePath:
          type: string
          description: Path to the library archive
        targets:
          type: array
          items:
            type: string
          description: Target servers or clusters
        moduleType:
          type: string
          enum:
          - ear
          - war
          - jar
        stagingMode:
          type: string
          enum:
          - stage
          - nostage
          - external_stage
        deploymentOrder:
          type: integer
          default: 100
      required:
      - name
      - sourcePath
      - targets
    LibraryDeployment:
      type: object
      properties:
        name:
          type: string
          description: Library name
        sourcePath:
          type: string
          description: Path to the library archive
        targets:
          type: array
          items:
            type: string
          description: Target servers or clusters
        specificationVersion:
          type: string
          description: Library specification version
        implementationVersion:
          type: string
          description: Library implementation version
        moduleType:
          type: string
          description: Module type
          enum:
          - ear
          - war
          - jar
        stagingMode:
          type: string
          enum:
          - stage
          - nostage
          - external_stage
        deploymentOrder:
          type: integer
          default: 100
        links:
          type: array
          items:
            $ref: '#/components/schemas/Link'
    Error:
      type: object
      properties:
        type:
          type: string
        title:
          type: string
        status:
          type: integer
        detail:
          type: string
  responses:
    BadRequest:
      description: Invalid request parameters or body
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    NotFound:
      description: The specified resource was not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: Authentication required or invalid credentials
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic authentication. Deployer role required for deployment operations, Operator role for lifecycle operations.
x-refined-from:
- oracle-weblogic-deployment-openapi.yml
- weblogic-library-deployments-api-openapi.yml