openapi: 3.2.0
info:
  description: "Use the OS Management Hub API to manage and monitor updates and patches for instances in OCI, your private data center, or 3rd-party clouds. \nFor more information, see [Overview of OS Management Hub](https://docs.cloud.oracle.com/iaas/osmh/doc/overview.htm).\n"
  title: OS Management Hub Software Source API
  version: '20220901'
  x-provenance:
    method: harvested
    first_party: true
    publisher: Oracle
    source: https://docs.oracle.com/en-us/iaas/api/specs/53a02334fff4534e79601c527b7a16800905500d2c670af774e682c05d12a1e6.yaml
    harvested: '2026-08-04'
    note: Published by Oracle as the contract for the OS Management Hub API OCI service and stored verbatim; API Evangelist added only this provenance block.
  x-evidence:
  - url: https://docs.oracle.com/en-us/iaas/api/specs/index.json
    what: Oracle's own index of every OCI service specification
  - url: https://docs.oracle.com/en-us/iaas/api/specs/53a02334fff4534e79601c527b7a16800905500d2c670af774e682c05d12a1e6.yaml
    what: the harvested document for OS Management Hub API
servers:
- url: http://127.0.0.1/20220901
- url: https://127.0.0.1/20220901
tags:
- name: softwareSource
paths:
  /entitlements:
    get:
      description: "Lists entitlements in the specified tenancy [OCID](/iaas/Content/General/Concepts/identifiers.htm). Filter the list against a variety of criteria including but \nnot limited to its Customer Support Identifier (CSI), and vendor name.\n"
      operationId: ListEntitlements
      parameters:
      - $ref: '#/components/parameters/RequiredCompartmentIdQueryParam'
      - $ref: '#/components/parameters/CsiQueryParam'
      - $ref: '#/components/parameters/VendorNameQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/SoftwareSourceSortByQueryParamEntitlements'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: The list of entitlements was retrieved.
          headers:
            opc-next-page:
              description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntitlementCollection'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Gets a list of Entitlements
      tags:
      - softwareSource
      x-example: 'GET /20220901/entitlements?compartmentId=<var>&lt;compartment_OCID&gt;</var>&sortOrder=ASC&sortBy=csi

        Host: osmh.us-ashburn-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/SoftwareSource'
    post:
      description: 'Registers the necessary entitlement credentials for OS vendor software sources for a tenancy.

        '
      operationId: CreateEntitlement
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        200:
          description: The entitlement was created.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Creates an entitlement with OS Management Hub.
      tags:
      - softwareSource
      x-example: "GET /20220901/entitlements\nHost: osmh.us-ashburn-1.oci.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\n{\n  \"compartmentId\": \"ocid1.compartment.oc1..&lt;unique_id&gt;\",\n  \"csi\": \"&lt;unique_csi&gt;\",\n}\n"
      x-related-resource: '#/definitions/SoftwareSource'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateEntitlementDetails'
        description: Details for creating entitlements.
        required: true
  /errata:
    get:
      description: "Lists all of the currently available errata. Filter the list against a variety of criteria including but not \nlimited to its name, classification type, advisory severity, and OS family.\n"
      operationId: ListErrata
      parameters:
      - $ref: '#/components/parameters/RequiredCompartmentIdQueryParam'
      - $ref: '#/components/parameters/ErratumNameQueryParam'
      - $ref: '#/components/parameters/ErratumNameContainsQueryParam'
      - $ref: '#/components/parameters/MultiClassificationTypeQueryParam'
      - $ref: '#/components/parameters/MultiAdvisoryTypeQueryParam'
      - $ref: '#/components/parameters/OsFamilyQueryParam'
      - $ref: '#/components/parameters/AdvisorySeverityQueryParam'
      - $ref: '#/components/parameters/StartIssueDateQueryParam'
      - $ref: '#/components/parameters/EndIssueDateQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/SoftwareSourceSortByQueryParamErrata'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: The list of erratum summary objects was retrieved.
          headers:
            opc-next-page:
              description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErratumCollection'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Gets a list of the current errata
      tags:
      - softwareSource
      x-example: 'GET 20220901/errata?compartmentId=compartmentId=<var>&lt;compartment_OCID&gt;</var>&timeIssueDateStart=2025-01-14T07:11:53.667000Z&timeIssueDateEnd=2025-02-13T07:14:41.240000Z&limit=100&sortOrder=DESC&sortBy=timeIssued

        Host: osmh.us-ashburn-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/Erratum'
  /errata/{name}:
    get:
      description: 'Returns information about the specified erratum based on its advisory name.

        '
      operationId: GetErratum
      parameters:
      - $ref: '#/components/parameters/RequiredCompartmentIdQueryParam'
      - $ref: '#/components/parameters/ErratumNamePathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: The erratum was retrieved.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Erratum'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Gets an erratum by its advisory name.
      tags:
      - softwareSource
      x-example: 'GET 20220901/errata/<var>&lt;resource_Name&gt;</var>?compartmentId=compartmentId=<var>&lt;compartment_OCID&gt;</var>

        Host: osmh.us-ashburn-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
  /softwarePackages:
    get:
      description: "Lists software packages available through the OS Management Hub service.  Filter the list against a variety of criteria \nincluding but not limited to its name.\n"
      operationId: ListAllSoftwarePackages
      parameters:
      - $ref: '#/components/parameters/DisplayNameQueryParam'
      - $ref: '#/components/parameters/DisplayNameContainsQueryParam'
      - $ref: '#/components/parameters/SoftwarePackageVersionQueryParam'
      - $ref: '#/components/parameters/SoftwarePackageArchitectureQueryParam'
      - $ref: '#/components/parameters/isLatestQueryParam'
      - $ref: '#/components/parameters/OsFamilyQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/SoftwareSourceSortByQueryParamPackage'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: The list of software package summary objects was retrieved.
          headers:
            opc-next-page:
              description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SoftwarePackageCollection'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Lists Software Packages
      tags:
      - softwareSource
      x-example: 'GET /20220901/softwarePackages?displayNameContains=<var>&lt;package_name&gt;</var>&isLatest=true&limit=100&sortBy=displayName

        Host: osmh.us-ashburn-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/SoftwareSource'
  /softwarePackages/{softwarePackageName}:
    get:
      description: Returns information about the specified software package based on its fully qualified name (NVRA or NEVRA).
      operationId: GetSoftwarePackageByName
      parameters:
      - $ref: '#/components/parameters/SoftwarePackageNamePathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: The software package was retrieved.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SoftwarePackage'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Gets a software package by its fully qualified name
      tags:
      - softwareSource
      x-example: 'GET /20220901/softwarePackages/<var>&lt;package_name&gt;</var>

        Host: osmh.us-ashburn-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/SoftwareSource'
  /softwarePackages/{softwarePackageName}/softwareSources:
    get:
      description: 'Lists the software sources in the tenancy that contain the software package. Filter the list against a

        variety of criteria including but not limited to its name, type, architecture, and OS family.

        '
      operationId: ListSoftwarePackageSoftwareSources
      parameters:
      - $ref: '#/components/parameters/SoftwarePackageNamePathParam'
      - $ref: '#/components/parameters/RequiredCompartmentIdQueryParam'
      - $ref: '#/components/parameters/SoftwareSourceTypeQueryParam'
      - $ref: '#/components/parameters/MultiOsFamilyQueryParam'
      - $ref: '#/components/parameters/MultiArchTypeQueryParam'
      - $ref: '#/components/parameters/AvailabilityQueryParam'
      - $ref: '#/components/parameters/AvailabilityAtOciQueryParam'
      - $ref: '#/components/parameters/AvailabilityAnywhereQueryParam'
      - $ref: '#/components/parameters/DisplayNameQueryParam'
      - $ref: '#/components/parameters/DisplayNameContainsQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/SoftwareSourceSortByQueryParam'
      - $ref: '#/components/parameters/MultiSoftwareSourceLifecycleStateQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: The list of software source summary objects was retrieved.
          headers:
            opc-next-page:
              description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SoftwareSourceCollection'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Gets a list of all software sources for a given software package
      tags:
      - softwareSource
      x-example: 'GET /20220901/softwarePackages/<var>&lt;package_name&gt;</var>/softwareSources?compartmentId=<var>&lt;compartment_OCID&gt;</var>&archType=X86_64&archType=AARCH64

        Host: osmh.us-ashburn-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/SoftwareSource'
  /softwareSourceModuleStreams/actions/search:
    post:
      description: "Returns a list of module streams from the specified software sources. Filter the list against a variety of \ncriteria including the module name.\n"
      operationId: SearchSoftwareSourceModuleStreams
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenDefaultQueryParam'
      responses:
        200:
          description: The list of module stream summary objects was retrieved.
          headers:
            opc-next-page:
              description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModuleStreamCollection'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Retrieve a list of module streams from a list of software sources.
      tags:
      - softwareSource
      x-example: "POST 20220901/softwareSourceModuleStreams/actions/search\nHost: osmh.us-ashburn-1.oci.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\n{\n  \"softwareSourceIds\": [\n    \"ocid1.osmhsoftwaresource.oc1..&lt;unique_id&gt;\"\n  ],\n  \"sortOrder\": \"ASC\",\n  \"moduleName\": \"container-tools\",\n  \"sortBy\": \"MODULENAME\"\n}\n"
      x-related-resource: '#/definitions/SoftwareSource'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SearchSoftwareSourceModuleStreamsDetails'
        description: Request body that takes a list of software sources and any search filters.
        required: true
  /softwareSourceModules/actions/search:
    post:
      description: "Lists modules from a list of software sources. Filter the list against a variety of \ncriteria including the module name.\n"
      operationId: SearchSoftwareSourceModules
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenDefaultQueryParam'
      responses:
        200:
          description: The list of module summary objects was retrieved.
          headers:
            opc-next-page:
              description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModuleCollection'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Retrieve a list of modules from a list of software sources.
      tags:
      - softwareSource
      x-example: "POST 20220901/softwareSourceModules/actions/search\nHost: osmh.us-ashburn-1.oci.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\n{\n  \"softwareSourceIds\": [\n    \"ocid1.osmhsoftwaresource.oc1..&lt;unique_id&gt;\"\n  ],\n  \"sortOrder\": \"ASC\",\n  \"nameContains\": \"container\",\n  \"sortBy\": \"NAME\"\n}\n"
      x-related-resource: '#/definitions/SoftwareSource'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SearchSoftwareSourceModulesDetails'
        description: Request body that takes a list of software sources and any search filters.
        required: true
  /softwareSourcePackageGroups/actions/search:
    post:
      description: "Searches the package groups from the specified list of software sources. Filter the list against a variety of criteria \nincluding but not limited to its name, and group type.\n"
      operationId: SearchSoftwareSourcePackageGroups
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenDefaultQueryParam'
      responses:
        200:
          description: The list of package group summary objects was retrieved.
          headers:
            opc-next-page:
              description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PackageGroupCollection'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Retrieve a list of package groups from a list of software sources.
      tags:
      - softwareSource
      x-example: "POST 20220901/softwareSourcePackageGroups/actions/search\nHost: osmh.us-ashburn-1.oci.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\n{\n  \"softwareSourceIds\": [\n    \"ocid1.osmhsoftwaresource.oc1..&lt;unique_id&gt;\"\n  ],\n  \"sortOrder\": \"ASC\" ,\n  \"nameContains\": \"core\",\n  \"sortBy\": \"NAME\"\n}\n"
      x-related-resource: '#/definitions/SoftwareSource'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SearchSoftwareSourcePackageGroupsDetails'
        description: Request body that takes in a list of software sources and other search parameters.
        required: true
  /softwareSourceVendors:
    get:
      description: 'Lists available software source vendors. Filter the list against a variety of criteria including but not limited

        to its name.

        '
      operationId: ListSoftwareSourceVendors
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RequiredCompartmentIdQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/SoftwareSourceSortByQueryParamVendor'
      - $ref: '#/components/parameters/NameQueryParam'
      responses:
        200:
          description: The list of software source vendor summaries was retrieved.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SoftwareSourceVendorCollection'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Gets a list of the available SoftwareSourceVendors
      tags:
      - softwareSource
      x-example: 'GET /20220901/softwareSourceVendors?compartmentId=<var>&lt;compartment_OCID&gt;</var>

        Host: osmh.us-ashburn-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/SoftwareSource'
  /softwareSources:
    get:
      description: 'Lists software sources that match the specified tenancy or software source [OCID](/iaas/Content/General/Concepts/identifiers.htm). Filter the list against a

        variety of criteria including but not limited to its name, status, architecture, and OS family.

        '
      operationId: ListSoftwareSources
      parameters:
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/OptionalSoftwareSourceIdQueryParam'
      - $ref: '#/components/parameters/SoftwareSourceTypeQueryParam'
      - $ref: '#/components/parameters/VendorNameQueryParam'
      - $ref: '#/components/parameters/MultiOsFamilyQueryParam'
      - $ref: '#/components/parameters/MultiArchTypeQueryParam'
      - $ref: '#/components/parameters/AvailabilityQueryParam'
      - $ref: '#/components/parameters/AvailabilityAtOciQueryParam'
      - $ref: '#/components/parameters/AvailabilityAnywhereQueryParam'
      - $ref: '#/components/parameters/IsMandatoryForAutonomousLinuxQueryParam'
      - $ref: '#/components/parameters/IsMirrorSyncAllowedQueryParam'
      - $ref: '#/components/parameters/DisplayNameQueryParam'
      - $ref: '#/components/parameters/DisplayNameContainsQueryParam'
      - $ref: '#/components/parameters/MultiDisplayNameNotEqualToQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/SoftwareSourceSortByQueryParam'
      - $ref: '#/components/parameters/MultiSoftwareSourceLifecycleStateQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: The list of software source summary objects was retrieved.
          headers:
            opc-next-page:
              description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SoftwareSourceCollection'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Gets a list of all software sources
      tags:
      - softwareSource
      x-example: 'GET /20220901/softwareSources?compartmentId=<var>&lt;compartment_OCID&gt;</var>&availabilityAnywhere=SELECTED&limit=15&sortOrder=ASC&sortBy=displayName

        Host: osmh.us-ashburn-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/SoftwareSource'
    post:
      description: 'Creates a new software source.

        '
      operationId: CreateSoftwareSource
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        201:
          description: Accepted the request. The software source will be created.
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
            location:
              description: URL for the created software source, the software source OCID will be generated after this request is sent.
              schema:
                type: string
                format: uri-reference
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SoftwareSource'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Creates a new software source.
      tags:
      - softwareSource
      x-example: "POST /20220901/softwareSources\nHost: osmh.us-ashburn-1.oci.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\n{\n    \"compartmentId\": \"ocid1.compartment.oc1..&lt;unique_id&gt;\",\n    \"softwareSourceVersion\": \"\",\n    \"description\": \"Creating a new software source for testing OSMH SS.\",\n    \"displayName\": \"TestSoftwareSource\",\n    \"isAutomaticallyUpdated\": false,\n    \"isAutoResolveDependencies\": false,\n    \"softwareSourceSubType\": \"MANIFEST\",\n    \"softwareSourceType\": \"CUSTOM\",\n    \"vendorSoftwareSources\": [\n        {\n            \"id\": \"ocid1.osmhsoftwaresource.oc1..&lt;unique_id&gt;\",\n            \"displayName\": \"ol8_appstream-x86_64\"\n        },\n        {\n            \"id\": \"ocid1.osmhsoftwaresource.oc1..&lt;unique_id&gt;\",\n            \"displayName\": \"ol8_baseos_latest-x86_64\"\n        }\n    ],\n    \"definedTags\": {},\n    \"freeformTags\": {},\n    \"isLatestContentOnly\": true,\n    \"isCreatedFromPackageList\": true\n}\n"
      x-related-resource: '#/definitions/SoftwareSource'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateSoftwareSourceDetails'
        description: Details for the new software source.
        required: true
  /softwareSources/actions/availableSoftwareSources:
    post:
      description: 'Retrieves a list of software source repos that are available to add to a specified compartment. This API returns repos that are not already selected in the specified compartment.

        '
      operationId: ListAvailableSoftwareSourcesToAdd
      parameters:
      - $ref: '#/components/parameters/RequiredCompartmentIdQueryParam'
      - $ref: '#/components/parameters/MultiOsFamilyQueryParam'
      - $ref: '#/components/parameters/MultiArchTypeQueryParam'
      - $ref: '#/components/parameters/DisplayNameQueryParam'
      - $ref: '#/components/parameters/DisplayNameContainsQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/SoftwareSourceSortByQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      responses:
        200:
          description: The list of available software sources for the specified compartment summary objects was retrieved.
          headers:
            opc-next-page:
              description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
            opc-total-items:
              description: 'The total number of items in the result. Used for pagination of a list of items.

                '
              schema:
                type: integer
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SoftwareSourceRepoCollection'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Retrieves a list of available vendor software source repos to add to a specified compartment
      tags:
      - softwareSource
      x-example: 'POST /20220901/softwareSources/actions/availableSoftwareSources?compartmentId=<var>&lt;compartment_OCID&gt;</var>&limit=15&sortOrder=ASC&sortBy=displayName

        Host: osmh.us-ashburn-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/SoftwareSource'
  /softwareSources/actions/changeAvailability:
    post:
      description: 'Updates the availability for a list of specified software sources.

        '
      operationId: ChangeAvailabilityOfSoftwareSources
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        200:
          description: The availability for the list of software sources was updated.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Updates the availability of a list of software sources
      tags:
      - softwareSource
      x-example: "POST 20220901/softwareSources/actions/changeAvailability\nHost: osmh.us-ashburn-1.oci.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\n{\n  \"softwareSourceAvailabilities\": [\n    {\n      \"softwareSourceId\": \"ocid1.osmhsoftwaresource.oc1..&lt;unique_id&gt;\",\n      \"availability\": \"AVAILABLE\",\n      \"availabilityAtOci\":\"SELECTED\"\n    }\n  ]\n}\n"
      x-related-resource: '#/definitions/SoftwareSource'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChangeAvailabilityOfSoftwareSourcesDetails'
        description: Request body that contains a list of software sources whose availability needs to be updated.
        required: true
  /softwareSources/{softwareSourceId}:
    delete:
      description: Deletes the specified software source.
      operationId: DeleteSoftwareSource
      parameters:
      - $ref: '#/components/parameters/SoftwareSourceIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      responses:
        204:
          description: The software source was deleted.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Delete a provisioned SoftwareSource
      tags:
      - softwareSource
      x-example: 'DELETE 20220901/softwareSources/<var>&lt;resource_OCID&gt;</var>

        Host: osmh.us-ashburn-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/SoftwareSource'
    get:
      description: Returns information about the specified software source.
      operationId: GetSoftwareSource
      parameters:
      - $ref: '#/components/parameters/SoftwareSourceIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: The software source was retrieved.
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
            retry-after:
              description: A decimal number representing the number of seconds the client should wait before polling this endpoint again.
              schema:
                type: integer
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SoftwareSource'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Gets a software source by identifier
      tags:
      - softwareSource
      x-example: 'GET 20220901/softwareSources/<var>&lt;resource_OCID&gt;</var>

        Host: osmh.us-ashburn-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
    put:
      description: 'Updates the specified software source''s details, including but not limited to name, description, and tags.

        '
      operationId: UpdateSoftwareSource
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/SoftwareSourceIdPathParam'
      responses:
        202:
          description: Accepted the request. The software source will be updated.
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SoftwareSource'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Update the custom software source identified by the id
      tags:
      - softwareSource
      x-example: "PUT 20220901/softwareSources/<var>&lt;resource_OCID&gt;</var>\nHost: osmh.us-ashburn-1.oci.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\n{\n    \"compartmentId\": \"ocid1.compartment.oc1..&lt;unique_id&gt;\",\n    \"softwareSourceType\": \"CUSTOM\",\n    \"displayName\": \"CustomSS-Test-02\",\n    \"description\": \"Custom software source for OSMH SS.\"\n}\n"
      x-related-resource: '#/definitions/SoftwareSource'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateSoftwareSourceDetails'
        description: The information to be updated.
        required: true
  /softwareSources/{softwareSourceId}/actions/addPackages:
    post:
      description: "Adds packages to a software source. This operation can only be done for custom and versioned custom software sources that are not created using filters. \nFor a versioned custom software source, you can only add packages when the source is created. Once content is added to a versioned custom software source, it is immutable.\nPackages can be of the format:\n  * name (for example: git). If isLatestContentOnly is true, only the latest version of the package will be added, otherwise all versions of the package will be added.\n  * name-version-release.architecture (for example: git-2.43.5-1.el8_10.x86_64)\n  * name-epoch:version-release.architecture (for example: git-0:2.43.5-1.el8_10.x86_64)\n"
      operationId: AddPackagesToSoftwareSource
      parameters:
      - $ref: '#/components/parameters/SoftwareSourceIdPathParam'
      - $ref: '#/components/parameters/AddPackagesToSoftwareSourceDetailsParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        202:
          description: Accepted the request. The packages will be added to the software source.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Adds packages to a software source.
      tags:
      - softwareSource
      x-example: "POST /20220901/softwareSources/<var>&lt;resource_OCID&gt;</var>/actions/addPackages\nHost: osmh.us-ashburn-1.oci.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\n{\n  \"packages\": [\n    \"libselinux-2.8-6.el8.x86_64\",\n    \"libselinux-ruby-2.8-6.el8.x86_64\",\n    \"libselinux-devel-2.8-6.el8.x86_64\",\n    \"NetworkManager-cloud-setup-1:1.30.0-13.0.1.el8_4.x86_64\",\n    \"NetworkManager-adsl-1:1.30.0-13.0.1.el8_4x86_64\",\n    \"NetworkManager-initscripts-updown-1:1.30.0-13.0.1.el8_4.noarch\",\n    \"lm_sensors\",\n    \"libreoffice-langpack-mai\",\n    \"libcap-ng-python3\",\n    \"gutenprint\",\n    \"jakarta-annotations\"\n  ]\n}\n"
      x-related-resource: '#/definitions/SoftwareSource'
  /softwareSources/{softwareSourceId}/actions/changeCompartment:
    post:
      description: 'Moves the specified software sources to a different compartment within the same tenancy.

        For information about moving resources between compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).

        '
      operationId: ChangeSoftwareSourceCompartment
      parameters:
      - $ref: '#/components/parameters/SoftwareSourceIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/ChangeSoftwareSourceCompartmentDetailsParam'
      responses:
        204:
          description: 'The software source was successfully moved to the specified compartment.

            '
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Moves a Software Source into a different compartment
      tags:
      - softwareSource
      x-example: "POST 20220901/softwareSources/<var>&lt;resource_OCID&gt;</var>/changeCompartment\nHost: osmh.us-ashburn-1.oci.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\n{\n    \"compartmentId\": \"ocid1.compartment.oc1..&lt;unique_id&gt;\"\n}\n"
      x-obmcs-terraform:
        actionType: UPDATE_FIELD
      x-related-resource: '#/definitions/SoftwareSource'
  /softwareSources/{softwareSourceId}/actions/generateMetadata:
    post:
      description: Regenerates metadata for the specified custom software source.
      operationId: SoftwareSourceGenerateMetadata
      parameters:
      - $ref: '#/components/parameters/SoftwareSourceIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        202:
          description: Accepted the request. The metadata for the software source will be regenerated.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Regenerates metadata for the specified custom software source.
      tags:
      - softwareSource
      x-example: 'POST /20220901/softwareSources/<var>&lt;resource_OCID&gt;</var>/actions/generateMetadata

        Host: osmh.us-ashburn-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/SoftwareSource'
  /softwareSources/{softwareSourceId}/actions/removePackages:
    post:
      description: "Removes packages from a software source. This operation can only be done for custom software sources that are not created using filters.\nPackages can be of the format:\n  * name (for example: git). This removes all versions of the package.\n  * name-version-release.architecture (for example: git-2.43.5-1.el8_10.x86_64)\n  * name-epoch:version-release.architecture (for example: git-0:2.43.5-1.el8_10.x86_64)\n"
      operationId: RemovePackagesFromSoftwareSource
      parameters:
      - $ref: '#/components/parameters/SoftwareSourceIdPathParam'
      - $ref: '#/components/parameters/RemovePackagesFromSoftwareSourceDetailsParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        202:
          description: Accepted the request. The packages will be removed from the software source.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Removes packages from a software source.
      tags:
      - softwareSource
      x-example: "POST /20220901/softwareSources/<var>&lt;resource_OCID&gt;</var>/actions/removePackages\nHost: osmh.us-ashburn-1.oci.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\n{\n  \"packages\": [\n    \"libselinux-2.8-6.el8.x86_64\",\n    \"libselinux-ruby-2.8-6.el8.x86_64\",\n    \"libselinux-devel-2.8-6.el8.x86_64\",\n    \"NetworkManager-cloud-setup-1:1.30.0-13.0.1.el8_4.x86_64\",\n    \"NetworkManager-adsl-1:1.30.0-13.0.1.el8_4x86_64\",\n    \"NetworkManager-initscripts-updown-1:1.30.0-13.0.1.el8_4.noarch\",\n    \"lm_sensors\",\n    \"libreoffice-langpack-mai\",\n    \"libcap-ng-python3\",\n    \"gutenprint\",\n    \"jakarta-annotations\"\n  ]\n}\n"
      x-related-resource: '#/definitions/SoftwareSource'
  /softwareSources/{softwareSourceId}/actions/replacePackages:
    post:
      description: "Replaces packages in a software source with the provided list of packages. This operation can only be done for custom software sources that are not created using filters.\nPackages can be of the format:\n * name (for example: git). If isLatestContentOnly is true, only the latest version of the package will be added, otherwise all versions of the package will be added.\n * name-version-release.architecture (for example: git-2.43.5-1.el8_10.x86_64)\n * name-epoch:version-release.architecture (for example: git-0:2.43.5-1.el8_10.x86_64)\n"
      operationId: ReplacePackagesInSoftwareSource
      parameters:
      - $ref: '#/components/parameters/SoftwareSourceIdPathParam'
      - $ref: '#/components/parameters/ReplacePackagesInSoftwareSourceDetailsParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        202:
          description: Accepted the request. The packages in the software source will be replaced with the provided packages.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Replaces packages in a software source with the provided list of packages.
      tags:
      - softwareSource
      x-example: "POST /20220901/softwareSources/<var>&lt;resource_OCID&gt;</var>/actions/replacePackages\nHost: osmh.us-ashburn-1.oci.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\n{\n  \"packages\": [\n    \"libselinux-2.8-6.el8.x86_64\",\n    \"libselinux-ruby-2.8-6.el8.x86_64\",\n    \"libselinux-devel-2.8-6.el8.x86_64\",\n    \"NetworkManager-cloud-setup-1:1.30.0-13.0.1.el8_4.x86_64\",\n    \"NetworkManager-adsl-1:1.30.0-13.0.1.el8_4x86_64\",\n    \"NetworkManager-initscripts-updown-1:1.30.0-13.0.1.el8_4.noarch\",\n    \"lm_sensors\",\n    \"libreoffice-langpack-mai\",\n    \"libcap-ng-python3\",\n    \"gutenprint\",\n    \"jakarta-annotations\"\n  ]\n}\n"
      x-related-resource: '#/definitions/SoftwareSource'
  /softwareSources/{softwareSourceId}/availableSoftwarePackages:
    get:
      description: "Lists software packages that are available to be added to a custom software source of type MANIFEST.  Filter the list against a variety of criteria \nincluding but not limited to its name.\n"
      operationId: ListAvailableSoftwarePackages
      parameters:
      - $ref: '#/components/parameters/SoftwareSourceIdPathParam'
      - $ref: '#/components/parameters/DisplayNameQueryParam'
      - $ref: '#/components/parameters/DisplayNameContainsQueryParam'
      - $ref: '#/components/parameters/isLatestQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/SoftwareSourceSortByQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: The list of software package summary objects was retrieved.
          headers:
            opc-next-page:
              description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SoftwarePackageCollection'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Lists software packages that are available to be added to a custom software source of type MANIFEST.
      tags:
      - softwareSource
      x-example: 'GET 20220901/softwareSources/<var>&lt;resource_OCID&gt;</var>/availableSoftwarePackages?isLatest=false&limit=15&sortOrder=ASC&sortBy=displayName

        Host: osmh.us-ashburn-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/SoftwareSource'
  /softwareSources/{softwareSourceId}/manifest:
    get:
      description: 'Returns an archive containing the list of packages in the software source.

        '
      operationId: GetSoftwareSourceManifest
      parameters:
      - $ref: '#/components/parameters/SoftwareSourceIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: Package manifest document was retrieved.
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/octet-stream:
              schema:
                format: binary
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Returns an archive containing the list of packages in the software source.
      tags:
      - softwareSource
      x-example: 'GET 20220901/softwareSources/<var>&lt;resource_OCID&gt;</var>/manifest

        Host: osmh.us-ashburn-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/SoftwareSource'
    put:
      description: 'Updates the package list document for the software source.

        '
      operationId: UpdateSoftwareSourceManifest
      parameters:
      - $ref: '#/components/parameters/SoftwareSourceIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        202:
          description: OK
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SoftwareSource'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Updates the package manifest file for the software source.
      tags:
      - softwareSource
      x-example: "PUT /20220901/softwareSources/<var>&lt;resource_OCID&gt;</var>/actions/manifest\nHost: osmh.us-ashburn-1.oci.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\nFile content (The file contains plain text with each package listed on a new line.):\n  libselinux-2.8-6.el8.x86_64\n  libselinux-ruby-2.8-6.el8.x86_64\n  libselinux-devel-2.8-6.el8.x86_64\n"
      x-obmcs-terraform:
        actionType: SPECIAL_UPDATE
      x-related-resource: '#/definitions/SoftwareSource'
      requestBody:
        content:
          application/json:
            schema:
              format: binary
              type: string
        description: Provides the document used to update the package list of the software source.
        required: true
  /softwareSources/{softwareSourceId}/moduleStreamProfiles:
    get:
      description: "Lists module stream profiles from the specified software source [OCID](/iaas/Content/General/Concepts/identifiers.htm). Filter the list against a variety of \ncriteria including but not limited to its module name, stream name, and profile name.\n"
      operationId: ListModuleStreamProfiles
      parameters:
      - $ref: '#/components/parameters/SoftwareSourceIdPathParam'
      - $ref: '#/components/parameters/ModuleNameParam'
      - $ref: '#/components/parameters/ModuleStreamNameParam'
      - $ref: '#/components/parameters/NameQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/ModuleNameSortByQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: The list of module stream profile summary objects was retrieved.
          headers:
            opc-next-page:
              description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModuleStreamProfileCollection'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Retrieve a list of module stream profiles from a software source.
      tags:
      - softwareSource
      x-example: 'GET 20220901/softwareSources/<var>&lt;resource_OCID&gt;</var>/moduleStreamProfiles?moduleName=container-tools&name=minimal&isLatest=true&limit=100

        Host: osmh.us-ashburn-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/SoftwareSource'
  /softwareSources/{softwareSourceId}/moduleStreamProfiles/{profileName}:
    get:
      description: 'Returns information about the specified module stream profile in a software source.

        '
      operationId: GetModuleStreamProfile
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/SoftwareSourceIdPathParam'
      - $ref: '#/components/parameters/ModuleStreamProfileNamePathParam'
      - $ref: '#/components/parameters/RequiredModuleNameQueryParam'
      - $ref: '#/components/parameters/RequiredModuleStreamNameQueryParam'
      responses:
        200:
          description: The module stream profile was retrieved.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModuleStreamProfile'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Retrieve a detailed description of a module stream profile from a software source.
      tags:
      - softwareSource
      x-example: 'GET 20220901/softwareSources/<var>&lt;resource_OCID&gt;</var>/moduleStreamProfiles/<var>&lt;resource_Name&gt;</var>?moduleName=<var>&lt;module_name&gt;</var>&streamName=<var>&lt;stream_name&gt;</var>

        Host: osmh.us-ashburn-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
  /softwareSources/{softwareSourceId}/moduleStreams:
    get:
      description: "Lists module streams from the specified software source [OCID](/iaas/Content/General/Concepts/identifiers.htm). \nFilter the list against a variety of criteria including but not limited to its module name and (stream) name.\n"
      operationId: ListModuleStreams
      parameters:
      - $ref: '#/components/parameters/SoftwareSourceIdPathParam'
      - $ref: '#/components/parameters/ModuleNameParam'
      - $ref: '#/components/parameters/NameQueryParam'
      - $ref: '#/components/parameters/isLatestQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/ModuleNameSortByQueryParam'
      - $ref: '#/components/parameters/ModuleNameContainsQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: The list of module stream summary objects was retrieved.
          headers:
            opc-next-page:
              description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModuleStreamCollection'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Retrieve a list of module streams from a software source.
      tags:
      - softwareSource
      x-example: 'GET 20220901/softwareSources/<var>&lt;resource_OCID&gt;</var>/moduleStreams?moduleName=container-tools&limit=100

        Host: osmh.us-ashburn-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/SoftwareSource'
  /softwareSources/{softwareSourceId}/moduleStreams/{moduleName}:
    get:
      description: 'Returns information about the specified module stream in a software source.

        '
      operationId: GetModuleStream
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/SoftwareSourceIdPathParam'
      - $ref: '#/components/parameters/ModuleNamePathParam'
      - $ref: '#/components/parameters/RequiredModuleStreamNameQueryParam'
      responses:
        200:
          description: The module stream was retrieved.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModuleStream'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Retrieve a detailed description of a module streams from a software source.
      tags:
      - softwareSource
      x-example: 'GET 20220901/softwareSources/<var>&lt;resource_OCID&gt;</var>/moduleStreams/<var>&lt;resource_Name&gt;</var>?streamName=1.0

        Host: osmh.us-ashburn-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
  /softwareSources/{softwareSourceId}/packageGroups:
    get:
      description: 'Lists package groups that are associated with the specified software source [OCID](/iaas/Content/General/Concepts/identifiers.htm). Filter the list against a

        variety of criteria including but not limited to its name, and package group type.

        '
      operationId: ListPackageGroups
      parameters:
      - $ref: '#/components/parameters/SoftwareSourceIdPathParam'
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/NameQueryParam'
      - $ref: '#/components/parameters/NameContainsQueryParam'
      - $ref: '#/components/parameters/MultiPackageGroupTypeQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/SoftwareSourceSortByQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: The list of package group summary objects was retrieved.
          headers:
            opc-next-page:
              description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PackageGroupCollection'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Gets a list of all Package Groups associated with this vendor software source
      tags:
      - softwareSource
      x-example: 'GET 20220901/softwareSources/<var>&lt;resource_OCID&gt;</var>/packageGroups?limit=100&compartmentId=<var>&lt;compartment_OCID&gt;</var>&nameContains=core&groupType=GROUP

        Host: osmh.us-ashburn-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/SoftwareSource'
  /softwareSources/{softwareSourceId}/packageGroups/{packageGroupId}:
    get:
      description: 'Returns information about the specified package group from a software source.

        '
      operationId: GetPackageGroup
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/SoftwareSourceIdPathParam'
      - $ref: '#/components/parameters/PackageGroupIdPathParam'
      responses:
        200:
          description: The yum or DNF package group associated with a software source was retrieved.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PackageGroup'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Retrieve a Package Group from a software source.
      tags:
      - softwareSource
      x-example: 'GET 20220901/softwareSources/<var>&lt;resource_OCID&gt;</var>/packageGroups/<var>&lt;package_Group_Id&gt;</var>

        Host: osmh.us-ashburn-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
  /softwareSources/{softwareSourceId}/softwarePackages:
    get:
      description: "Lists software packages in the specified software source.  Filter the list against a variety of criteria \nincluding but not limited to its name.\n"
      operationId: ListSoftwarePackages
      parameters:
      - $ref: '#/components/parameters/SoftwareSourceIdPathParam'
      - $ref: '#/components/parameters/DisplayNameQueryParam'
      - $ref: '#/components/parameters/DisplayNameContainsQueryParam'
      - $ref: '#/components/parameters/isLatestQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/SoftwareSourceSortByQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: The list of software package summary objects was retrieved.
          headers:
            opc-next-page:
              description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SoftwarePackageCollection'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Lists Software Packages
      tags:
      - softwareSource
      x-example: 'GET 20220901/softwareSources/<var>&lt;resource_OCID&gt;</var>/softwarePackages?limit=100&sortOrder=ASC&sortBy=displayName

        Host: osmh.us-ashburn-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/SoftwareSource'
  /softwareSources/{softwareSourceId}/softwarePackages/{softwarePackageName}:
    get:
      description: 'Returns information about the specified software package.

        '
      operationId: GetSoftwarePackage
      parameters:
      - $ref: '#/components/parameters/SoftwareSourceIdPathParam'
      - $ref: '#/components/parameters/SoftwarePackageNamePathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: The software package was retrieved.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SoftwarePackage'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Gets a Software Package by identifier
      tags:
      - softwareSource
      x-example: 'GET 20220901/softwareSources/<var>&lt;resource_OCID&gt;</var>/softwarePackages/<var>&lt;package_name&gt;</var>

        Host: osmh.us-ashburn-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/SoftwareSource'
