.. 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 Package
================

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

    



.. tab-set::
    .. tab-item:: Fields
        
        .. div::
            :name: ``association``
        
        ``association`` | String  :bdg-danger:`required` 



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

            

        

        
        .. div::
            :name: ``package_name``
        
        ``package_name`` | String  :bdg-danger:`required` 


        .. dropdown:: String parameters
            :animate: fade-in

            ``min_length`` | 1
            ``max_length`` | 100
            

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

            

        

        
        .. div::
            :name: ``source``
        
        ``source`` | String  :bdg-danger:`required` 


        .. dropdown:: String parameters
            :animate: fade-in

            ``enum`` certified-operators | upstream-community-operators | community-operators | redhat-operators | redhat-marketplace

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

            

        

        
        .. 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: ``association_1_source_1``

            ``association_1_source_1``

            .. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted
            Fields
                - ``association: ASC``
                - ``source: ASC``

            

            .. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted
            Description
                | This index is used to find operator package by association and source.
                |
            .. div::
                :name: ``package_name_1``

            ``package_name_1``

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

            

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

        

    
    .. tab-item:: Edges


        
        .. div::
            :name: ``edges.operator_bundle``

        
        

        ``edges.operator_bundle`` | List[:doc:`OperatorBundle`]

        
        

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

             Edge to related operator bundles.

        

        

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

             Parent arguments: ['package_name']

        

        

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

             Uses GQL query: find_operator_bundles

        

        .. dropdown:: Example queries
            :animate: fade-in

            .. raw:: html

                <select class="div-selector" id="edges.operator_bundle">
                
                <option value=get_operator_package> get_operator_package </option>
                <option value=find_operator_packages> find_operator_packages </option>
                </select>

                
                <div class="highlight query-div" id="edges.operator_bundle_get_operator_package"><pre>
                {
                    get_operator_package(id: "6304c560cbb2b2d2d4053b8e") {
                        error {
                            detail
                            status
                        }
                        data {
                            _id
                            edges {
                                operator_bundle {
                                    error {
                                        status
                                        detail
                                    }
                                    data {
                                        _id
                                    }
                                }
                            }
                        }
                    }
                }
                </pre></div>
                <div class="highlight query-div" id="edges.operator_bundle_find_operator_packages"><pre>
                {
                    find_operator_packages(page: 0, page_size: 50, sort_by: [{ field: "creation_date", order: DESC }]) {
                        error {
                            detail
                            status
                        }
                        total # omit for better performance
                        page_size
                        page
                        data {
                            _id
                            edges {
                                operator_bundle {
                                    error {
                                        status
                                        detail
                                    }
                                    data {
                                        _id
                                    }
                                }
                            }
                        }
                    }
                }
                </pre></div>
    

    

    .. tab-item:: Usage

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

            

            - :doc:`GET - /operators/packages/id/{identifier} </endpoints/RESTGetOperatorPackage>`

            - :doc:`GET - /operators/packages </endpoints/RESTGetOperatorPackages>`

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

            

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

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