.. raw:: html
Product Listing
===============
.. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted
Product listings define a marketing page in the Ecosystem Catalog. It allows you to group repos and showcase what they accomplish together as an application. In the case of operators, your CSV file populates OperatorHub, which can only be viewed in cluster through OpenShift. Your product listing is publicly visible in the Ecosystem Catalog so anyone can know that it is offered.
.. tab-set::
.. tab-item:: Fields
.. div::
:name: ``category``
``category`` | String
.. dropdown:: String parameters
:animate: fade-in
``enum`` software | hardware
.. div::
:name: ``cert_projects``
``cert_projects`` | UniqueList[:doc:`/scalars/ObjectID`]
.. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted
List of unique identifiers for the certification project.
.. div::
:name: ``contacts``
``contacts`` | List[:doc:`/objects/ContactsItems`]
.. dropdown:: List parameters
:animate: fade-in
``min_items`` | 1
``max_items`` | 10
.. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted
List of contacts for the product listing. This field is required when the product listing is published.
.. div::
:name: ``descriptions``
``descriptions`` | :doc:`Descriptions`
.. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted
This field is required when the product listing is published.
.. div::
:name: ``drupal_company_id``
``drupal_company_id`` | Integer :bdg-primary-line:`read-only`
.. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted
Company node ID from Red Hat Connect. Read only.
.. div::
:name: ``faqs``
``faqs`` | List[:doc:`/objects/FAQSItems`] :bdg-warning-line:`nullable`
.. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted
FAQ section for the catalog page.
.. div::
:name: ``features``
``features`` | List[:doc:`/objects/FeaturesItems`] :bdg-warning-line:`nullable`
.. dropdown:: List parameters
:animate: fade-in
``max_items`` | 6
.. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted
Features section for the catalog page.
.. div::
:name: ``focus_product``
``focus_product`` | :doc:`/scalars/Boolean` :bdg-primary-line:`read-only`
.. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted
Indicates if the listing is eligible to be featured in Catalog.
.. div::
:name: ``functional_categories``
``functional_categories`` | List[:doc:`/scalars/String`]
.. dropdown:: List parameters
:animate: fade-in
``min_items`` | 1
``max_items`` | 3
``enum:`` AI/ML | Analytics | App dev | App modernization | Automation | Backup & Recovery | Cloud | Compute | Content management | Data management | Developer tools | DevOps | Edge | Infrastructure | IT & management tools | Migration | Networking | Observability | Orchestration | OS & platforms | Security | Storage | Virtualization
.. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted
This field is required when the product listing is published.
.. div::
:name: ``helm_chart``
``helm_chart`` | :doc:`ProductListingHelmChart` :bdg-primary-line:`read-only`
.. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted
Information related to helm chart product listing.
.. div::
:name: ``legal``
``legal`` | :doc:`Legal`
.. div::
:name: ``linked_resources``
``linked_resources`` | List[:doc:`/objects/LinkedResourcesItems`]
.. dropdown:: List parameters
:animate: fade-in
``min_items`` | 3
``max_items`` | 8
.. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted
This field is required when the product listing is published.
.. div::
:name: ``logo``
``logo`` | :doc:`Logo`
.. div::
:name: ``name``
``name`` | String
.. 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
This field is required when the product listing is published.
.. div::
:name: ``published_history``
``published_history`` | :doc:`FieldHistoryBoolean` :bdg-primary-line:`read-only`
.. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted
Tracks history for the `published` field
.. div::
:name: ``published``
``published`` | :doc:`/scalars/Boolean`
.. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted
This field is required when the product listing is published.
.. div::
:name: ``deleted``
``deleted`` | :doc:`/scalars/Boolean`
.. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted
Flag determining if product listing is considered to be deleted. Product listing can be deleted only if it is not published. Value is set to False by default.
.. div::
:name: ``quick_start_configuration``
``quick_start_configuration`` | :doc:`QuickStartConfiguration`
.. div::
:name: ``repositories``
``repositories`` | UniqueList[:doc:`/scalars/ObjectID`]
.. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted
List of unique identifiers for the repository.
.. div::
:name: ``search_aliases``
``search_aliases`` | List[:doc:`/objects/SearchAliasesItems`]
.. dropdown:: List parameters
:animate: fade-in
``max_items`` | 5
.. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted
List of search aliases for Solr.
.. div::
:name: ``support``
``support`` | :doc:`Support`
.. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted
This field is required when the product listing is published.
.. div::
:name: ``target_platforms``
``target_platforms`` | List[:doc:`/scalars/String`] :bdg-primary-line:`read-only`
.. dropdown:: List parameters
:animate: fade-in
``enum:`` Red Hat Enterprise Linux | Red Hat OpenShift | Red Hat OpenStack Platform | None
.. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted
List of target platforms for the product listing.
.. div::
:name: ``type``
``type`` | String
.. dropdown:: String parameters
:animate: fade-in
``enum`` container stack | traditional application | openstack infrastructure
.. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted
This field is required when the product listing is published.
.. div::
:name: ``vendor_label``
``vendor_label`` | String :bdg-primary-line:`read-only`
.. div::
:name: ``operator_bundles``
``operator_bundles`` | List[:doc:`/objects/OperatorBundlesItems`] :bdg-primary-line:`read-only`
.. div::
:name: ``certification_badges``
``certification_badges`` | List[:doc:`/scalars/String`] :bdg-warning-line:`nullable`:bdg-primary-line:`read-only`
.. dropdown:: List parameters
:animate: fade-in
``max_items`` | 2
``enum:`` cni | csi | cnf | vnf | virt
.. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted
Special certifications specific to the certification platform. The value is given by attached certification projects which are published.
.. div::
:name: ``certification_badges_all``
``certification_badges_all`` | List[:doc:`/scalars/String`] :bdg-warning-line:`nullable`:bdg-primary-line:`read-only`
.. dropdown:: List parameters
:animate: fade-in
``max_items`` | 2
``enum:`` cni | csi | cnf | vnf | virt
.. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted
Special certifications specific to the certification platform. The value is given by all attached certification projects with any certification_level.
.. div::
:name: ``certification_badges_exclude``
``certification_badges_exclude`` | List[:doc:`/scalars/String`] :bdg-warning-line:`nullable`:bdg-primary-line:`read-only`
.. dropdown:: List parameters
:animate: fade-in
``enum:`` cni | csi | cnf | vnf | virt
.. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted
List of badges disabled for given product. This field is taken into account when synchronizing badges from certification projects.
.. div::
:name: ``certification_level_history``
``certification_level_history`` | :doc:`FieldHistoryString` :bdg-primary-line:`read-only`
.. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted
Tracks history for the `certification_level` field
.. div::
:name: ``certification_level``
``certification_level`` | String :bdg-warning-line:`nullable`:bdg-primary-line:`read-only`
.. dropdown:: String parameters
:animate: fade-in
``enum`` Red Hat | Certified | Vendor validated | Vendor validated and certified
.. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted
The product listing content can be certified on several levels. This field determines whether the content was certified by Red Hat itself, by an ISV partner who followed official Red Hat certification, or by vendor validation.
.. div::
:name: ``industries``
``industries`` | UniqueList[:doc:`/scalars/String`] :bdg-warning-line:`nullable`:bdg-primary-line:`read-only`
.. dropdown:: UniqueList parameters
:animate: fade-in
``enum:`` Telecommunications | Automotive | Construction | Education | Energy | Financial services | Government | Healthcare | Hospitality | IT consulting & services | Logistics & transportation | Manufacturing | Media & entertainment | Retail | Technology | Utilities
.. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted
List of industries to which the product listing belongs.
.. div::
:name: ``deployed_as``
``deployed_as`` | UniqueList[:doc:`/scalars/String`] :bdg-warning-line:`nullable`:bdg-primary-line:`read-only`
.. dropdown:: UniqueList parameters
:animate: fade-in
``enum:`` Helm chart | Operator
.. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted
Determine a way how a product is deployed, based only on published projects.
.. div::
:name: ``deployed_as_all``
``deployed_as_all`` | UniqueList[:doc:`/scalars/String`] :bdg-warning-line:`nullable`:bdg-primary-line:`read-only`
.. dropdown:: UniqueList parameters
:animate: fade-in
``enum:`` Helm chart | Operator
.. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted
Determine a way how a product is deployed, based on all projects with any certification_status.
.. div::
:name: ``last_published_certification_date``
``last_published_certification_date`` | :doc:`/scalars/DateTime` :bdg-primary-line:`read-only`
.. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted
Reflects the date when the last certification event happened for published product (eg. attached certification project is published, new image is published, helm chart released)
.. div::
:name: ``functional_info``
``functional_info`` | :doc:`PublicProductListingFunctionalInfo`
.. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted
Field resolves PublicProductListingFunctionalInfo in federated schema. It is used to provide information about the product listing functional certification.
.. div::
:name: ``product_validations_data``
``product_validations_data`` | :doc:`ProductValidationsData` :bdg-warning-line:`nullable`:bdg-primary-line:`read-only`
.. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted
Data about all related approved Red Hat validations.
.. div::
:name: ``org_id``
``org_id`` | Integer :bdg-warning-line:`nullable`:bdg-primary-line:`read-only`
.. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted
Red Hat Org ID / account_id from Red Hat SSO. Also corresponds to company_org_id in Red Hat Connect.
.. 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:: Links
.. div::
:name: ``vendor``
``vendor`` | :doc:`/endpoints/RESTGetVendorByOrgId`
.. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted
URI to the vendor of the product listing.
.. tab-item:: Indexes
.. div::
:name: ``productListing_org_id_deleted``
``productListing_org_id_deleted``
.. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted
Fields
- ``org_id: ASC``
- ``deleted: ASC``
.. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted
Description
| This index is used to find product listings by org id and deleted flag.
|
.. div::
:name: ``productListing_cert_projects``
``productListing_cert_projects``
.. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted
Fields
- ``cert_projects: ASC``
.. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted
Description
| This index is used to find product listings by attached certification projects.
|
.. div::
:name: ``productListing_team_id``
``productListing_team_id``
.. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted
Fields
- ``team_id: ASC``
.. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted
Description
| This index is used to find product listings by team id.
|
.. div::
:name: ``productListing_name``
``productListing_name``
.. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted
Fields
- ``name: ASC``
.. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted
Description
| This index is used to find product listings by its name.
|
.. div::
:name: ``productListing_vendor_label``
``productListing_vendor_label``
.. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted
Fields
- ``vendor_label: ASC``
.. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted
Description
| This index is used to find product listings by its vendor label.
|
.. tab-item:: Edges
.. div::
:name: ``edges.vendor``
``edges.vendor`` | :doc:`ContainerVendor`
.. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted
Vendor associated with the product listing.
.. dropdown:: Example queries
:animate: fade-in
.. raw:: html
{
find_vendor_product_listings_by_org_id(org_id: 42, sort_by: [{ field: "creation_date", order: DESC }], page: 0, page_size: 50) {
error {
detail
status
}
total # omit for better performance
page_size
page
data {
_id
edges {
vendor {
error {
status
detail
}
data {
_id
}
}
}
}
}
}
{
find_vendor_product_listings_by_label(label: "example", sort_by: [{ field: "creation_date", order: DESC }], page: 0, page_size: 50) {
error {
detail
status
}
total # omit for better performance
page_size
page
data {
_id
edges {
vendor {
error {
status
detail
}
data {
_id
}
}
}
}
}
}
{
find_certification_projects_product_listings(id: "6304c560cbb2b2d2d4053b8e", sort_by: [{ field: "creation_date", order: DESC }], page: 0, page_size: 50) {
error {
detail
status
}
total # omit for better performance
page_size
page
data {
_id
edges {
vendor {
error {
status
detail
}
data {
_id
}
}
}
}
}
}
{
find_product_listings(sort_by: [{ field: "creation_date", order: DESC }], page: 0, page_size: 50) {
error {
detail
status
}
total # omit for better performance
page_size
page
data {
_id
edges {
vendor {
error {
status
detail
}
data {
_id
}
}
}
}
}
}
{
get_product_listing(id: "6304c560cbb2b2d2d4053b8e") {
error {
detail
status
}
data {
_id
edges {
vendor {
error {
status
detail
}
data {
_id
}
}
}
}
}
}
{
find_repository_product_listings(id: "6304c560cbb2b2d2d4053b8e", sort_by: [{ field: "creation_date", order: DESC }], page: 0, page_size: 50) {
error {
detail
status
}
total # omit for better performance
page_size
page
data {
_id
edges {
vendor {
error {
status
detail
}
data {
_id
}
}
}
}
}
}
{
find_repository_product_listings_by_registry_path(registry: "example", repository: "example", sort_by: [{ field: "creation_date", order: DESC }], page: 0, page_size: 50) {
error {
detail
status
}
total # omit for better performance
page_size
page
data {
_id
edges {
vendor {
error {
status
detail
}
data {
_id
}
}
}
}
}
}
{
find_product_listings_by_name_org_id(org_id: 42, sort_by: [{ field: "creation_date", order: DESC }], page: 0, page_size: 50, name: "example") {
error {
detail
status
}
total # omit for better performance
page_size
page
data {
_id
edges {
vendor {
error {
status
detail
}
data {
_id
}
}
}
}
}
}
{
product_listing(id: "6304c560cbb2b2d2d4053b8e") {
error {
detail
status
}
data {
_id
edges {
vendor {
error {
status
detail
}
data {
_id
}
}
}
}
}
}
{
product_listings(sort_by: [{ field: "creation_date", order: DESC }], page: 0, page_size: 50) {
error {
detail
status
}
total # omit for better performance
page_size
page
data {
_id
edges {
vendor {
error {
status
detail
}
data {
_id
}
}
}
}
}
}