.. raw:: html

    <script type="module" src="../_static/js/object_tab_linker.js"> </script>
    <script type="module" src="../_static/js/query_example_selector.js"> </script>

Operator Index
==============

.. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted

    List of operator indices from which operator bundle metadata are extracted to operatorBundles collection.



.. tab-set::
    .. tab-item:: Fields
        
        .. div::
            :name: ``ocp_version``
        ``ocp_version`` | :doc:`/scalars/SemVer` 

        
        .. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted

            OCP version, e.g. 4.5.

        

        
        .. div::
            :name: ``organization``
        
        ``organization`` | String 



        
        .. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted

            Organization, as understood by iib, e.g. redhat-marketplace.

        

        
        .. div::
            :name: ``path``
        
        ``path`` | String 



        
        .. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted

            The docker path used to pull this index container, e.g. quay.io/foo/bar:v4.5.

        

        
        .. div::
            :name: ``end_of_life``
        
        ``end_of_life`` | :doc:`/scalars/DateTime` 



        
        .. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted

            The date till the index image is valid

        

        
        .. div::
            :name: ``_id``
        ``_id`` | :doc:`/scalars/ObjectID` :bdg-primary-line:`read-only`

        
        .. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted

            MongoDB unique _id

        

        
        .. div::
            :name: ``creation_date``
        
        ``creation_date`` | :doc:`/scalars/DateTime` :bdg-primary-line:`read-only`



        
        .. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted

            The date when the entry was created. Value is created automatically on creation.

        

        
        .. div::
            :name: ``last_update_date``
        
        ``last_update_date`` | :doc:`/scalars/DateTime` :bdg-primary-line:`read-only`



        
        .. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted

            The date when the entry was last updated.

        

        

    


    .. tab-item:: Indexes

        

            

            
            .. div::
                :name: ``operatorIndex_ocp_version``

            ``operatorIndex_ocp_version``

            .. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted
            Fields
                - ``ocp_version: DESC``

            

            .. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted
            Description
                | This index is used to find operator indices by OCP version.
                |
            .. div::
                :name: ``operatorIndex_organization_end_of_life``

            ``operatorIndex_organization_end_of_life``

            .. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted
            Fields
                - ``organization: ASC``
                - ``end_of_life: DESC``

            

            .. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted
            Description
                | This index is used to find operator indices by organization and end of life.
                |

        

    

    

    .. tab-item:: Usage

        .. dropdown:: Endpoints
            :animate: fade-in

            

            - :doc:`GET - /operators/indices/id/{identifier} </endpoints/RESTGetOperatorIndex>`

            - :doc:`GET - /operators/indices </endpoints/RESTGetOperatorIndexes>`

        .. dropdown:: Queries and Mutations
            :animate: fade-in

            

            - :doc:`get_operator_index </queries/get_operator_index>`

            - :doc:`find_operator_indices </queries/find_operator_indices>`