.. raw:: html
Container Vendor
================
.. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted
Stores information about a Vendor
.. tab-set::
.. tab-item:: Fields
.. div::
:name: ``published``
``published`` | :doc:`/scalars/Boolean` :bdg-danger:`required` :bdg-primary-line:`read-only`
.. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted
Indicate that the vendor has been published.
.. div::
:name: ``allow_hosted_container_registry``
``allow_hosted_container_registry`` | :doc:`/scalars/Boolean` :bdg-primary-line:`read-only`
.. div::
:name: ``company_url``
``company_url`` | :doc:`/scalars/URI` :bdg-primary-line:`read-only`
.. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted
URL to the vendor's main website.
.. div::
:name: ``contact``
``contact`` | :doc:`ContainerVendorContact` :bdg-primary-line:`read-only`
.. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted
General contact information for the vendor, to be displayed on the vendor page on RHCC.
.. div::
:name: ``description``
``description`` | String :bdg-primary-line:`read-only`
.. div::
:name: ``mdm_id``
``mdm_id`` | String :bdg-primary-line:`read-only`
.. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted
MDM (Master Data Management) identifier.
.. 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.
.. div::
:name: ``industries``
``industries`` | List[:doc:`/scalars/String`] :bdg-primary-line:`read-only`
.. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted
The industry / vertical the vendor belongs to.
.. div::
:name: ``label``
``label`` | String
.. dropdown:: String parameters
:animate: fade-in
``min_length`` | 1
``max_length`` | 255
.. div::
:name: ``label_locked``
``label_locked`` | :doc:`/scalars/Boolean` :bdg-primary-line:`read-only`
.. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted
A flag that determines if vendor label can be changed.
.. div::
:name: ``logo_url``
``logo_url`` | :doc:`/scalars/URI` :bdg-primary-line:`read-only`
.. div::
:name: ``name``
``name`` | String :bdg-primary-line:`read-only`
.. dropdown:: String parameters
:animate: fade-in
``min_length`` | 1
``max_length`` | 255
.. div::
:name: ``object_type``
``object_type`` | String :bdg-primary-line:`read-only`
.. dropdown:: String parameters
:animate: fade-in
``constant`` | containerVendor
.. div::
:name: ``registry_urls``
``registry_urls`` | List[:doc:`/scalars/String`] :bdg-primary-line:`read-only`
.. div::
:name: ``rss_feed_url``
``rss_feed_url`` | :doc:`/scalars/URI` :bdg-warning-line:`nullable`:bdg-primary-line:`read-only`
.. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted
RSS feed for vendor.
.. div::
:name: ``service_account_token``
``service_account_token`` | String :bdg-warning-line:`nullable`:bdg-primary-line:`read-only`
.. dropdown:: String parameters
:animate: fade-in
``min_length`` | 1
.. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted
Token for outbound namespace for pulling published marketplace images.
.. div::
:name: ``social_media_links``
``social_media_links`` | List[:doc:`/objects/ContainerVendorSocialMediaLinks`] :bdg-primary-line:`read-only`
.. div::
:name: ``org_id``
``org_id`` | Integer :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: ``product_listings``
``product_listings`` | :doc:`/endpoints/RESTGetProductListingsForVendorByOrgId`
.. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted
URI to this vendor's product listings.
.. div::
:name: ``repositories``
``repositories`` | :doc:`/endpoints/RESTGetRepositoriesForVendorLabel`
.. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted
URI to this vendor's repositories.
.. tab-item:: Indexes
.. div::
:name: ``containerVendor_org_id``
``containerVendor_org_id``
.. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted
Fields
- ``org_id: ASC``
.. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted
Parameters
- ``unique: True``
.. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted
Description
| Index for containerVendor collection based on the org_id field
|
.. div::
:name: ``label_1``
``label_1``
.. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted
Fields
- ``label: ASC``
.. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted
Parameters
- ``unique: True``
- ``sparse: True``
.. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted
Description
| Index for containerVendor collection based on the label field.
|
.. tab-item:: Edges
.. div::
:name: ``edges.product_listings_org_id``
``edges.product_listings_org_id`` | List[:doc:`ProductListing`]
.. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted
Edge to related product listings by org_id.
.. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted
Parent arguments: ['org_id']
.. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted
Uses GQL query: find_vendor_product_listings_by_org_id
.. dropdown:: Example queries
:animate: fade-in
.. raw:: html
{
get_vendor(id: "6304c560cbb2b2d2d4053b8e") {
error {
detail
status
}
data {
_id
edges {
product_listings_org_id {
error {
status
detail
}
data {
_id
}
}
}
}
}
}
{
get_vendor_by_org_id(org_id: 42) {
error {
detail
status
}
data {
_id
edges {
product_listings_org_id {
error {
status
detail
}
data {
_id
}
}
}
}
}
}
{
get_vendor_by_label(label: "example") {
error {
detail
status
}
data {
_id
edges {
product_listings_org_id {
error {
status
detail
}
data {
_id
}
}
}
}
}
}
{
get_repository_vendor_by_registry_path(registry: "example", repository: "example") {
error {
detail
status
}
data {
_id
edges {
product_listings_org_id {
error {
status
detail
}
data {
_id
}
}
}
}
}
}
{
get_vendor(id: "6304c560cbb2b2d2d4053b8e") {
error {
detail
status
}
data {
_id
edges {
product_listings_label {
error {
status
detail
}
data {
_id
}
}
}
}
}
}
{
get_vendor_by_org_id(org_id: 42) {
error {
detail
status
}
data {
_id
edges {
product_listings_label {
error {
status
detail
}
data {
_id
}
}
}
}
}
}
{
get_vendor_by_label(label: "example") {
error {
detail
status
}
data {
_id
edges {
product_listings_label {
error {
status
detail
}
data {
_id
}
}
}
}
}
}
{
get_repository_vendor_by_registry_path(registry: "example", repository: "example") {
error {
detail
status
}
data {
_id
edges {
product_listings_label {
error {
status
detail
}
data {
_id
}
}
}
}
}
}
{
get_vendor(id: "6304c560cbb2b2d2d4053b8e") {
error {
detail
status
}
data {
_id
edges {
certification_projects {
error {
status
detail
}
data {
_id
}
}
}
}
}
}
{
get_vendor_by_org_id(org_id: 42) {
error {
detail
status
}
data {
_id
edges {
certification_projects {
error {
status
detail
}
data {
_id
}
}
}
}
}
}
{
get_vendor_by_label(label: "example") {
error {
detail
status
}
data {
_id
edges {
certification_projects {
error {
status
detail
}
data {
_id
}
}
}
}
}
}
{
get_repository_vendor_by_registry_path(registry: "example", repository: "example") {
error {
detail
status
}
data {
_id
edges {
certification_projects {
error {
status
detail
}
data {
_id
}
}
}
}
}
}
{
get_vendor(id: "6304c560cbb2b2d2d4053b8e") {
error {
detail
status
}
data {
_id
edges {
repositories {
error {
status
detail
}
data {
_id
}
}
}
}
}
}
{
get_vendor_by_org_id(org_id: 42) {
error {
detail
status
}
data {
_id
edges {
repositories {
error {
status
detail
}
data {
_id
}
}
}
}
}
}
{
get_vendor_by_label(label: "example") {
error {
detail
status
}
data {
_id
edges {
repositories {
error {
status
detail
}
data {
_id
}
}
}
}
}
}
{
get_repository_vendor_by_registry_path(registry: "example", repository: "example") {
error {
detail
status
}
data {
_id
edges {
repositories {
error {
status
detail
}
data {
_id
}
}
}
}
}
}