action bluemix_get_images_name_or_id_json {
  label: "Inspect a Docker image in private Bluemix registry"
  description: "This endpoint returns detailed information about a Docker image that is stored in the private Bluemix registry of an organization (corresponding IBM Containers command: `cf ic inspect <image_name_or_id>`)."
  provider: bluemix
  method: GET
  path: "/images/{name_or_id}/json"
  encoding: json
  input: {
    type: "object"
    properties: {
      "X-Auth-Project-Id": {
        type: "string"
      }
      "X-Auth-Token": {
        type: "string"
      }
      name_or_id: {
        type: "string"
      }
    }
    required: ["X-Auth-Project-Id", "X-Auth-Token", "name_or_id"]
    additionalProperties: false
  }
  output: {
    type: "object"
    properties: {
      Architecture: {
        type: "string"
        description: "The hardware architecture for which the image was built for. The architecture can either be Intel (amd64) or Power (ppc64le). "
      }
      Config: {
        type: "object"
        properties: {
          ArgsEscaped: {
            type: "boolean"
          }
          AttachStderr: {
            type: "boolean"
            description: "Attaches the container to stderr."
          }
          AttachStdin: {
            type: "boolean"
            description: "Attaches the container to stdin."
          }
          AttachStdout: {
            type: "boolean"
            description: "Attaches the container to stdout."
          }
          Cmd: {
            type: "array"
            description: "The command and arguments in this list are passed to the container to be executed when the container is started. This command must be a long-running command. Do not use a short-lived command, for example, /bin/date, because it might cause the container to crash. <br>Sample long-running commands:<br>[\"ping\",\"localhost\"]<br>[\"tail\",\"-f\",\"/dev/null\"]<br>[\"sh\",\"-c\",\"while true; do date; sleep 20; done\"]\n"
            items: {
              type: "string"
            }
          }
          Domainmame: {
            type: "string"
            description: "The domain name to be used for the container."
          }
          Entrypoint: {
            type: "string"
            description: "The entrypoint specifies a command that will always be executed when the container starts."
          }
          Env: {
            type: "array"
            description: "A list of environment variables in the form of key=value pairs. All keys in this list have to be unique. List multiple keys separately and if you include quotation marks, include them around both the environment variable name and the value."
            items: {
              type: "string"
            }
          }
          ExposedPorts: {
            type: "array"
            description: "A list of all udp and tcp ports that have been publicly exposed during the container creation."
            items: {
              type: "string"
            }
          }
          Hostname: {
            type: "string"
            description: "The host name of the container provided by Openstack. "
          }
          Image: {
            type: "string"
            description: "The unique ID of the image. "
          }
          Labels: {
            type: "array"
            description: "List of custom metadata that was added to the image. Labels serve a wide range of uses, such as adding notes or license requirements to an image. Every label is a key/ value pair."
            items: {
              type: "string"
            }
          }
          OnBuild: {
            type: "array"
            description: "???"
            items: {
              type: "string"
            }
          }
          OpenStdin: {
            type: "boolean"
            description: "When set to true, it opens stdin."
          }
          StdinOnce: {
            type: "boolean"
            description: "When set to true it closes stdin after the attached client disconnects."
          }
          Tty: {
            type: "boolean"
            description: "When set to true, attach standard streams to a tty, including stdin if it is not closed."
          }
          User: {
            type: "string"
            description: "The user to be used inside the container."
          }
          Volumes: {
            type: "string"
            description: "Docker specific. Not supported by IBM Containers. The path to the volume that is created when deploying a container from the image. To use a volume in IBM Containers, you must first create a volume and then mount it to your container during creation."
          }
          WorkingDir: {
            type: "string"
            description: "The working directory inside the container where specified commands are executed."
          }
        }
      }
      Container: {
        type: "string"
        description: "???"
      }
      ContainerConfig: {
        properties: {
          ArgsEscaped: {
            type: "boolean"
          }
          AttachStderr: {
            type: "string"
            description: "Attaches the container to stderr."
          }
          AttachStdin: {
            type: "string"
            description: "Attaches the container to sdtin."
          }
          AttachStdout: {
            type: "string"
            description: "Attaches the container to stdout."
          }
          Cmd: {
            type: "array"
            description: "The command and arguments in this list are passed to the container to be executed when the container is started. This command must be a long-running command. Do not use a short-lived command, for example, /bin/date, because it might cause the container to crash. <br>Sample long-running commands:<br>[\"ping\",\"localhost\"]<br>[\"tail\",\"-f\",\"/dev/null\"]<br>[\"sh\",\"-c\",\"while true; do date; sleep 20; done\"]\n"
            items: {
              type: "string"
            }
          }
          Domainname: {
            type: "string"
            description: "The domain name to be used for the container."
          }
          Env: {
            type: "array"
            description: "A list of environment variables in the form of key=value pairs. All keys in this list have to be unique. List multiple keys separately and if you include quotation marks, include them around both the environment variable name and the value."
            items: {
              type: "string"
            }
          }
          ExposedPorts: {
            type: "array"
            description: "List of public ports that were exposed during container creation. "
            items: {
              type: "string"
            }
          }
          Hostname: {
            type: "string"
            description: "The host name to be used for the container."
          }
          Image: {
            type: "string"
            description: "Full path to the image that the container is based on in your private Bluemix registry."
          }
          ImageArchitecture: {
            type: "string"
            description: "The hardware architecture the image is based on. It can either be 'amd64' indicating an Intel-based architecture, or 'ppc64le' representing a Power-based architecture."
          }
          Labels: {
            type: "array"
            description: "List of custom metadata that was added to the container. Labels serve a wide range of uses, such as adding notes to a container. Every label is a key/ value pair."
            items: {
              type: "string"
            }
          }
          Memory: {
            type: "integer"
            format: "int32"
            description: "The amount of container memory that is assigned to the container in Megabyte."
          }
          MemorySwap: {
            type: "string"
            description: "The total container memory limit (memory + swap)"
          }
          OpenStdin: {
            type: "string"
            description: "When set to true, it opens stdin. "
          }
          PortSpecs: {
            type: "string"
            description: "Not supported by IBM Containers, empty string."
          }
          StdinOnce: {
            type: "string"
            description: "When set to true it closes stdin after the attached client disconnects."
          }
          Tty: {
            type: "string"
            description: "When set to true, attach standard streams to a tty, including stdin if it is not closed."
          }
          User: {
            type: "string"
            description: "User to be used inside the container."
          }
          VCPU: {
            type: "integer"
            format: "int32"
            description: "Number of virtual CPUs that are assigned to the container."
          }
          VolumesFrom: {
            type: "string"
            description: "List of volumes to inherit from another container. This feature is not supported in IBM Containers."
          }
          WorkingDir: {
            type: "string"
            description: "The working directory inside the container where specified commands are executed. "
          }
        }
      }
      Created: {
        type: "string"
        description: "The time when the image was created."
      }
      DockerVersion: {
        type: "string"
        description: "???"
      }
      Id: {
        type: "string"
        description: "Unique ID of the image that you inspected. "
      }
      Os: {
        type: "string"
        description: "???"
      }
      Parent: {
        type: "string"
        description: "The ID of the parent image that was used to build this image."
      }
      Size: {
        type: "integer"
        format: "int32"
        description: "The real size of the image. "
      }
      Tag: {
        type: "string"
        description: "The version of the image "
      }
      Throwaway: {
        type: "string"
        description: "???"
      }
      VirtualSize: {
        type: "integer"
        format: "int32"
        description: "The virtual size of the image."
      }
    }
  }
}