components:
  schemas:
    ModuleSummary:
      description: Provides summary information about a module which is provided by a software source.
      properties:
        name:
          description: 'The name of the module.

            '
          type: string
        softwareSourceId:
          description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the software source.

            '
          type: string
        streams:
          description: List of stream names.
          items:
            type: string
          type: array
      required:
      - name
      - softwareSourceId
      type: object
    SoftwarePackageCollection:
      description: A set of software packages returned for the [ListSoftwarePackages](#/en/osmh/latest/SoftwareSource/ListSoftwarePackages) operation or [ListAllSoftwarePackages](#/en/osmh/latest/SoftwareSource/ListAllSoftwarePackages) operation.
      properties:
        items:
          description: List of software packages.
          items:
            $ref: '#/components/schemas/SoftwarePackageSummary'
          type: array
      required:
      - items
      type: object
      x-example: "{\n  \"items\": [\n    {\n      \"displayName\": \"acl\",\n      \"name\": \"acl-2.2.53-3.el8.x86_64.rpm\",\n      \"type\": \"RPM\",\n      \"version\": \"2.2.53-3.el8\",\n      \"architecture\": \"X86_64\",\n      \"checksum\": \"&lt;check_sum&gt\",\n      \"checksumType\": \"sha256\",\n      \"isLatest\": true,\n      \"softwareSources\": [\n        {\n          \"id\": \"ocid1.osmhsoftwaresource.oc1.iad..exampleuniqueID\",\n          \"displayName\": \"ol8_baseos_latest-x86_64\",\n          \"description\": \"Oracle Linux 8 BaseOS Latest  (x86_64)\",\n          \"softwareSourceType\": \"VENDOR\",\n          \"isMandatoryForAutonomousLinux\": true\n        },\n        {\n          \"id\": \"ocid1.osmhsoftwaresource.oc1.iad.exampleuniqueID2\",\n          \"displayName\": \"ol8_u10_baseos_base-x86_64\",\n          \"description\": \"Oracle Linux 8.10 BaseOS (x86_64)\",\n          \"softwareSourceType\": \"VENDOR\",\n          \"isMandatoryForAutonomousLinux\": false\n        }\n      ],\n      \"osFamilies\": [\n        \"ORACLE_LINUX_8\"\n      ]\n    }\n  ]\n}\n"
    Error:
      description: Provides the information for an error.
      properties:
        code:
          description: A short error code that defines the error, meant for programmatic parsing.
          type: string
        message:
          description: A human-readable error string.
          type: string
      required:
      - code
      - message
    SoftwareSourceAvailability:
      description: An object that defines the [OCID](/iaas/Content/General/Concepts/identifiers.htm) and the availability of a vendor software source.
      properties:
        availability:
          description: Availability of the software source to instances in private data centers or third-party clouds.
          enum:
          - AVAILABLE
          - SELECTED
          - RESTRICTED
          - UNAVAILABLE
          type: string
          x-obmcs-top-level-enum: '#/definitions/Availability'
        availabilityAtOci:
          description: Availability of the software source to OCI instances.
          enum:
          - AVAILABLE
          - SELECTED
          - RESTRICTED
          - UNAVAILABLE
          type: string
          x-obmcs-top-level-enum: '#/definitions/Availability'
        softwareSourceId:
          description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the vendor software source.
          type: string
      required:
      - softwareSourceId
      type: object
    SoftwareSourceRepoCollection:
      description: A set of software sources returned for the ListAvailableSoftwareSourcesToAddInCompartment operation.
      properties:
        items:
          description: List of software sources that are available for specified compartment
          items:
            $ref: '#/components/schemas/SoftwareSourceRepoSummary'
          type: array
      required:
      - items
      type: object
    SoftwareSourceSummary:
      description: Provides summary information for a software source. A software source contains a collection of packages. For more information, see [Managing Software Sources](/iaas/osmh/doc/software-sources.htm).
      discriminator:
        propertyName: softwareSourceType
      properties:
        archType:
          description: The architecture type supported by the software source.
          enum:
          - X86_64
          - AARCH64
          - I686
          - NOARCH
          - SRC
          - I386
          - AMD64
          - ARM64
          - ALL
          type: string
          x-obmcs-top-level-enum: '#/definitions/ArchType'
        availability:
          description: Availability of the software source (for non-OCI environments).
          enum:
          - AVAILABLE
          - SELECTED
          - RESTRICTED
          - UNAVAILABLE
          type: string
          x-obmcs-top-level-enum: '#/definitions/Availability'
        availabilityAtOci:
          description: Availability of the software source (for OCI environments).
          enum:
          - AVAILABLE
          - SELECTED
          - RESTRICTED
          - UNAVAILABLE
          type: string
          x-obmcs-top-level-enum: '#/definitions/Availability'
        compartmentId:
          description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the software source.
          maxLength: 255
          minLength: 1
          type: string
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only the String type is supported.

                '
              type: object
            description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.

              Example: `{"CostCenter": "42"}`

              '
            type: object
          description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.

            For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).

            Example: `{"Operations": {"CostCenter": "42"}}`

            '
          type: object
        description:
          description: Description of the software source. For custom software sources, this is user-specified.
          type: string
        displayName:
          description: User-friendly name for the software source.
          format: x-obmcs-ascii-identifier
          maxLength: 255
          minLength: 1
          type: string
        freeformTags:
          additionalProperties:
            type: string
          description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.

            For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).

            Example: `{"Department": "Finance"}`

            '
          type: object
        id:
          description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the software source.
          type: string
        lifecycleState:
          description: The current state of the software source.
          type: string
          x-obmcs-enumref: '#/definitions/SoftwareSource/lifecycleState'
        osFamily:
          description: The OS family of the software source.
          enum:
          - ORACLE_LINUX_10
          - ORACLE_LINUX_9
          - ORACLE_LINUX_8
          - ORACLE_LINUX_7
          - ORACLE_LINUX_6
          - WINDOWS_SERVER_2016
          - WINDOWS_SERVER_2019
          - WINDOWS_SERVER_2022
          - WINDOWS_SERVER_2025
          - WINDOWS_11
          - ALL
          - UBUNTU_20_04
          - UBUNTU_22_04
          - UBUNTU_24_04
          type: string
          x-obmcs-top-level-enum: '#/definitions/OsFamily'
        packageCount:
          description: Number of packages the software source contains.
          format: int64
          type: integer
        repoId:
          description: The repository ID for the software source.
          type: string
        size:
          description: The size of the software source in bytes (B).
          format: double
          type: number
        softwareSourceType:
          description: Type of software source.
          enum:
          - VENDOR
          - CUSTOM
          - VERSIONED
          - PRIVATE
          - THIRD_PARTY
          type: string
          x-obmcs-top-level-enum: '#/definitions/SoftwareSourceType'
        systemTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string type is supported.

                '
              type: object
            description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.

              Example: `{"bar-key": "value"}`

              '
            type: object
          description: 'System tags for this resource. Each key is predefined and scoped to a namespace.

            Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`

            '
          type: object
        timeCreated:
          description: 'The date and time the software source was created (in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format).

            '
          format: date-time
          type: string
        timeUpdated:
          description: 'The date and time the software source was updated (in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format).

            '
          format: date-time
          type: string
        url:
          description: URL for the repository. For vendor software sources, this is the URL to the regional yum server. For custom software sources, this is 'custom/<repoId>'.
          type: string
      required:
      - id
      - compartmentId
      - softwareSourceType
      - displayName
      - timeCreated
      - timeUpdated
      - osFamily
      - archType
      - availability
      - availabilityAtOci
      - repoId
      - url
    RemovePackagesFromSoftwareSourceDetails:
      description: Provides a list of packages to be removed from the software source.
      properties:
        packages:
          description: List of packages specified by the name of the package (N) or the full package name (NVRA or NEVRA).
          items:
            type: string
          maxItems: 524288
          type: array
      required:
      - packages
      type: object
    SoftwareSourceVendorCollection:
      description: Th set of software source vendors returned for the [ListSoftwareSourceVendors](#/en/osmh/latest/SoftwareSource/ListSoftwareSourceVendors) operation.
      properties:
        items:
          description: List of software source vendors.
          items:
            $ref: '#/components/schemas/SoftwareSourceVendorSummary'
          type: array
      required:
      - items
      type: object
      x-example: "{\n  \"items\": [\n    {\n      \"name\": \"ORACLE\",\n      \"osFamilies\": [\n        \"ORACLE_LINUX_9\",\n        \"ORACLE_LINUX_8\",\n        \"ORACLE_LINUX_7\",\n        \"ORACLE_LINUX_6\"\n      ],\n      \"archTypes\": [\n        \"X86_64\",\n        \"AARCH64\"\n      ]\n    }\n  ]\n}\n"
    SoftwareSourceDetails:
      description: Provides identifying information for the specified software source.
      properties:
        description:
          description: Software source description.
          type: string
        displayName:
          description: Software source name.
          type: string
        id:
          description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the software source.
          type: string
        isMandatoryForAutonomousLinux:
          description: Indicates whether this is a required software source for Autonomous Linux instances. If true, the user can't unselect it.
          type: boolean
        softwareSourceType:
          description: Type of the software source.
          enum:
          - VENDOR
          - CUSTOM
          - VERSIONED
          - PRIVATE
          - THIRD_PARTY
          type: string
          x-obmcs-top-level-enum: '#/definitions/SoftwareSourceType'
      required:
      - id
      type: object
    SoftwareSourceRepoSummary:
      description: Provides summary information for available repos to add directly to compartments. A software source contains a collection of packages. For more information, see [Managing Software Sources](/iaas/osmh/doc/software-sources.htm).
      properties:
        archType:
          description: The architecture type supported by the software source.
          enum:
          - X86_64
          - AARCH64
          - I686
          - NOARCH
          - SRC
          - I386
          - AMD64
          - ARM64
          - ALL
          type: string
          x-obmcs-top-level-enum: '#/definitions/ArchType'
        description:
          description: Description of the software source. For custom software sources, this is user-specified.
          type: string
        displayName:
          description: User-friendly name for the software source.
          format: x-obmcs-ascii-identifier
          maxLength: 255
          minLength: 1
          type: string
        osFamily:
          description: The OS family of the software source.
          enum:
          - ORACLE_LINUX_10
          - ORACLE_LINUX_9
          - ORACLE_LINUX_8
          - ORACLE_LINUX_7
          - ORACLE_LINUX_6
          - WINDOWS_SERVER_2016
          - WINDOWS_SERVER_2019
          - WINDOWS_SERVER_2022
          - WINDOWS_SERVER_2025
          - WINDOWS_11
          - ALL
          - UBUNTU_20_04
          - UBUNTU_22_04
          - UBUNTU_24_04
          type: string
          x-obmcs-top-level-enum: '#/definitions/OsFamily'
        repoId:
          description: The repository ID for the software source.
          type: string
        softwareSourceType:
          description: Type of software source.
          enum:
          - VENDOR
          - CUSTOM
          - VERSIONED
          - PRIVATE
          - THIRD_PARTY
          type: string
          x-obmcs-top-level-enum: '#/definitions/SoftwareSourceType'
      required:
      - softwareSourceType
      - displayName
      - osFamily
      - archType
      - repoId
    ChangeAvailabilityOfSoftwareSourcesDetails:
      description: Provides the information used to update the availability of a list of software sources.
      properties:
        softwareSourceAvailabilities:
          description: List of vendor software sources and their availability statuses.
          items:
            $ref: '#/components/schemas/SoftwareSourceAvailability'
          maxItems: 255
          type: array
      required:
      - softwareSourceAvailabilities
      type: object
    SoftwarePackage:
      description: An object that defines a software package.
      properties:
        architecture:
          description: The architecture for which this software was built
          enum:
          - I386
          - I686
          - AARCH64
          - X86_64
          - SRC
          - NOARCH
          - OTHER
          type: string
          x-obmcs-top-level-enum: '#/definitions/SoftwarePackageArchitecture'
        checksum:
          description: Checksum of the package.
          type: string
        checksumType:
          description: Type of the checksum.
          type: string
        dependencies:
          description: List of dependencies for the software package.
          items:
            $ref: '#/components/schemas/SoftwarePackageDependency'
          type: array
        description:
          description: Description of the package.
          type: string
        displayName:
          description: Package name.
          type: string
        files:
          description: List of files for the software package.
          items:
            $ref: '#/components/schemas/SoftwarePackageFile'
          type: array
        isLatest:
          description: Indicates whether this package is the latest version.
          type: boolean
        lastModifiedDate:
          description: The date and time the package was last modified (in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format).
          type: string
        name:
          description: Unique identifier for the package. Note that this is not an OCID.
          type: string
        osFamilies:
          description: The OS families the package belongs to.
          items:
            $ref: '#/components/schemas/OsFamily'
          maxItems: 100
          type: array
        sizeInBytes:
          description: Size of the package in bytes.
          format: int64
          type: integer
        softwareSources:
          description: List of software sources that provide the software package. This property is deprecated and it will be removed in a future API release.
          items:
            $ref: '#/components/schemas/SoftwareSourceDetails'
          maxItems: 255
          type: array
        type:
          description: Type of the package.
          type: string
        version:
          description: Version of the package.
          type: string
      required:
      - displayName
      - type
      - version
      - name
      x-example: "{\n  \"displayName\": \"audit-libs\",\n  \"name\": \"audit-libs-3.1.2-1.0.1.el8.x86_64.rpm\",\n  \"type\": \"RPM\",\n  \"version\": \"3.1.2-1.0.1.el8\",\n  \"architecture\": \"X86_64\",\n  \"lastModifiedDate\": \"Thu Sep 12 20:52:25 UTC 2024\",\n  \"checksum\": \"&lt;check_sum&gt\",\n  \"checksumType\": \"sha256\",\n  \"description\": \"The audit-libs package contains the dynamic libraries needed for\\napplications to use the audit framework.\",\n  \"sizeInBytes\": 310696,\n  \"dependencies\": [\n    {\n      \"dependency\": \"&lt;dependency_name&gt;\",\n      \"dependencyType\": \"provide\",\n      \"dependencyModifier\": \"EQ 0-3.1.2-1.0.1.el8\"\n    }\n  ],\n  \"files\": [\n    {\n      \"path\": \"&lt;path_for_file&gt;\",\n      \"type\": \"file\",\n      \"timeModified\": null,\n      \"checksum\": null,\n      \"checksumType\": null,\n      \"sizeInBytes\": null\n    }\n  ],\n  \"softwareSources\": [\n    {\n      \"id\": \"ocid1.osmhsoftwaresource.oc1.iad..exampleuniqueID\",\n      \"displayName\": \"ol8_baseos_latest-x86_64\",\n      \"description\": \"Oracle Linux 8 BaseOS Latest  (x86_64)\",\n      \"softwareSourceType\": \"VENDOR\",\n      \"isMandatoryForAutonomousLinux\": true\n    },\n    {\n      \"id\": \"ocid1.osmhsoftwaresource.oc1.iad.exampleuniqueID2\",\n      \"displayName\": \"ol8_u10_baseos_patch-x86_64\",\n      \"description\": \"Oracle Linux 8.10 BaseOS Patch (x86_64)\",\n      \"softwareSourceType\": \"VENDOR\",\n      \"isMandatoryForAutonomousLinux\": false\n    }\n  ],\n  \"isLatest\": false,\n  \"osFamilies\": null\n}\n"
    EntitlementCollection:
      description: The set of entitlements returned for the [ListEntitlements](#/en/osmh/latest/SoftwareSource/ListEntitlements).
      properties:
        items:
          description: List of entitlements.
          items:
            $ref: '#/components/schemas/EntitlementSummary'
          type: array
      required:
      - items
      type: object
      x-example: "{\n  \"items\": [\n    {\n      \"compartmentId\": \"ocid1.compartment.oc1..&lt;unique_id&gt;\",\n      \"csi\": \"&lt;unique_csi&gt;\",\n      \"vendorName\": \"Oracle\"\n    }\n  ]\n}\n"
    SoftwarePackageSummary:
      description: Provides summary information for a software package.
      properties:
        architecture:
          description: The architecture for which this software was built.
          enum:
          - I386
          - I686
          - AARCH64
          - X86_64
          - SRC
          - NOARCH
          - OTHER
          type: string
          x-obmcs-top-level-enum: '#/definitions/SoftwarePackageArchitecture'
        checksum:
          description: Checksum of the package.
          type: string
        checksumType:
          description: Type of the checksum.
          type: string
        displayName:
          description: Package name.
          type: string
        isLatest:
          description: Indicates whether this package is the latest version.
          type: boolean
        lastModifiedDate:
          description: The date and time the package was last modified (in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format).
          type: string
        name:
          description: Unique identifier for the package. Note that this is not an OCID.
          type: string
        osFamilies:
          description: The OS families the package belongs to.
          items:
            $ref: '#/components/schemas/OsFamily'
          maxItems: 100
          type: array
        softwareSources:
          description: List of software sources that provide the software package. This property is deprecated and it will be removed in a future API release.
          items:
            $ref: '#/components/schemas/SoftwareSourceDetails'
          type: array
        type:
          description: Type of the package.
          type: string
        version:
          description: Version of the package.
          type: string
      required:
      - displayName
      - type
      - version
      - name
    ModuleStreamProfile:
      description: An object that defines a module stream profile provide by a software source.
      properties:
        description:
          description: A description of the contents of the module stream profile.
          type: string
        isDefault:
          description: Indicates if this profile is the default for its module stream.
          type: boolean
        moduleName:
          description: The name of the module that contains the stream profile.
          type: string
        name:
          description: The name of the profile.
          type: string
        packages:
          description: 'A list of packages that constitute the profile.  Each element

            in the list is the name of a package.  The name is suitable to

            use as an argument to other OS Management Hub APIs that interact

            directly with packages.

            '
          items:
            type: string
          type: array
        streamName:
          description: The name of the stream that contains the profile.
          type: string
      required:
      - moduleName
      - streamName
      - name
      - packages
      type: object
      x-example: "{\n  \"moduleName\": \"module_name\",\n  \"streamName\": \"stream_name\",\n  \"name\": \"resource_Name\",\n  \"isDefault\": false,\n  \"description\": null,\n  \"packages\": [\n    \"nodejs\"\n  ]\n}\n"
    ModuleStream:
      description: An object that defines a module stream provided by a software source.
      properties:
        archType:
          description: The architecture for which the packages in this module stream were built.
          enum:
          - X86_64
          - AARCH64
          - I686
          - NOARCH
          - SRC
          - I386
          - AMD64
          - ARM64
          - ALL
          type: string
          x-obmcs-top-level-enum: '#/definitions/ArchType'
        description:
          description: A description of the contents of the module stream.
          type: string
        isDefault:
          description: Indicates if this stream is the default for its module.
          type: boolean
        isLatest:
          description: Indicates whether this module stream is the latest.
          type: boolean
        moduleName:
          description: The name of the module that contains the stream.
          type: string
        name:
          description: The name of the stream.
          type: string
        packages:
          description: 'A list of packages that are contained by the stream.  Each element

            in the list is the name of a package.  The name is suitable to use

            as an argument to other OS Management Hub APIs that interact directly

            with packages.

            '
          items:
            type: string
          type: array
        profiles:
          description: 'A list of profiles that are part of the stream.  Each element in

            the list is the name of a profile.  The name is suitable to use as

            an argument to other OS Management Hub APIs that interact directly with

            module stream profiles.  However, it is not URL encoded.

            '
          items:
            type: string
          type: array
        softwareSourceId:
          description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the software source that provides this module stream.
          type: string
      required:
      - moduleName
      - name
      type: object
      x-example: "{\n  \"moduleName\": \"module-name\",\n  \"name\": \"1.0\",\n  \"isDefault\": false,\n  \"softwareSourceId\": \"ocid1.osmhsoftwaresource.oc1..&lt;unique_id&gt;\",\n  \"archType\": \"X86_64\",\n  \"description\": \"Module Stream description\",\n  \"profiles\": [\n    \"common\"\n  ],\n  \"packages\": [\n    \"buildah-0:1.5-8.gite94b4f9.0.1.module+el8.3.0+20164+d105d709.x86_64\",\n    \"container-selinux-2:2.124.0-1.gitf958d0c.module+el8.3.0+20164+d105d709.noarch\",\n    \"containernetworking-plugins-0:0.7.4-4.git9ebe139.module+el8.3.0+20164+d105d709.x86_64\",\n    \"slirp4netns-0:0.1-5.dev.gitc4e1bc5.module+el8.3.0+20164+d105d709.x86_64\"\n  ],\n  \"isLatest\": true\n}\n"
    CreateEntitlementDetails:
      description: Provides the information used to create an entitlement using the Customer Support Identifier (CSI).
      properties:
        compartmentId:
          description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the tenancy containing the entitlement.
          type: string
        csi:
          description: The Customer Support Identifier (CSI) which unlocks the software sources. The CSI is is a unique key given to a customer and it uniquely identifies the entitlement.
          type: string
      required:
      - compartmentId
      - csi
    SoftwareSource:
      description: The object that defines a software source. A software source contains a collection of packages. For more information, see [Managing Software Sources](/iaas/osmh/doc/software-sources.htm).
      discriminator:
        propertyName: softwareSourceType
      properties:
        archType:
          description: The architecture type supported by the software source.
          enum:
          - X86_64
          - AARCH64
          - I686
          - NOARCH
          - SRC
          - I386
          - AMD64
          - ARM64
          - ALL
          type: string
          x-obmcs-top-level-enum: '#/definitions/ArchType'
        availability:
          description: Availability of the software source (for non-OCI environments).
          enum:
          - AVAILABLE
          - SELECTED
          - RESTRICTED
          - UNAVAILABLE
          type: string
          x-obmcs-top-level-enum: '#/definitions/Availability'
        availabilityAtOci:
          description: Availability of the software source (for OCI environments).
          enum:
          - AVAILABLE
          - SELECTED
          - RESTRICTED
          - UNAVAILABLE
          type: string
          x-obmcs-top-level-enum: '#/definitions/Availability'
        checksumType:
          description: The yum repository checksum type used by this software source.
          enum:
          - SHA1
          - SHA256
          - SHA384
          - SHA512
          type: string
          x-obmcs-top-level-enum: '#/definitions/ChecksumType'
        compartmentId:
          description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the software source.
          maxLength: 255
          minLength: 1
          type: string
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only the String type is supported.

                '
              type: object
            description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.

              Example: `{"CostCenter": "42"}`

              '
            type: object
          description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.

            For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).

            Example: `{"Operations": {"CostCenter": "42"}}`

            '
          type: object
        description:
          description: User-specified description for the software source.
          maxLength: 400
          type: string
        displayName:
          description: User-friendly name for the software source.
          format: x-obmcs-ascii-identifier
          maxLength: 255
          minLength: 1
          type: string
        freeformTags:
          additionalProperties:
            type: string
          description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.

            For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).

            Example: `{"Department": "Finance"}`

            '
          type: object
        gpgKeyFingerprint:
          description: Fingerprint of the GPG key for this software source.
          type: string
        gpgKeyId:
          description: ID of the GPG key for this software source.
          type: string
        gpgKeyUrl:
          description: URI of the GPG key for this software source.
          type: string
        id:
          description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the software source.
          type: string
        lifecycleState:
          description: The current state of the software source.
          enum:
          - CREATING
          - UPDATING
          - ACTIVE
          - INACTIVE
          - DELETING
          - DELETED
          - FAILED
          - NEEDS_ATTENTION
          type: string
        osFamily:
          description: The OS family of the software source.
          enum:
          - ORACLE_LINUX_10
          - ORACLE_LINUX_9
          - ORACLE_LINUX_8
          - ORACLE_LINUX_7
          - ORACLE_LINUX_6
          - WINDOWS_SERVER_2016
          - WINDOWS_SERVER_2019
          - WINDOWS_SERVER_2022
          - WINDOWS_SERVER_2025
          - WINDOWS_11
          - ALL
          - UBUNTU_20_04
          - UBUNTU_22_04
          - UBUNTU_24_04
          type: string
          x-obmcs-top-level-enum: '#/definitions/OsFamily'
        packageCount:
          description: Number of packages the software source contains.
          format: int64
          type: integer
        repoId:
          description: The repository ID for the software source.
          type: string
        size:
          description: The size of the software source in bytes (B).
          format: double
          type: number
        softwareSourceType:
          description: Type of software source.
          enum:
          - VENDOR
          - CUSTOM
          - VERSIONED
          - PRIVATE
          - THIRD_PARTY
          type: string
          x-obmcs-top-level-enum: '#/definitions/SoftwareSourceType'
        systemTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string type is supported.

                '
              type: object
            description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.

              Example: `{"bar-key": "value"}`

              '
            type: object
          description: 'System tags for this resource. Each key is predefined and scoped to a namespace.

            Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`

            '
          type: object
        timeCreated:
          description: 'The date and time the software source was created (in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format).

            '
          format: date-time
          type: string
        url:
          description: URL for the repository. For vendor software sources, this is the URL to the regional yum server. For custom software sources, this is 'custom/<repoId>'.
          type: string
      required:
      - id
      - compartmentId
      - softwareSourceType
      - displayName
      - timeCreated
      - osFamily
      - archType
      - availability
      - availabilityAtOci
      - repoId
      - url
      type: object
      x-example: "{\n  \"softwareSourceType\": \"CUSTOM\",\n  \"id\": \"ocid1.osmhsoftwaresource.oc1.iad.&lt;unique_id&gt;\",\n  \"compartmentId\": \"ocid1.compartment.oc1..exampleuniqueID\",\n  \"displayName\": \"TestSoftwareSource\",\n  \"timeCreated\": \"2025-02-13T09:43:54.715Z\",\n  \"description\": \"Creating a new software source for testing OSMH SS.\",\n  \"availability\": \"SELECTED\",\n  \"availabilityAtOci\": \"SELECTED\",\n  \"repoId\": \"custom.TestSoftwareSource.20250213094354715\",\n  \"osFamily\": \"ORACLE_LINUX_8\",\n  \"archType\": \"X86_64\",\n  \"lifecycleState\": \"CREATING\",\n  \"packageCount\": 0,\n  \"url\": \"custom/custom.TestSoftwareSource.20250213094354715\",\n  \"checksumType\": \"SHA256\",\n  \"gpgKeyUrl\": \"file:///etc/pki/rpm-gpg/RPM-GPG-KEY-oracle\",\n  \"gpgKeyId\": \"AD86DA3\",\n  \"gpgKeyFingerprint\": \"8346 3DB1 3AB6 6754 B89D 9824 8256 2EA9 ADBC 6DA3\",\n  \"size\": null,\n  \"vendorSoftwareSources\": [\n    {\n      \"id\": \"ocid1.osmhsoftwaresource.oc1.iad..exampleuniqueID1\",\n      \"displayName\": \"ol8_baseos_latest-x86_64\"\n    },\n    {\n      \"id\": \"ocid1.osmhsoftwaresource.oc1.iad..exampleuniqueID2\",\n      \"displayName\": \"ol8_addons-x86_64\"\n    },\n    {\n      \"id\": \"ocid1.osmhsoftwaresource.oc1.iad..exampleuniqueID3\",\n      \"displayName\": \"ol8_appstream-x86_64\"\n    }\n  ],\n  \"customSoftwareSourceFilter\": {\n    \"packageFilters\": [],\n    \"moduleStreamProfileFilters\": [],\n    \"packageGroupFilters\": []\n  },\n  \"isAutomaticallyUpdated\": false,\n  \"isAutoResolveDependencies\": true,\n  \"isCreatedFromPackageList\": false,\n  \"isLatestContentOnly\": true,\n  \"packages\": [],\n  \"softwareSourceSubType\": \"FILTER\",\n  \"timeMetadataUpdated\": null,\n  \"freeformTags\": {},\n  \"definedTags\": {\n    \"Oracle-Tags\": {\n      \"CreatedBy\": \"user\",\n      \"CreatedOn\": \"2025-02-13T09:43:54.523Z\"\n    }\n  },\n  \"systemTags\": {}\n}\n"
    ModuleStreamProfileSummary:
      description: Provides the summary information for a module stream profile contained within a software source.
      properties:
        isDefault:
          description: Indicates if this profile is the default for the module stream.
          type: boolean
        moduleName:
          description: The name of the module that contains the stream profile.
          type: string
        name:
          description: The name of the profile.
          type: string
        streamName:
          description: The name of the stream that contains the profile.
          type: string
      required:
      - moduleName
      - streamName
      - name
      type: object
    SoftwareSourceVendorSummary:
      description: Provides summary information about a software source vendor, including name, operating system family, and architecture type.
      properties:
        archTypes:
          description: List of corresponding architecture types.
          items:
            enum:
            - X86_64
            - AARCH64
            - I686
            - NOARCH
            - SRC
            - I386
            - AMD64
            - ARM64
            - ALL
            type: string
            x-obmcs-top-level-enum: '#/definitions/ArchType'
          maxItems: 100
          type: array
        name:
          description: Name of the vendor providing the software source.
          enum:
          - ORACLE
          - MICROSOFT
          - CANONICAL
          type: string
          x-obmcs-top-level-enum: '#/definitions/VendorName'
        osFamilies:
          description: List of corresponding operating system families.
          items:
            enum:
            - ORACLE_LINUX_10
            - ORACLE_LINUX_9
            - ORACLE_LINUX_8
            - ORACLE_LINUX_7
            - ORACLE_LINUX_6
            - WINDOWS_SERVER_2016
            - WINDOWS_SERVER_2019
            - WINDOWS_SERVER_2022
            - WINDOWS_SERVER_2025
            - WINDOWS_11
            - ALL
            - UBUNTU_20_04
            - UBUNTU_22_04
            - UBUNTU_24_04
            type: string
            x-obmcs-top-level-enum: '#/definitions/OsFamily'
          maxItems: 100
          type: array
      required:
      - name
      - osFamilies
      - archTypes
    Erratum:
      description: An object that defines an erratum..
      properties:
        advisorySeverity:
          description: The severity for a security advisory, otherwise, null.
          enum:
          - LOW
          - MODERATE
          - IMPORTANT
          - CRITICAL
          type: string
          x-obmcs-top-level-enum: '#/definitions/AdvisorySeverity'
        advisoryType:
          description: The advisory type of the erratum.
          enum:
          - SECURITY
          - BUGFIX
          - ENHANCEMENT
          type: string
          x-obmcs-top-level-enum: '#/definitions/AdvisoryTypes'
        classificationType:
          description: Type of the erratum. This property is deprecated and it will be removed in a future API release. Please refer to the advisoryType property instead.
          enum:
          - SECURITY
          - BUGFIX
          - ENHANCEMENT
          - OTHER
          type: string
          x-obmcs-top-level-enum: '#/definitions/ClassificationTypes'
        description:
          description: Details describing the erratum.
          type: string
        from:
          description: Information specifying from where the erratum was release.
          type: string
        name:
          description: Advisory name.
          type: string
        osFamilies:
          description: List of affected OS families.
          items:
            $ref: '#/components/schemas/OsFamily'
          maxItems: 100
          type: array
        packages:
          description: List of packages affected by this erratum.
          items:
            $ref: '#/components/schemas/SoftwarePackageSummary'
          type: array
        references:
          description: Information describing how to find more information about. the erratum.
          type: string
        relatedCves:
          description: List of CVEs applicable to this erratum.
          items:
            type: string
          type: array
        repositories:
          description: List of repository identifiers.
          items:
            type: string
          type: array
        solution:
          description: Information describing how the erratum can be resolved.
          type: string
        synopsis:
          description: Summary description of the erratum.
          type: string
        timeIssued:
          description: 'The date and time the erratum was issued (in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format).

            '
          format: date-time
          type: string
        timeUpdated:
          description: 'The date and time the erratum was updated (in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format).

            '
          format: date-time
          type: string
      required:
      - name
      type: object
      x-example: "{\n  \"name\": \"ELSA-2025-31356\",\n  \"synopsis\": \"terraform-provider-oci-fips security update\",\n  \"timeIssued\": \"2025-02-12T00:00:00.000Z\",\n  \"description\": \"[6.25.0-2.el9]\\n- Rebuild on golang-boringcrypto 1.22.11 to fix CVE-2024-24790 (Alex Burmashev){CVE-2024-24790}\",\n  \"timeUpdated\": \"2025-02-12T00:00:00.000Z\",\n  \"classificationType\": \"SECURITY\",\n  \"advisoryType\": null,\n  \"from\": \"el-errata@oss.oracle.com\",\n  \"solution\": \"This update is available via the Unbreakable Linux Network (ULN) and the Oracle Public Yum Server. \",\n  \"references\": \"https://linux.oracle.com/errata/ELSA-2025-31356.html\",\n  \"relatedCves\": [\n    \"CVE-2024-24790\"\n  ],\n  \"repositories\": [\n    \"ol8_developer-aarch64\",\n    \"ol8_developer-x86_64\",\n    \"ol9_developer-x86_64\"\n  ],\n  \"packages\": [\n    {\n      \"displayName\": \"terraform-provider-oci-fips\",\n      \"name\": \"terraform-provider-oci-fips-6.25.0-2.el9.aarch64.rpm\",\n      \"type\": \"RPM\",\n      \"version\": \"6.25.0-2.el9\",\n      \"architecture\": \"AARCH64\",\n      \"checksum\": \"&lt;check_sum&gt\",\n      \"checksumType\": \"sha256\",\n      \"isLatest\": true,\n      \"softwareSources\": null,\n      \"osFamilies\": null\n    }\n  ],\n  \"osFamilies\": [\n    \"ORACLE_LINUX_8\",\n    \"ORACLE_LINUX_9\"\n  ],\n  \"advisorySeverity\": \"MODERATE\"\n}\n"
    ErratumCollection:
      description: The set of errata returned for the [ListErrata](#/en/osmh/latest/Erratum/ListErrata) operation.
      properties:
        items:
          description: List of errata.
          items:
            $ref: '#/components/schemas/ErratumSummary'
          type: array
      required:
      - items
      type: object
      x-example: "{\n  \"items\": [\n    {\n      \"name\": \"ELSA-2025-31356\",\n      \"synopsis\": \"terraform-provider-oci-fips security update\",\n      \"timeIssued\": \"2025-02-12T00:00:00.000Z\",\n      \"timeUpdated\": \"2025-02-12T00:00:00.000Z\",\n      \"classificationType\": \"SECURITY\",\n      \"relatedCves\": [\n        \"CVE-2024-24790\"\n      ],\n      \"osFamilies\": [\n        \"ORACLE_LINUX_8\",\n        \"ORACLE_LINUX_9\"\n      ],\n      \"advisorySeverity\": \"MODERATE\",\n      \"advisoryType\": null\n    }\n  ]\n}\n"
    SoftwarePackageDependency:
      description: Identifies the dependency for a software package.
      properties:
        dependency:
          description: The software package's dependency.
          type: string
        dependencyModifier:
          description: The modifier for the dependency.
          type: string
        dependencyType:
          description: The type of the dependency.
          type: string
    SearchSoftwareSourceModuleStreamsDetails:
      description: Provides the information used to search for a set of module streams from a list software sources.
      properties:
        moduleName:
          description: 'The name of a module.

            '
          type: string
        softwareSourceIds:
          description: List of software source [OCIDs](/iaas/Content/General/Concepts/identifiers.htm).
          items:
            type: string
          maxItems: 255
          type: array
        sortBy:
          description: The field to sort by.
          enum:
          - MODULENAME
          type: string
        sortOrder:
          description: The sort order.
          enum:
          - ASC
          - DESC
          type: string
      required:
      - softwareSourceIds
      type: object
    ModuleStreamProfileCollection:
      description: The set of module stream profiles returned for the [ListModuleStreamProfiles](#/en/osmh/latest/SoftwareSource/ListModuleStreamProfiles) operation.
      properties:
        items:
          description: List of module stream profiles.
          items:
            $ref: '#/components/schemas/ModuleStreamProfileSummary'
          type: array
      required:
      - items
      type: object
    ErratumSummary:
      description: Provides summary information for an erratum. An erratum is an important software change which can include security advisories, bug fixes, or enhancements.
      properties:
        advisorySeverity:
          description: The severity advisory. Only valid for security type advisories.
          enum:
          - LOW
          - MODERATE
          - IMPORTANT
          - CRITICAL
          type: string
          x-obmcs-top-level-enum: '#/definitions/AdvisorySeverity'
        advisoryType:
          description: The advisory type of the erratum.
          enum:
          - SECURITY
          - BUGFIX
          - ENHANCEMENT
          type: string
          x-obmcs-top-level-enum: '#/definitions/AdvisoryTypes'
        classificationType:
          description: Type of the erratum. This property is deprecated and it will be removed in a future API release. Please refer to the advisoryType property instead.
          enum:
          - SECURITY
          - BUGFIX
          - ENHANCEMENT
          - OTHER
          type: string
          x-obmcs-top-level-enum: '#/definitions/ClassificationTypes'
        name:
          description: Advisory name.
          maxLength: 255
          minLength: 1
          type: string
        osFamilies:
          description: List of affected OS families.
          items:
            $ref: '#/components/schemas/OsFamily'
          maxItems: 100
          type: array
        relatedCves:
          description: List of CVEs applicable to this erratum.
          items:
            type: string
          maxItems: 255
          type: array
        synopsis:
          description: Summary description of the erratum.
          maxLength: 255
          minLength: 1
          type: string
        timeIssued:
          description: 'The date and time the erratum was issued (in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format).

            '
          format: date-time
          type: string
        timeUpdated:
          description: 'The date and time the erratum was updated (in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format).

            '
          format: date-time
          type: string
      required:
      - name
      type: object
    SearchSoftwareSourcePackageGroupsDetails:
      description: Provides the software sources and search parameters to get a list of associated package groups.
      properties:
        groupType:
          description: Indicates if this is a group, category or environment.
          type: string
          x-obmcs-enumref: '#/definitions/PackageGroup/groupType'
        nameContains:
          description: A filter that returns package groups with a name that contains the given string.
          type: string
        softwareSourceIds:
          description: List of software source [OCIDs](/iaas/Content/General/Concepts/identifiers.htm).
          items:
            type: string
          maxItems: 255
          type: array
        sortBy:
          description: The field to sort by.
          enum:
          - NAME
          type: string
        sortOrder:
          description: The sort order.
          enum:
          - ASC
          - DESC
          type: string
      required:
      - softwareSourceIds
      type: object
    PackageGroupCollection:
      description: The set of package groups returned for the [ListPackageGroups](#/en/osmh/latest/SoftwareSource/ListPackageGroups) [SearchSoftwareSourcePackageGroups](#/en/osmh/latest/SoftwareSource/SearchSoftwareSourcePackageGroups) operation.
      properties:
        items:
          description: List of package groups.
          items:
            $ref: '#/components/schemas/PackageGroupSummary'
          type: array
      required:
      - items
      type: object
      x-example: "{\n  \"items\": [\n    {\n      \"id\": \"dotnet-core\",\n      \"name\": \".NET Core Development\",\n      \"description\": \"Tools to develop .NET and .NET Core applications\",\n      \"isUserVisible\": true,\n      \"isDefault\": true,\n      \"repositories\": [\n        \"ol8_appstream-x86_64\"\n      ],\n      \"groupType\": \"GROUP\",\n      \"displayOrder\": 0\n    }\n  ]\n}\n"
    OsFamily:
      description: Type of operating system.
      enum:
      - ORACLE_LINUX_10
      - ORACLE_LINUX_9
      - ORACLE_LINUX_8
      - ORACLE_LINUX_7
      - ORACLE_LINUX_6
      - WINDOWS_SERVER_2016
      - WINDOWS_SERVER_2019
      - WINDOWS_SERVER_2022
      - WINDOWS_SERVER_2025
      - WINDOWS_11
      - ALL
      - UBUNTU_20_04
      - UBUNTU_22_04
      - UBUNTU_24_04
      type: string
    SoftwareSourceCollection:
      description: A set of software sources returned for the [ListSoftwareSources](#/en/osmh/latest/SoftwareSource/ListSoftwareSources) operation.
      properties:
        items:
          description: List of software sources.
          items:
            $ref: '#/components/schemas/SoftwareSourceSummary'
          type: array
      required:
      - items
      type: object
      x-example: "{\n\"items\": [\n  {\n    \"softwareSourceType\": \"VENDOR\",\n    \"id\": \"ocid1.osmhsoftwaresource.oc1.iad.&lt;unique_id&gt;\",\n    \"compartmentId\": \"ocid1.compartment.oc1..exampleuniqueID\",\n    \"displayName\": \"ol8_appstream-x86_64\",\n    \"repoId\": \"ol8_appstream\",\n    \"url\": \"https://yum-iad.oracle.com/repo/OracleLinux/OL8/appstream/x86_64/\",\n    \"timeCreated\": \"2024-11-18T13:57:49.000Z\",\n    \"timeUpdated\": \"2024-11-18T13:57:49.000Z\",\n    \"description\": \"Oracle Linux 8 Application Stream Packages  (x86_64)\",\n    \"availability\": \"SELECTED\",\n    \"availabilityAtOci\": \"SELECTED\",\n    \"osFamily\": \"ORACLE_LINUX_8\",\n    \"archType\": \"X86_64\",\n    \"packageCount\": 53342,\n    \"lifecycleState\": \"ACTIVE\",\n    \"size\": 1.48467434929E11,\n    \"freeformTags\": null,\n    \"definedTags\": null,\n    \"systemTags\": null,\n    \"vendorName\": \"ORACLE\",\n    \"isMandatoryForAutonomousLinux\": true\n      }\n    ]\n}\n"
    ModuleCollection:
      description: The set of modules returned for the [SearchSoftwareSourceModules](#/en/osmh/latest/SoftwareSource/SearchSoftwareSourceModules) operation.
      properties:
        items:
          description: List of modules.
          items:
            $ref: '#/components/schemas/ModuleSummary'
          type: array
      required:
      - items
      type: object
      x-example: "{\n  \"items\": [\n    {\n      \"name\": \"module-name\",\n      \"streams\": [\n        \"1.0\",\n        \"2.0\",\n        \"3.0\",\n        \"4.0\",\n        \"ol8\"\n      ],\n      \"ocid1.osmhsoftwaresource.oc1..&lt;unique_id&gt;\"\n    }\n  ]\n}\n"
    ReplacePackagesInSoftwareSourceDetails:
      description: Provides a list of packages that will replace the existing packages in the software source.
      properties:
        packages:
          description: List of packages specified by the name of the package (N) or the full package name (NVRA or NEVRA).
          items:
            type: string
          maxItems: 524288
          type: array
      required:
      - packages
      type: object
    EntitlementSummary:
      description: Provides summary information for an entitlement.
      properties:
        compartmentId:
          description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the tenancy containing the entitlement.
          type: string
        csi:
          description: The Customer Support Identifier (CSI) which unlocks the software sources. The CSI is is a unique key given to a customer and it uniquely identifies the entitlement.
          type: string
        vendorName:
          description: The vendor for the entitlement.
          type: string
      required:
      - compartmentId
      - csi
      - vendorName
      type: object
    SoftwarePackageFile:
      description: A file associated with a package.
      properties:
        checksum:
          description: Checksum of the file.
          type: string
        checksumType:
          description: Type of the checksum.
          type: string
        path:
          description: File path.
          type: string
        sizeInBytes:
          description: Size of the file in bytes.
          format: int64
          type: integer
        timeModified:
          description: 'The date and time the file was last modified (in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format).

            '
          format: date-time
          type: string
        type:
          description: Type of the file.
          type: string
    AddPackagesToSoftwareSourceDetails:
      description: Provides the list of packages to add to a software source.
      properties:
        isContinueOnMissingPackages:
          default: false
          description: Indicates whether the service should generate a custom software source when the package list contains invalid values. When set to true, the service ignores any invalid packages and generates the custom software source with using the valid packages.
          type: boolean
        packages:
          description: List of packages specified by the name of the package (N) or the full package name (NVRA or NEVRA).
          items:
            type: string
          maxItems: 524288
          type: array
      required:
      - packages
      type: object
    UpdateSoftwareSourceDetails:
      description: Provides the information used to update a software source.
      discriminator:
        propertyName: softwareSourceType
      properties:
        compartmentId:
          description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the software source.
          maxLength: 255
          minLength: 1
          type: string
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only the String type is supported.

                '
              type: object
            description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.

              Example: `{"CostCenter": "42"}`

              '
            type: object
          description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.

            For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).

            Example: `{"Operations": {"CostCenter": "42"}}`

            '
          type: object
        description:
          description: User-specified description of the software source.
          maxLength: 400
          type: string
        displayName:
          description: User-friendly name for the software source.
          format: x-obmcs-ascii-identifier
          maxLength: 255
          minLength: 1
          pattern: ^[a-zA-Z_](-?[a-zA-Z_0-9.])*$
          type: string
        freeformTags:
          additionalProperties:
            type: string
          description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.

            For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).

            Example: `{"Department": "Finance"}`

            '
          type: object
        softwareSourceType:
          description: Type of the software source.
          enum:
          - VENDOR
          - CUSTOM
          - VERSIONED
          - PRIVATE
          - THIRD_PARTY
          type: string
          x-obmcs-top-level-enum: '#/definitions/SoftwareSourceType'
      type: object
    ModuleStreamSummary:
      description: Provides the summary information for a module stream contained within a software source.
      properties:
        isLatest:
          description: Indicates whether this module stream is the latest.
          type: boolean
        moduleName:
          description: 'The name of the module that contains the stream.

            '
          type: string
        name:
          description: 'The name of the stream.

            '
          type: string
        profiles:
          description: List of profiles in the stream.
          items:
            type: string
          type: array
        softwareSourceId:
          description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the software source that contains the the module stream.

            '
          type: string
      required:
      - name
      - moduleName
      - profiles
      type: object
    ChangeSoftwareSourceCompartmentDetails:
      description: Provides the information used to move the software source to another compartment.
      properties:
        compartmentId:
          description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the software source to.

            '
          maxLength: 255
          minLength: 1
          type: string
      required:
      - compartmentId
      type: object
    PackageGroup:
      description: Yum or DNF package group, category, or environment.
      properties:
        description:
          description: Description of the package group.
          type: string
        displayOrder:
          description: Indicates the order to display category or environment.
          type: integer
        groupType:
          description: Indicates if this is a group, category, or environment.
          enum:
          - GROUP
          - ENVIRONMENT
          - CATEGORY
          type: string
        id:
          description: Package group identifier.
          type: string
        isDefault:
          description: Indicates if this package group is the default.
          type: boolean
        isUserVisible:
          description: Indicates if this package group is visible to users.
          type: boolean
        name:
          description: Package group name.
          type: string
        packages:
          description: The list of packages in the package group.
          items:
            type: string
          type: array
        repositories:
          description: The repository IDs of the package group's repositories.
          items:
            type: string
          maxItems: 255
          type: array
      required:
      - id
      - name
      - packages
      x-example: "{\n  \"id\": \"dotnet-core\",\n  \"name\": \".NET Core Development\",\n  \"repositories\": [\n    \"ol8_appstream-x86_64\"\n  ],\n  \"description\": \"Tools to develop .NET and .NET Core applications\",\n  \"isUserVisible\": true,\n  \"isDefault\": true,\n  \"groupType\": \"GROUP\",\n  \"displayOrder\": null,\n  \"packages\": [\n    \"dotnet-sdk-6.0\",\n    \"dotnet-sdk-3.1\"\n  ]\n}\n"
    CreateSoftwareSourceDetails:
      description: Provides the information used to create a software source.
      discriminator:
        propertyName: softwareSourceType
      properties:
        compartmentId:
          description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the software source.
          maxLength: 255
          minLength: 1
          type: string
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only the String type is supported.

                '
              type: object
            description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.

              Example: `{"CostCenter": "42"}`

              '
            type: object
          description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.

            For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).

            Example: `{"Operations": {"CostCenter": "42"}}`

            '
          type: object
        description:
          description: User-specified description for the software source. Avoid entering confidential information.
          maxLength: 400
          type: string
        displayName:
          description: User-friendly name for the software source. Does not have to be unique and you can change the name later. Avoid entering confidential information.
          format: x-obmcs-ascii-identifier
          maxLength: 255
          minLength: 1
          pattern: ^[a-zA-Z_](-?[a-zA-Z_0-9.])*$
          type: string
        freeformTags:
          additionalProperties:
            type: string
          description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.

            For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).

            Example: `{"Department": "Finance"}`

            '
          type: object
        softwareSourceType:
          description: Type of software source.
          enum:
          - VENDOR
          - CUSTOM
          - VERSIONED
          - PRIVATE
          - THIRD_PARTY
          type: string
          x-obmcs-top-level-enum: '#/definitions/SoftwareSourceType'
      required:
      - compartmentId
      - softwareSourceType
      type: object
    ModuleStreamCollection:
      description: The set of module streams returned for [ListModuleStreams](#/en/osmh/latest/SoftwareSource/ListModuleStreamProfiles) operation.
      properties:
        items:
          description: List of module streams.
          items:
            $ref: '#/components/schemas/ModuleStreamSummary'
          type: array
      required:
      - items
      type: object
      x-example: "{\n  \"items\": [\n    {\n      \"name\": \"1.4\",\n      \"moduleName\": \"389-ds\",\n      \"profiles\": [],\n      \"isLatest\": true,\n      \"softwareSourceId\": \"ol8_appstream-x86_64\"\n    }\n  ]\n}\n"
    PackageGroupSummary:
      description: The yum or DNF package group that is associated with a software source.
      properties:
        description:
          description: Description of the package group.
          type: string
        displayOrder:
          description: Indicates the order to display category or environment.
          type: integer
        groupType:
          description: Indicates if this is a group, category or environment.
          type: string
          x-obmcs-enumref: '#/definitions/PackageGroup/groupType'
        id:
          description: Package group identifier.
          type: string
        isDefault:
          description: Indicates if this package group is the default.
          type: boolean
        isUserVisible:
          description: Indicates if this package group is visible to users.
          type: boolean
        name:
          description: Package group name.
          type: string
        repositories:
          description: The repository IDs of the package group.
          items:
            type: string
          maxItems: 255
          type: array
      required:
      - id
      - name
    SearchSoftwareSourceModulesDetails:
      description: Provides the information used to search for a set of modules from a list software sources.
      properties:
        name:
          description: 'The name of a module.

            '
          type: string
        nameContains:
          description: A filter to return modules with a name that contains the given string.
          type: string
        softwareSourceIds:
          description: List of sofware source [OCIDs](/iaas/Content/General/Concepts/identifiers.htm).
          items:
            type: string
          maxItems: 255
          type: array
        sortBy:
          description: The field to sort by.
          enum:
          - NAME
          type: string
        sortOrder:
          description: The sort order.
          enum:
          - ASC
          - DESC
          type: string
      required:
      - softwareSourceIds
      type: object
  parameters:
    NameQueryParam:
      description: The name of the entity to be queried.
      in: query
      name: name
      required: false
      x-default-description: 'null'
      schema:
        type: string
        maxLength: 255
        minLength: 1
    OsFamilyQueryParam:
      description: A filter to return only resources that match the given operating system family.
      in: query
      name: osFamily
      x-default-description: 'null'
      x-obmcs-top-level-enum: '#/definitions/OsFamily'
      schema:
        type: string
        enum:
        - ORACLE_LINUX_10
        - ORACLE_LINUX_9
        - ORACLE_LINUX_8
        - ORACLE_LINUX_7
        - ORACLE_LINUX_6
        - WINDOWS_SERVER_2016
        - WINDOWS_SERVER_2019
        - WINDOWS_SERVER_2022
        - WINDOWS_SERVER_2025
        - WINDOWS_11
        - ALL
        - UBUNTU_20_04
        - UBUNTU_22_04
        - UBUNTU_24_04
    RequiredCompartmentIdQueryParam:
      description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. This parameter is required and returns only resources contained within the specified compartment.
      in: query
      name: compartmentId
      required: true
      x-default-description: 'null'
      schema:
        type: string
    AvailabilityQueryParam:
      description: The availability of the software source in a non-OCI environment for a tenancy.
      in: query
      name: availability
      required: false
      x-default-description: 'null'
      style: form
      explode: true
      schema:
        type: array
        items:
          enum:
          - AVAILABLE
          - SELECTED
          - RESTRICTED
          - UNAVAILABLE
          type: string
          x-obmcs-top-level-enum: '#/definitions/Availability'
    EndIssueDateQueryParam:
      description: 'The issue date before which to list all errata, in ISO 8601 format


        Example: 2017-07-14T02:40:00.000Z

        '
      in: query
      name: timeIssueDateEnd
      required: false
      x-default-description: 'null'
      schema:
        type: string
        format: date-time
    CsiQueryParam:
      description: A filter to return entitlements that match the given customer support identifier (CSI).
      in: query
      name: csi
      required: false
      x-default-description: 'null'
      schema:
        type: string
    IfMatchHeader:
      description: 'For optimistic concurrency control. In the PUT or DELETE call

        for a resource, set the `if-match` parameter to the value of the

        etag from a previous GET or POST response for that resource.

        The resource will be updated or deleted only if the etag you

        provide matches the resource''s current etag value.

        '
      in: header
      name: if-match
      required: false
      schema:
        type: string
    MultiOsFamilyQueryParam:
      description: A filter to return only resources that match the given operating system family.
      in: query
      name: osFamily
      required: false
      x-default-description: 'null'
      style: form
      explode: true
      schema:
        type: array
        items:
          enum:
          - ORACLE_LINUX_10
          - ORACLE_LINUX_9
          - ORACLE_LINUX_8
          - ORACLE_LINUX_7
          - ORACLE_LINUX_6
          - WINDOWS_SERVER_2016
          - WINDOWS_SERVER_2019
          - WINDOWS_SERVER_2022
          - WINDOWS_SERVER_2025
          - WINDOWS_11
          - ALL
          - UBUNTU_20_04
          - UBUNTU_22_04
          - UBUNTU_24_04
          type: string
          x-obmcs-top-level-enum: '#/definitions/OsFamily'
        maxItems: 5
        uniqueItems: true
    AdvisorySeverityQueryParam:
      description: 'The advisory severity.

        '
      in: query
      name: advisorySeverity
      required: false
      x-default-description: 'null'
      style: form
      explode: true
      schema:
        type: array
        items:
          enum:
          - LOW
          - MODERATE
          - IMPORTANT
          - CRITICAL
          type: string
          x-obmcs-top-level-enum: '#/definitions/AdvisorySeverity'
        maxItems: 10
    ModuleNameParam:
      description: 'The name of a module. This parameter is required if a

        streamName is specified.

        '
      in: query
      name: moduleName
      required: false
      x-default-description: 'null'
      schema:
        type: string
    isLatestQueryParam:
      description: Indicates whether to list only the latest versions of packages, module streams, and stream profiles.
      in: query
      name: isLatest
      required: false
      x-default-description: 'null'
      schema:
        type: boolean
    SortOrderQueryParam:
      description: The sort order to use, either 'ASC' or 'DESC'.
      in: query
      name: sortOrder
      x-default-description: 'The default value depends upon `sortBy`, and

        in general is ''DESC'' when sorting by time and ''ASC'' otherwise.

        '
      x-obmcs-top-level-enum: '#/definitions/SortOrder'
      schema:
        type: string
        enum:
        - ASC
        - DESC
    ModuleStreamNameParam:
      description: The name of the module stream. This parameter is required if a profile name is specified.
      in: query
      name: streamName
      required: false
      x-default-description: 'null'
      schema:
        type: string
    AvailabilityAtOciQueryParam:
      description: The availability of the software source in an OCI environment for a tenancy.
      in: query
      name: availabilityAtOci
      required: false
      x-default-description: 'null'
      style: form
      explode: true
      schema:
        type: array
        items:
          enum:
          - AVAILABLE
          - SELECTED
          - RESTRICTED
          - UNAVAILABLE
          type: string
          x-obmcs-top-level-enum: '#/definitions/Availability'
    SoftwareSourceSortByQueryParamErrata:
      description: 'The field to sort errata by. Only one sort order may be provided. Default order for timeIssued is descending. Default order for name is ascending. If no value is specified timeIssued is default.

        '
      in: query
      name: sortBy
      schema:
        type: string
        enum:
        - timeIssued
        - name
        default: timeIssued
    RequestIdHeader:
      description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
      in: header
      name: opc-request-id
      schema:
        type: string
    MultiAdvisoryTypeQueryParam:
      description: A filter to return only errata that match the given advisory types.
      in: query
      name: advisoryType
      x-default-description: 'null'
      style: form
      explode: true
      schema:
        type: array
        items:
          enum:
          - SECURITY
          - BUGFIX
          - ENHANCEMENT
          type: string
          x-obmcs-top-level-enum: '#/definitions/AdvisoryTypes'
        maxItems: 5
        uniqueItems: true
    RequiredModuleNameQueryParam:
      description: 'The name of a module.

        '
      in: query
      name: moduleName
      required: true
      x-default-description: 'null'
      schema:
        type: string
    SoftwarePackageNamePathParam:
      description: The name of the software package.
      in: path
      name: softwarePackageName
      required: true
      schema:
        type: string
    ModuleNameSortByQueryParam:
      description: 'The field to sort by. Only one sort order may be provided. Default order for moduleName is ascending.

        '
      in: query
      name: sortBy
      schema:
        type: string
        enum:
        - moduleName
        default: moduleName
    PaginationTokenDefaultQueryParam:
      description: 'For list pagination. The value of the `opc-next-page` response header from the previous "List" call.

        For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).


        Example: `3`

        '
      in: query
      name: page
      x-default-description: 'null'
      schema:
        type: string
        minLength: 1
    SoftwarePackageVersionQueryParam:
      description: A filter to return software packages that match the given version.
      in: query
      name: version
      required: false
      x-default-description: 'null'
      schema:
        type: string
    RequiredModuleStreamNameQueryParam:
      description: 'The name of the stream of the containing module.

        '
      in: query
      name: streamName
      required: true
      x-default-description: 'null'
      schema:
        type: string
    MultiPackageGroupTypeQueryParam:
      description: A filter to return only package groups of the specified type.
      in: query
      name: groupType
      required: false
      x-default-description: 'null'
      style: form
      explode: true
      schema:
        type: array
        items:
          type: string
          x-obmcs-enumref: '#/definitions/PackageGroup/groupType'
        uniqueItems: true
    IsMirrorSyncAllowedQueryParam:
      description: A filter to return software sources which can be synced to a management station.
      in: query
      name: isMirrorSyncAllowed
      required: false
      x-default-description: 'null'
      schema:
        type: boolean
    DisplayNameContainsQueryParam:
      description: A filter to return resources that may partially match the given display name.
      in: query
      name: displayNameContains
      x-default-description: 'null'
      schema:
        type: string
        maxLength: 255
        minLength: 1
    ModuleNamePathParam:
      description: The name of the module.
      in: path
      name: moduleName
      required: true
      schema:
        type: string
    SoftwareSourceSortByQueryParam:
      description: 'The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending.

        '
      in: query
      name: sortBy
      schema:
        type: string
        enum:
        - timeCreated
        - displayName
        default: timeCreated
    ChangeSoftwareSourceCompartmentDetailsParam:
      description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for the compartment to move the software source to.
      in: body
      name: ChangeSoftwareSourceCompartmentDetails
      required: true
      schema:
        $ref: '#/components/schemas/ChangeSoftwareSourceCompartmentDetails'
    IsMandatoryForAutonomousLinuxQueryParam:
      description: Indicates whether the software source is mandatory for the Autonomous Linux service.
      in: query
      name: isMandatoryForAutonomousLinux
      required: false
      x-default-description: 'null'
      schema:
        type: boolean
    StartIssueDateQueryParam:
      description: 'The issue date after which to list all errata, in ISO 8601 format


        Example: 2017-07-14T02:40:00.000Z

        '
      in: query
      name: timeIssueDateStart
      required: false
      x-default-description: 'null'
      schema:
        type: string
        format: date-time
    NameContainsQueryParam:
      description: A filter to return resources that may partially match the name given.
      in: query
      name: nameContains
      required: false
      x-default-description: 'null'
      schema:
        type: string
    ErratumNamePathParam:
      description: The erratum name (such as ELSA-2023-34678).
      in: path
      name: name
      required: true
      schema:
        type: string
    ModuleStreamProfileNamePathParam:
      description: The name of the module stream profile.
      in: path
      name: profileName
      required: true
      schema:
        type: string
    ModuleNameContainsQueryParam:
      description: A filter to return resources that may partially match the module name given.
      in: query
      name: moduleNameContains
      x-default-description: 'null'
      schema:
        type: string
        maxLength: 255
        minLength: 1
    DisplayNameQueryParam:
      description: A filter to return resources that match the given user-friendly name.
      in: query
      name: displayName
      x-default-description: 'null'
      schema:
        type: string
        maxLength: 255
        minLength: 1
    SoftwarePackageArchitectureQueryParam:
      description: A filter to return software packages that match the given architecture.
      in: query
      name: architecture
      required: false
      x-default-description: 'null'
      x-obmcs-top-level-enum: '#/definitions/SoftwarePackageArchitecture'
      schema:
        type: string
        enum:
        - I386
        - I686
        - AARCH64
        - X86_64
        - SRC
        - NOARCH
        - OTHER
    PaginationTokenQueryParam:
      description: 'For list pagination. The value of the `opc-next-page` response header from the previous "List" call.

        For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).


        Example: `3`

        '
      in: query
      name: page
      x-default-description: 'null'
      schema:
        type: string
        minLength: 1
    PackageGroupIdPathParam:
      description: The unique package group identifier.
      in: path
      name: packageGroupId
      required: true
      schema:
        type: string
    ReplacePackagesInSoftwareSourceDetailsParam:
      description: A list of packages that will replace the existing packages in the software source.
      in: body
      name: ReplacePackagesInSoftwareSourceDetails
      required: true
      schema:
        $ref: '#/components/schemas/ReplacePackagesInSoftwareSourceDetails'
    MultiDisplayNameNotEqualToQueryParam:
      description: A multi filter to return resources that do not contains the given display names.
      in: query
      name: displayNameNotEqualTo
      x-default-description: 'null'
      style: form
      explode: true
      schema:
        type: array
        items:
          format: x-obmcs-ascii-identifier
          maxLength: 255
          minLength: 1
          type: string
        maxItems: 5
        uniqueItems: true
    AvailabilityAnywhereQueryParam:
      description: The availability of the software source. Use this query parameter to filter across availabilities in different environments.
      in: query
      name: availabilityAnywhere
      required: false
      x-default-description: 'null'
      style: form
      explode: true
      schema:
        type: array
        items:
          enum:
          - AVAILABLE
          - SELECTED
          - RESTRICTED
          - UNAVAILABLE
          type: string
          x-obmcs-top-level-enum: '#/definitions/Availability'
    VendorNameQueryParam:
      description: A filter to return only resources that match the given vendor name.
      in: query
      name: vendorName
      x-default-description: 'null'
      x-obmcs-top-level-enum: '#/definitions/VendorName'
      schema:
        type: string
        enum:
        - ORACLE
        - MICROSOFT
        - CANONICAL
    MultiClassificationTypeQueryParam:
      description: A filter to return only packages that match the given update classification type.
      in: query
      name: classificationType
      x-default-description: 'null'
      style: form
      explode: true
      schema:
        type: array
        items:
          enum:
          - SECURITY
          - BUGFIX
          - ENHANCEMENT
          - OTHER
          type: string
          x-obmcs-top-level-enum: '#/definitions/ClassificationTypes'
        maxItems: 5
        uniqueItems: true
    MultiArchTypeQueryParam:
      description: A filter to return only instances whose architecture type matches the given architecture.
      in: query
      name: archType
      required: false
      x-default-description: 'null'
      style: form
      explode: true
      schema:
        type: array
        items:
          enum:
          - X86_64
          - AARCH64
          - I686
          - NOARCH
          - SRC
          - I386
          - AMD64
          - ARM64
          - ALL
          type: string
          x-obmcs-top-level-enum: '#/definitions/ArchType'
        maxItems: 5
        uniqueItems: true
    RemovePackagesFromSoftwareSourceDetailsParam:
      description: A list of packages to be removed from the software source.
      in: body
      name: RemovePackagesFromSoftwareSourceDetails
      required: true
      schema:
        $ref: '#/components/schemas/RemovePackagesFromSoftwareSourceDetails'
    RetryTokenHeader:
      description: 'A token that uniquely identifies a request so it can be retried in case of a timeout or

        server error without risk of executing that same action again. Retry tokens expire after 24

        hours, but can be invalidated before then due to conflicting operations. For example, if a resource

        has been deleted and purged from the system, then a retry of the original creation request

        might be rejected.

        '
      in: header
      name: opc-retry-token
      required: false
      schema:
        type: string
        maxLength: 64
        minLength: 1
    SoftwareSourceSortByQueryParamVendor:
      description: 'The field to sort software source vendors by. Only one sort order may be provided. Default order for name is ascending.

        '
      in: query
      name: sortBy
      schema:
        type: string
        enum:
        - name
        default: name
    SoftwareSourceIdPathParam:
      description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the software source.
      in: path
      name: softwareSourceId
      required: true
      schema:
        type: string
    SoftwareSourceSortByQueryParamPackage:
      description: 'The field to sort packages by. Only one sort order may be provided. Default order for displayName is ascending. If no value is specified displayName is default.

        '
      in: query
      name: sortBy
      schema:
        type: string
        enum:
        - displayName
        default: displayName
    OptionalSoftwareSourceIdQueryParam:
      description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for the software source.
      in: query
      name: softwareSourceId
      required: false
      schema:
        type: string
    ErratumNameQueryParam:
      description: 'The assigned erratum name. It''s unique and not changeable.


        Example: `ELSA-2020-5804`

        '
      in: query
      name: name
      required: false
      x-default-description: 'null'
      style: form
      explode: true
      schema:
        type: array
        items:
          type: string
        maxItems: 51
    MultiSoftwareSourceLifecycleStateQueryParam:
      description: A filter to return only software sources whose state matches the given state.
      in: query
      name: lifecycleState
      required: false
      style: form
      explode: true
      schema:
        type: array
        items:
          type: string
          x-default-description: 'null'
          x-obmcs-enumref: '#/definitions/SoftwareSource/lifecycleState'
        uniqueItems: true
    CompartmentIdQueryParam:
      description: The OCID of the compartment that contains the resources to list. This filter returns only resources contained within the specified compartment.
      in: query
      name: compartmentId
      x-default-description: 'null'
      schema:
        type: string
    SoftwareSourceSortByQueryParamEntitlements:
      description: 'The field to sort entitlements by. Only one sort order may be provided.

        '
      in: query
      name: sortBy
      schema:
        type: string
        enum:
        - csi
        - vendorName
        default: vendorName
    SoftwareSourceTypeQueryParam:
      description: The type of the software source.
      in: query
      name: softwareSourceType
      required: false
      x-default-description: 'null'
      style: form
      explode: true
      schema:
        type: array
        items:
          enum:
          - VENDOR
          - CUSTOM
          - VERSIONED
          - PRIVATE
          - THIRD_PARTY
          type: string
          x-obmcs-top-level-enum: '#/definitions/SoftwareSourceType'
        maxItems: 10
    PaginationLimitQueryParam:
      description: 'For list pagination. The maximum number of results per page, or items to return in a paginated "List" call.

        For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).


        Example: `50`

        '
      in: query
      name: limit
      schema:
        type: integer
        default: 10
        maximum: 100
        minimum: 1
    ErratumNameContainsQueryParam:
      description: A filter to return resources that may partially match the erratum name given.
      in: query
      name: nameContains
      required: false
      x-default-description: 'null'
      schema:
        type: string
    AddPackagesToSoftwareSourceDetailsParam:
      description: A list of packages to be added to the software source.
      in: body
      name: AddPackagesToSoftwareSourceDetails
      required: true
      schema:
        $ref: '#/components/schemas/AddPackagesToSoftwareSourceDetails'
  responses:
    default:
      description: Unknown Error
      headers:
        opc-request-id:
          description: 'Unique Oracle-assigned identifier for the request. If you need to contact

            Oracle about a particular request, please provide the request ID.

            '
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
x-anchors:
  x-headers:
    etag:
      description: 'For optimistic concurrency control. See `if-match`.

        '
      type: string
    opc-next-page:
      description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

        '
      type: string
    opc-request-id:
      description: 'Unique Oracle-assigned identifier for the request. If you need to contact

        Oracle about a particular request, please provide the request ID.

        '
      type: string
    opc-total-items:
      description: 'The total number of items in the result. Used for pagination of a list of items.

        '
      type: integer
    opc-work-request-id:
      description: 'Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status.

        '
      type: string
    retry-after:
      description: A decimal number representing the number of seconds the client should wait before polling this endpoint again.
      type: integer
  x-properties:
    definedTags:
      additionalProperties:
        additionalProperties:
          description: 'The value of the tag. Only the String type is supported.

            '
          type: object
        description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.

          Example: `{"CostCenter": "42"}`

          '
        type: object
      description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.

        For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).

        Example: `{"Operations": {"CostCenter": "42"}}`

        '
      type: object
    freeformTags:
      additionalProperties:
        type: string
      description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.

        For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).

        Example: `{"Department": "Finance"}`

        '
      type: object
    systemTags:
      additionalProperties:
        additionalProperties:
          description: 'The value of the tag. Only string type is supported.

            '
          type: object
        description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.

          Example: `{"bar-key": "value"}`

          '
        type: object
      description: 'System tags for this resource. Each key is predefined and scoped to a namespace.

        Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`

        '
      type: object
x-obmcs-client-retries-enabled: true
x-oracle-package: com.oracle.oci.osmh.api