.. raw:: html
Certification Project Image Request
===================================
.. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted
Contain status and related metadata of a certProject image request.
.. tab-set::
.. tab-item:: Fields
.. div::
:name: ``operation``
``operation`` | String :bdg-danger:`required`
.. dropdown:: String parameters
:animate: fade-in
``enum`` publish | unpublish | sync-tags | delete | publish-manifest-list | unpublish-manifest-list | delete-manifest-list
.. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted
Operation performed during the image request. Operations containing 'manifest-list' can be performed only when manifest_list_digest is defined. Other operations can be combined only with image_id.
.. div::
:name: ``cert_project``
``cert_project`` | :doc:`/scalars/ObjectID` :bdg-primary-line:`read-only`
.. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted
Unique identifier for the certification project.
.. div::
:name: ``image_id``
``image_id`` | :doc:`/scalars/ObjectID`
.. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted
Container image id associated with the image request. When defined, manifest_list_digest is forbidden.
.. div::
:name: ``images``
``images`` | List[:doc:`/objects/SingleArchImage`]
.. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted
Images referenced by the manifest_list_digest.
.. div::
:name: ``manifest_list_digest``
``manifest_list_digest`` | String
.. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted
Manifest list digest for multi-arch images. When defined, image_id is forbidden.
.. 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.
.. 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: ``status``
``status`` | String :bdg-primary-line:`read-only`
.. dropdown:: String parameters
:animate: fade-in
``enum`` pending | in progress | failed | completed | aborted
.. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted
The request status
.. div::
:name: ``status_message``
``status_message`` | String :bdg-primary-line:`read-only`
.. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted
An explanatory message to a request status.
.. tab-item:: Links
.. div::
:name: ``cert_project``
``cert_project`` | :doc:`/endpoints/RESTGetCertProjectById`
.. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted
URI to the certification project related to this image request.
.. div::
:name: ``image``
``image`` | :doc:`/endpoints/RESTGetImage`
.. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted
URI to the container image.
.. tab-item:: Indexes
.. div::
:name: ``image_id_1``
``image_id_1``
.. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted
Fields
- ``image_id: ASC``
.. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted
Description
| Index for certProjectImageRequest based on the image_id field
|
.. div::
:name: ``status_1_creation_date_-1``
``status_1_creation_date_-1``
.. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted
Fields
- ``status: ASC``
- ``creation_date: DESC``
.. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted
Description
| Index for certProjectImageRequest based on the status and creation_date (descending) field
|
.. div::
:name: ``cert_project_1_org_id_1``
``cert_project_1_org_id_1``
.. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted
Fields
- ``cert_project: ASC``
- ``org_id: ASC``
.. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted
Description
| Index for certProjectImageRequest based on the cert_project and org_id field
|
.. tab-item:: Edges
.. div::
:name: ``edges.cert_project``
``edges.cert_project`` | :doc:`CertificationProject`
.. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted
Edge to related certification project.
.. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted
Parent arguments: ['cert_project']
.. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted
Uses GQL query: get_certification_project
.. dropdown:: Example queries
:animate: fade-in
.. raw:: html
{
get_certification_image_request_by_id(id: "6304c560cbb2b2d2d4053b8e") {
error {
detail
status
}
data {
_id
edges {
cert_project {
error {
status
detail
}
data {
_id
}
}
}
}
}
}
{
get_certification_image_requests(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 {
cert_project {
error {
status
detail
}
data {
_id
}
}
}
}
}
}
{
get_certification_image_requests_by_cert_project_id(id: "6304c560cbb2b2d2d4053b8e", 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 {
cert_project {
error {
status
detail
}
data {
_id
}
}
}
}
}
}
{
get_certification_image_requests_by_image_id(id: "6304c560cbb2b2d2d4053b8e", 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 {
cert_project {
error {
status
detail
}
data {
_id
}
}
}
}
}
}
{
get_certification_image_request_by_id(id: "6304c560cbb2b2d2d4053b8e") {
error {
detail
status
}
data {
_id
edges {
image {
error {
status
detail
}
data {
_id
}
}
}
}
}
}
{
get_certification_image_requests(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 {
image {
error {
status
detail
}
data {
_id
}
}
}
}
}
}
{
get_certification_image_requests_by_cert_project_id(id: "6304c560cbb2b2d2d4053b8e", 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 {
image {
error {
status
detail
}
data {
_id
}
}
}
}
}
}
{
get_certification_image_requests_by_image_id(id: "6304c560cbb2b2d2d4053b8e", 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 {
image {
error {
status
detail
}
data {
_id
}
}
}
}
}
}
{
get_certification_image_request_by_id(id: "6304c560cbb2b2d2d4053b8e") {
error {
detail
status
}
data {
_id
images {
edges {
container_image {
error {
status
detail
}
data {
_id
}
}
}
}
}
}
}
{
get_certification_image_requests(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
images {
edges {
container_image {
error {
status
detail
}
data {
_id
}
}
}
}
}
}
}
{
get_certification_image_requests_by_cert_project_id(id: "6304c560cbb2b2d2d4053b8e", 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
images {
edges {
container_image {
error {
status
detail
}
data {
_id
}
}
}
}
}
}
}
{
get_certification_image_requests_by_image_id(id: "6304c560cbb2b2d2d4053b8e", 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
images {
edges {
container_image {
error {
status
detail
}
data {
_id
}
}
}
}
}
}
}