{"components":{"parameters":{"page":{"description":"Page index","examples":{"page":{"value":"1"}},"in":"query","name":"page","schema":{"type":"string"}},"size":{"description":"Number of items in each page","examples":{"size":{"value":"100"}},"in":"query","name":"size","schema":{"type":"string"}}},"schemas":{"AWSEC2CloneCompose":{"additionalProperties":false,"properties":{"region":{"type":"string"},"share_with_accounts":{"example":["123456789012"],"items":{"type":"string"},"type":"array"}},"required":["region"],"type":"object"},"AWSEC2UploadOptions":{"additionalProperties":false,"properties":{"region":{"example":"eu-west-1","type":"string"},"share_with_accounts":{"example":["123456789012"],"items":{"type":"string"},"type":"array"},"snapshot_name":{"example":"my-snapshot","type":"string"}},"required":["region","share_with_accounts"],"type":"object"},"AWSEC2UploadStatus":{"properties":{"ami":{"example":"ami-0c830793775595d4b","type":"string"},"region":{"example":"eu-west-1","type":"string"}},"required":["ami","region"],"type":"object"},"AWSS3UploadOptions":{"additionalProperties":false,"properties":{"public":{"default":false,"description":"If set to false (the default value), a long, obfuscated URL\nis returned. Its expiration might be sooner than for other upload\ntargets.\n\nIf set to true, a shorter URL is returned and\nits expiration is the same as for the other upload targets.\n","type":"boolean"},"region":{"example":"eu-west-1","type":"string"}},"required":["region"],"type":"object"},"AWSS3UploadStatus":{"properties":{"url":{"type":"string"}},"required":["url"],"type":"object"},"ArchitectureInfo":{"additionalProperties":false,"description":"Architecture metadata from images library","properties":{"image_types":{"additionalProperties":{"$ref":"#/components/schemas/ImageTypeInfo"},"description":"Map of image type names to their details","type":"object"},"name":{"description":"Architecture name","example":"x86_64","type":"string"}},"required":["name"],"type":"object"},"AzureUploadOptions":{"additionalProperties":false,"properties":{"hyper_v_generation":{"default":"V1","description":"Choose the VM Image HyperV generation, different features on Azure are available\ndepending on the HyperV generation.\n","enum":["V1","V2"],"type":"string"},"image_name":{"description":"Name of the uploaded image. It must be unique in the given resource group.\nIf name is omitted from the request, a random one based on a UUID is\ngenerated.\n","example":"my-image","type":"string"},"location":{"description":"Location of the provided resource_group, where the image should be uploaded and registered.\nHow to list all locations:\nhttps://docs.microsoft.com/en-us/cli/azure/account?view=azure-cli-latest#az_account_list_locations'\nIf the location is not specified, it is deducted from the provided resource_group.\n","example":"westeurope","type":"string"},"resource_group":{"description":"Name of the resource group where the image should be uploaded.\n","example":"ToucanResourceGroup","type":"string"},"subscription_id":{"description":"ID of subscription where the image should be uploaded.\n","example":"4e5d8b2c-ab24-4413-90c5-612306e809e2","type":"string"},"tenant_id":{"description":"ID of the tenant where the image should be uploaded.\nHow to find it in the Azure Portal:\nhttps://docs.microsoft.com/en-us/azure/active-directory/fundamentals/active-directory-how-to-find-tenant\n","example":"5c7ef5b6-1c3f-4da0-a622-0b060239d7d7","type":"string"}},"required":["tenant_id","subscription_id","resource_group"],"type":"object"},"AzureUploadStatus":{"properties":{"image_name":{"example":"my-image","type":"string"}},"required":["image_name"],"type":"object"},"Blueprint":{"additionalProperties":false,"properties":{"containers":{"description":"Container images to embed into the final artfact","items":{"$ref":"#/components/schemas/Container"},"type":"array"},"customizations":{"$ref":"#/components/schemas/BlueprintCustomizations"},"description":{"type":"string"},"distro":{"description":"The distribution to use for the compose. If left empty the host\ndistro will be used.\n","example":"fedora-39","type":"string"},"enabled_modules":{"items":{"$ref":"#/components/schemas/Module"},"type":"array"},"groups":{"description":"Package groups to be installed","items":{"$ref":"#/components/schemas/PackageGroup"},"type":"array"},"modules":{"description":"An alias for packages, retained for backwards compatability\n","items":{"$ref":"#/components/schemas/Package"},"type":"array"},"name":{"type":"string"},"packages":{"description":"Packages to be installed","items":{"$ref":"#/components/schemas/Package"},"type":"array"},"version":{"description":"A semver version number","example":"7.7.70","type":"string"}},"required":["name"],"type":"object"},"BlueprintCustomizations":{"additionalProperties":false,"properties":{"cacerts":{"$ref":"#/components/schemas/CACertsCustomization"},"directories":{"description":"Directories to create in the final artifact","items":{"$ref":"#/components/schemas/Directory"},"type":"array"},"disk":{"$ref":"#/components/schemas/Disk"},"dnf":{"$ref":"#/components/schemas/DNF"},"fdo":{"$ref":"#/components/schemas/FDO"},"files":{"description":"Files to create in the final artifact","items":{"$ref":"#/components/schemas/BlueprintFile"},"type":"array"},"filesystem":{"description":"List of filesystem mountpoints to create","items":{"$ref":"#/components/schemas/BlueprintFilesystem"},"type":"array"},"fips":{"description":"Enable FIPS mode","type":"boolean"},"firewall":{"$ref":"#/components/schemas/BlueprintFirewall"},"group":{"description":"List of groups to create","items":{"$ref":"#/components/schemas/Group"},"type":"array"},"hostname":{"description":"Configures the hostname","type":"string"},"ignition":{"$ref":"#/components/schemas/Ignition"},"installation_device":{"description":"Name of the installation device, currently only useful for the edge-simplified-installer type\n","example":"/dev/sda","type":"string"},"installer":{"$ref":"#/components/schemas/Installer"},"kernel":{"$ref":"#/components/schemas/Kernel"},"locale":{"$ref":"#/components/schemas/Locale"},"openscap":{"$ref":"#/components/schemas/BlueprintOpenSCAP"},"partitioning_mode":{"default":"auto-lvm","description":"Select how the disk image will be partitioned. 'auto-lvm' will use raw unless\nthere are one or more mountpoints in which case it will use LVM. 'lvm' always\nuses LVM, even when there are no extra mountpoints. 'raw' uses raw partitions\neven when there are one or more mountpoints.\n","enum":["raw","lvm","auto-lvm"],"type":"string"},"repositories":{"description":"Repositories to write to /etc/yum.repos.d/ in the final image. Note\nthat these are not used at build time.\n","items":{"$ref":"#/components/schemas/BlueprintRepository"},"type":"array"},"rhsm":{"$ref":"#/components/schemas/RHSMCustomization"},"rpm":{"$ref":"#/components/schemas/RPMCustomization"},"services":{"$ref":"#/components/schemas/Services"},"sshkey":{"description":"List of ssh keys","items":{"$ref":"#/components/schemas/SSHKey"},"type":"array"},"timezone":{"$ref":"#/components/schemas/Timezone"},"user":{"description":"List of users to create","items":{"$ref":"#/components/schemas/BlueprintUser"},"type":"array"}},"type":"object"},"BlueprintFile":{"description":"A custom file to create in the final artifact.\n","properties":{"data":{"description":"Contents of the file as plain text","type":"string"},"group":{"description":"Group of the file as a gid or a group name","example":"root","oneOf":[{"type":"string"},{"type":"integer","x-go-type":"int64"}]},"mode":{"description":"Permissions string for the file in octal format","example":"0644","type":"string"},"path":{"description":"Path to the file","example":"/etc/myfile","type":"string"},"user":{"description":"Owner of the file as a uid or a user name","example":"root","oneOf":[{"type":"string"},{"type":"integer","x-go-type":"int64"}]}},"required":["path"],"type":"object"},"BlueprintFilesystem":{"properties":{"minsize":{"$ref":"#/components/schemas/minsize"},"mountpoint":{"example":"/var","type":"string"}},"required":["mountpoint","minsize"],"type":"object"},"BlueprintFirewall":{"additionalProperties":false,"description":"Firewalld configuration","properties":{"ports":{"description":"List of ports (or port ranges) and protocols to open","example":["22:tcp","80:tcp","imap:tcp"],"items":{"type":"string"},"type":"array"},"services":{"$ref":"#/components/schemas/FirewallServices"},"zones":{"items":{"$ref":"#/components/schemas/FirewallZones"},"type":"array"}},"type":"object"},"BlueprintOpenSCAP":{"properties":{"datastream":{"type":"string"},"json_tailoring":{"$ref":"#/components/schemas/OpenSCAPJSONTailoring"},"policy_id":{"description":"Puts a specified policy ID in the RHSM facts, so that any instances registered to\ninsights will be automatically connected to the compliance policy in the console.\n","format":"uuid","type":"string"},"profile_id":{"type":"string"},"tailoring":{"$ref":"#/components/schemas/OpenSCAPTailoring"}},"required":["profile_id"],"type":"object"},"BlueprintRepository":{"properties":{"baseurls":{"items":{"example":"https://cdn.redhat.com/content/dist/rhel8/8/x86_64/baseos/os/","format":"uri","type":"string"},"type":"array"},"enabled":{"type":"boolean"},"filename":{"type":"string"},"gpgcheck":{"type":"boolean"},"gpgkeys":{"items":{"type":"string"},"type":"array"},"id":{"type":"string"},"metalink":{"example":"https://mirrors.fedoraproject.org/metalink?repo=fedora-32\u0026arch=x86_64","format":"uri","type":"string"},"mirrorlist":{"example":"http://mirrorlist.centos.org/?release=8-stream\u0026arch=aarch64\u0026repo=BaseOS","format":"uri","type":"string"},"module_hotfixes":{"description":"Disables modularity filtering for this repository.\n","type":"boolean"},"name":{"type":"string"},"priority":{"type":"integer"},"repo_gpgcheck":{"type":"boolean"},"sslverify":{"type":"boolean"}},"required":["id"],"type":"object"},"BlueprintUser":{"additionalProperties":false,"properties":{"description":{"type":"string"},"gid":{"description":"Group id to use instead of the default","type":"integer"},"groups":{"description":"A list of additional groups to add the user to","items":{"example":"group1","type":"string"},"type":"array"},"home":{"description":"The user's home directory","type":"string"},"key":{"description":"ssh public key","example":"ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAINrGKErMYi+MMUwuHaRAJmRLoIzRf2qD2dD5z0BTx/6x","type":"string"},"name":{"example":"user1","type":"string"},"password":{"description":"If the password starts with $6$, $5$, or $2b$ it will be stored as\nan encrypted password. Otherwise it will be treated as a plain text\npassword.\n","type":"string"},"shell":{"description":"Login shell to use","type":"string"},"uid":{"description":"User id to use instead of the default","type":"integer"}},"required":["name"],"type":"object"},"Bootc":{"properties":{"reference":{"example":"quay.io/centos-bootc/centos-bootc:stream9","type":"string"}},"required":["reference"],"type":"object"},"BtrfsSubvolume":{"properties":{"mountpoint":{"description":"Mountpoint for the subvolume\n","type":"string"},"name":{"description":"The name of the subvolume, which defines the location (path) on the root volume\n","type":"string"}},"required":["name","mountpoint"],"type":"object"},"BtrfsVolume":{"properties":{"minsize":{"$ref":"#/components/schemas/minsize"},"part_type":{"description":"The partition type GUID for GPT partitions. For DOS partitions, this field can be used to set the (2 hex digit) partition type. If not set, the type will be automatically set based on the mountpoint or the payload type.\n","type":"string"},"subvolumes":{"items":{"$ref":"#/components/schemas/BtrfsSubvolume"},"type":"array"},"type":{"enum":["btrfs"],"type":"string"}},"required":["type","subvolumes"],"type":"object"},"CACertsCustomization":{"additionalProperties":false,"properties":{"pem_certs":{"example":["---BEGIN CERTIFICATE---\\nMIIC0DCCAbigAwIBAgIUI...\\n---END CERTIFICATE---"],"items":{"type":"string"},"type":"array"}},"required":["pem_certs"],"type":"object"},"CloneComposeBody":{"oneOf":[{"$ref":"#/components/schemas/AWSEC2CloneCompose"}]},"CloneComposeResponse":{"allOf":[{"$ref":"#/components/schemas/ObjectReference"},{"properties":{"id":{"example":"123e4567-e89b-12d3-a456-426655440000","format":"uuid","type":"string"}},"required":["id"],"type":"object"}]},"CloneStatus":{"allOf":[{"$ref":"#/components/schemas/ObjectReference"},{"$ref":"#/components/schemas/UploadStatus"}]},"ComposeDeleteStatus":{"properties":{"href":{"type":"string"},"id":{"type":"string"},"kind":{"type":"string"}},"required":["id","kind","href"],"type":"object"},"ComposeId":{"allOf":[{"$ref":"#/components/schemas/ObjectReference"},{"properties":{"id":{"example":"123e4567-e89b-12d3-a456-426655440000","format":"uuid","type":"string"}},"required":["id"],"type":"object"}]},"ComposeList":{"allOf":[{"$ref":"#/components/schemas/List"},{"properties":{"items":{"items":{"$ref":"#/components/schemas/ComposeStatus"},"type":"array"}},"required":["items"],"type":"object"}]},"ComposeLogs":{"allOf":[{"$ref":"#/components/schemas/ObjectReference"},{"properties":{"image_builds":{"items":{"type":"object","x-go-type":"interface{}"},"type":"array"},"koji":{"$ref":"#/components/schemas/KojiLogs"}},"required":["image_builds"],"type":"object"}]},"ComposeManifests":{"allOf":[{"$ref":"#/components/schemas/ObjectReference"},{"properties":{"manifests":{"items":{"type":"object","x-go-type":"interface{}"},"type":"array"}},"required":["manifests"],"type":"object"}]},"ComposeMetadata":{"allOf":[{"$ref":"#/components/schemas/ObjectReference"},{"properties":{"ostree_commit":{"description":"ID (hash) of the built commit","type":"string"},"packages":{"description":"Package list including NEVRA","items":{"$ref":"#/components/schemas/PackageMetadata"},"type":"array"},"request":{"$ref":"#/components/schemas/ComposeRequest"}},"type":"object"}]},"ComposeRequest":{"additionalProperties":false,"not":{"required":["customizations","blueprint"]},"properties":{"blueprint":{"$ref":"#/components/schemas/Blueprint"},"blueprint_id":{"description":"Optional blueprint ID to record in RHSM facts. This is set automatically\nwhen composing from a blueprint via image-builder.\n","format":"uuid","type":"string"},"bootc":{"$ref":"#/components/schemas/Bootc"},"customizations":{"$ref":"#/components/schemas/Customizations"},"distribution":{"example":"rhel-8","type":"string"},"image_request":{"$ref":"#/components/schemas/ImageRequest"},"image_requests":{"items":{"$ref":"#/components/schemas/ImageRequest"},"type":"array"},"koji":{"$ref":"#/components/schemas/Koji"}}},"ComposeSBOMs":{"allOf":[{"$ref":"#/components/schemas/ObjectReference"},{"properties":{"items":{"description":"The SBOM documents for each image built in the compose.","items":{"description":"The SBOM documents for the given image. Each image usually has\nat least two SBOMs, one for the build environment and one for the\nactual content of the image.","items":{"$ref":"#/components/schemas/ImageSBOM"},"type":"array"},"type":"array"}},"required":["items"],"type":"object"}]},"ComposeStatus":{"allOf":[{"$ref":"#/components/schemas/ObjectReference"},{"properties":{"image_status":{"$ref":"#/components/schemas/ImageStatus"},"image_statuses":{"items":{"$ref":"#/components/schemas/ImageStatus"},"type":"array"},"koji_status":{"$ref":"#/components/schemas/KojiStatus"},"status":{"$ref":"#/components/schemas/ComposeStatusValue"}},"required":["status","image_status"],"type":"object"}]},"ComposeStatusError":{"properties":{"details":{},"id":{"type":"integer"},"reason":{"type":"string"}},"required":["id","reason"]},"ComposeStatusValue":{"enum":["success","failure","pending"],"example":"success","type":"string"},"Container":{"properties":{"name":{"description":"Name to use for the container from the image","type":"string"},"source":{"description":"Reference to the container to embed","example":"registry.example.com/image:tag","type":"string"},"tls_verify":{"description":"Control TLS verifification","example":true,"type":"boolean"}},"required":["source"],"type":"object"},"ContainerUploadOptions":{"additionalProperties":false,"properties":{"name":{"description":"Name for the created container image\n","example":"osbuild","type":"string"},"tag":{"description":"Tag for the created container image\n","example":"latest","type":"string"}},"type":"object"},"ContainerUploadStatus":{"additionalProperties":false,"properties":{"digest":{"description":"Digest of the manifest of the uploaded container on the registry\n","type":"string"},"url":{"description":"FQDN of the uploaded image\n","example":"quay.io/myaccount/osbuild:latest","type":"string"}},"required":["url","digest"],"type":"object"},"CustomRepository":{"properties":{"baseurl":{"items":{"example":"https://cdn.redhat.com/content/dist/rhel8/8/x86_64/baseos/os/","format":"uri","type":"string"},"type":"array"},"check_gpg":{"type":"boolean"},"check_repo_gpg":{"type":"boolean"},"enabled":{"type":"boolean"},"filename":{"type":"string"},"gpgkey":{"items":{"type":"string"},"type":"array"},"id":{"type":"string"},"metalink":{"example":"https://mirrors.fedoraproject.org/metalink?repo=fedora-32\u0026arch=x86_64","format":"uri","type":"string"},"mirrorlist":{"example":"http://mirrorlist.centos.org/?release=8-stream\u0026arch=aarch64\u0026repo=BaseOS","format":"uri","type":"string"},"module_hotfixes":{"type":"boolean"},"name":{"type":"string"},"priority":{"type":"integer"},"ssl_verify":{"type":"boolean"}},"required":["id"],"type":"object"},"Customizations":{"additionalProperties":false,"properties":{"cacerts":{"$ref":"#/components/schemas/CACertsCustomization"},"containers":{"items":{"$ref":"#/components/schemas/Container"},"type":"array"},"custom_repositories":{"description":"Extra repositories for packages specified in customizations. These\nrepositories will be used to depsolve and retrieve packages. Additionally,\nthese packages will be saved and imported to the `/etc/yum.repos.d/` directory\non the image\n","items":{"$ref":"#/components/schemas/CustomRepository"},"type":"array"},"directories":{"items":{"$ref":"#/components/schemas/Directory"},"type":"array"},"disk":{"$ref":"#/components/schemas/Disk"},"dnf":{"$ref":"#/components/schemas/DNF"},"enabled_modules":{"items":{"$ref":"#/components/schemas/Module"},"type":"array"},"fdo":{"$ref":"#/components/schemas/FDO"},"files":{"items":{"$ref":"#/components/schemas/File"},"type":"array"},"filesystem":{"items":{"$ref":"#/components/schemas/Filesystem"},"type":"array"},"fips":{"$ref":"#/components/schemas/FIPS"},"firewall":{"$ref":"#/components/schemas/FirewallCustomization"},"groups":{"description":"List of groups to create","items":{"$ref":"#/components/schemas/Group"},"type":"array"},"hostname":{"description":"Configures the hostname","example":"myhostname","type":"string"},"ignition":{"$ref":"#/components/schemas/Ignition"},"installation_device":{"description":"Name of the installation device, currently only useful for the edge-simplified-installer type\n","example":"/dev/sda","type":"string"},"installer":{"$ref":"#/components/schemas/Installer"},"kernel":{"$ref":"#/components/schemas/Kernel"},"locale":{"$ref":"#/components/schemas/Locale"},"openscap":{"$ref":"#/components/schemas/OpenSCAP"},"packages":{"example":["postgres"],"items":{"type":"string"},"type":"array"},"partitioning_mode":{"default":"auto-lvm","description":"Select how the disk image will be partitioned. 'auto-lvm' will use raw unless\nthere are one or more mountpoints in which case it will use LVM. 'lvm' always\nuses LVM, even when there are no extra mountpoints. 'raw' uses raw partitions\neven when there are one or more mountpoints.\n","enum":["raw","lvm","auto-lvm"],"type":"string"},"payload_repositories":{"description":"Extra repositories for packages specified in customizations. These\nrepositories will only be used to depsolve and retrieve packages\nfor the OS itself (they will not be available for the build root or\nany other part of the build process). The package_sets field for these\nrepositories is ignored.\n","items":{"$ref":"#/components/schemas/Repository"},"type":"array"},"rhsm":{"$ref":"#/components/schemas/RHSMCustomization"},"rpm":{"$ref":"#/components/schemas/RPMCustomization"},"services":{"$ref":"#/components/schemas/Services"},"subscription":{"$ref":"#/components/schemas/Subscription"},"timezone":{"$ref":"#/components/schemas/Timezone"},"users":{"items":{"$ref":"#/components/schemas/User"},"type":"array"}},"type":"object"},"DNF":{"properties":{"config":{"$ref":"#/components/schemas/DNFConfig"}},"type":"object","x-go-name":"DNF"},"DNFConfig":{"properties":{"set_releasever":{"default":false,"description":"Set the releasever DNF variable, tying the system to a specific release of RHEL\n","type":"boolean"}},"type":"object"},"DNFPluginConfig":{"properties":{"enabled":{"type":"boolean"}},"type":"object"},"DepsolveRequest":{"additionalProperties":false,"properties":{"architecture":{"example":"x86_64","type":"string"},"blueprint":{"$ref":"#/components/schemas/Blueprint"},"distribution":{"example":"rhel-8","type":"string"},"image_type":{"$ref":"#/components/schemas/ImageTypes"},"repositories":{"items":{"$ref":"#/components/schemas/Repository"},"type":"array"}},"required":["blueprint","distribution","architecture"]},"DepsolveResponse":{"properties":{"packages":{"description":"Package list including NEVRA","items":{"$ref":"#/components/schemas/PackageMetadataCommon"},"type":"array"}},"required":["packages"],"type":"object"},"Directory":{"description":"A custom directory to create in the final artifact.\n","properties":{"ensure_parents":{"default":false,"description":"Ensure that the parent directories exist","type":"boolean"},"group":{"description":"Group of the directory as a group name or a gid","example":"root","oneOf":[{"type":"string"},{"type":"integer","x-go-type":"int64"}]},"mode":{"description":"Permissions string for the directory in octal format","example":"0755","type":"string"},"path":{"description":"Path to the directory","example":"/etc/mydir","type":"string"},"user":{"description":"Owner of the directory as a user name or a uid","example":"root","oneOf":[{"type":"string"},{"type":"integer","x-go-type":"int64"}]}},"required":["path"],"type":"object"},"Disk":{"properties":{"minsize":{"$ref":"#/components/schemas/minsize"},"partitions":{"items":{"$ref":"#/components/schemas/Partition"},"type":"array"},"type":{"description":"Type of the partition table\n","enum":["gpt","dos"],"type":"string"}},"required":["partitions"],"type":"object"},"DistributionDetails":{"allOf":[{"$ref":"#/components/schemas/ObjectReference"},{"additionalProperties":false,"description":"Complete metadata for a specific distribution from images library","properties":{"architectures":{"additionalProperties":{"$ref":"#/components/schemas/ArchitectureInfo"},"description":"Map of architecture names to their details","type":"object"},"codename":{"description":"Codename of the distribution","example":"","type":"string"},"module_platform_id":{"description":"Module platform ID for DNF modularity","example":"platform:el9","type":"string"},"name":{"description":"Name of the distribution","example":"rhel-9.6","type":"string"},"os_version":{"description":"Full OS version including minor version","example":"9.6","type":"string"},"ostree_ref":{"description":"Default OSTree reference template","example":"rhel/9/%s/edge","type":"string"},"product":{"description":"Product name","example":"Red Hat Enterprise Linux","type":"string"},"releasever":{"description":"Release version used in repo files","example":"9","type":"string"}},"required":["name"],"type":"object"}]},"DistributionList":{"additionalProperties":{"additionalProperties":{"description":"Repository used for this distro:arch:image-type","items":{"$ref":"#/components/schemas/BlueprintRepository"},"type":"array"},"description":"Map of architectures to their repositories.\n","type":"object"},"description":"Map of distributions to their architecture.\n","type":"object"},"Error":{"allOf":[{"$ref":"#/components/schemas/ObjectReference"},{"properties":{"code":{"type":"string"},"details":{},"operation_id":{"type":"string"},"reason":{"type":"string"}},"required":["code","reason","operation_id"],"type":"object"}]},"ErrorList":{"allOf":[{"$ref":"#/components/schemas/List"},{"properties":{"items":{"items":{"$ref":"#/components/schemas/Error"},"type":"array"}},"required":["items"],"type":"object"}]},"FDO":{"additionalProperties":false,"description":"FIDO device onboard configuration","properties":{"di_mfg_string_type_mac_iface":{"type":"string"},"diun_pub_key_hash":{"type":"string"},"diun_pub_key_insecure":{"type":"string"},"diun_pub_key_root_certs":{"type":"string"},"manufacturing_server_url":{"type":"string"}},"type":"object"},"FIPS":{"additionalProperties":false,"description":"System FIPS mode setup","properties":{"enabled":{"default":false,"description":"Enables the system FIPS mode","type":"boolean"}},"type":"object"},"File":{"description":"A custom file to create in the final artifact.\n","properties":{"data":{"description":"Contents of the file as plain text","type":"string"},"ensure_parents":{"default":false,"description":"Ensure that the parent directories exist","example":true,"type":"boolean"},"group":{"description":"Group of the file as a gid or a group name","example":"root","oneOf":[{"type":"string"},{"type":"integer","x-go-type":"int64"}]},"mode":{"description":"Permissions string for the file in octal format","example":"0644","type":"string"},"path":{"description":"Path to the file","example":"/etc/myfile","type":"string"},"user":{"description":"Owner of the file as a uid or a user name","example":"root","oneOf":[{"type":"string"},{"type":"integer","x-go-type":"int64"}]}},"required":["path"],"type":"object"},"Filesystem":{"properties":{"min_size":{"description":"size of the filesystem in bytes","example":2147483648,"x-go-type":"uint64"},"mountpoint":{"example":"/var","type":"string"}},"required":["mountpoint","min_size"],"type":"object"},"FilesystemTyped":{"properties":{"fs_type":{"description":"The filesystem type. Swap partitions must have an empty mountpoint.\n","enum":["ext4","xfs","vfat","swap"],"type":"string"},"label":{"type":"string"},"minsize":{"$ref":"#/components/schemas/minsize"},"mountpoint":{"type":"string"},"part_type":{"description":"The partition type GUID for GPT partitions. For DOS partitions, this field can be used to set the (2 hex digit) partition type. If not set, the type will be automatically set based on the mountpoint or the payload type.\n","type":"string"},"type":{"enum":["plain"],"type":"string"}},"required":["fs_type"],"type":"object"},"FirewallCustomization":{"additionalProperties":false,"description":"Firewalld configuration","properties":{"ports":{"description":"List of ports (or port ranges) and protocols to open","example":["22:tcp","80:tcp","imap:tcp"],"items":{"type":"string"},"type":"array"},"services":{"$ref":"#/components/schemas/FirewallServices"}},"type":"object"},"FirewallServices":{"additionalProperties":false,"description":"Firewalld services to enable or disable","properties":{"disabled":{"description":"List of services to disable","example":["telnet"],"items":{"type":"string"},"type":"array"},"enabled":{"description":"List of services to enable","example":["ftp","ntp"],"items":{"type":"string"},"type":"array"}},"type":"object"},"FirewallZones":{"additionalProperties":false,"description":"Bind a list of network sources to a zone to restrict traffic from\nthose sources based on the settings of the zone.\n","properties":{"name":{"description":"name of the zone, if left empty the sources will apply to\nthe default zone.\n","type":"string"},"sources":{"description":"List of sources for the zone","items":{"description":"\u003csource\u003e[/\u003cmask\u003e]|\u003cMAC\u003e|ipset:\u003cipset\u003e","type":"string"},"type":"array"}},"type":"object"},"GCPUploadOptions":{"additionalProperties":false,"properties":{"bucket":{"description":"Name of an existing STANDARD Storage class Bucket.","example":"my-example-bucket","type":"string"},"image_name":{"description":"The name to use for the imported and shared Compute Engine image.\nThe image name must be unique within the GCP project, which is used\nfor the OS image upload and import. If not specified a random\n'composer-api-\u003cuuid\u003e' string is used as the image name.\n","example":"my-image","type":"string"},"region":{"description":"The GCP region where the OS image will be imported to and shared from.\nThe value must be a valid GCP location. See https://cloud.google.com/storage/docs/locations.\nIf not specified, the multi-region location closest to the source\n(source Storage Bucket location) is chosen automatically.\n","example":"eu","type":"string"},"share_with_accounts":{"description":"List of valid Google accounts to share the imported Compute Engine image with.\nEach string must contain a specifier of the account type. Valid formats are:\n  - 'user:{emailid}': An email address that represents a specific\n    Google account. For example, 'alice@example.com'.\n  - 'serviceAccount:{emailid}': An email address that represents a\n    service account. For example, 'my-other-app@appspot.gserviceaccount.com'.\n  - 'group:{emailid}': An email address that represents a Google group.\n    For example, 'admins@example.com'.\n  - 'domain:{domain}': The G Suite domain (primary) that represents all\n    the users of that domain. For example, 'google.com' or 'example.com'.\nIf not specified, the imported Compute Engine image is not shared with any\naccount.\n","example":["user:alice@example.com","serviceAccount:my-other-app@appspot.gserviceaccount.com","group:admins@example.com","domain:example.com"],"items":{"type":"string"},"type":"array"}},"required":["region"],"type":"object"},"GCPUploadStatus":{"properties":{"image_name":{"example":"my-image","type":"string"},"project_id":{"example":"ascendant-braid-303513","type":"string"}},"required":["project_id","image_name"],"type":"object"},"Group":{"additionalProperties":false,"properties":{"gid":{"description":"Group id of the group to create (optional)","type":"integer"},"name":{"description":"Name of the group to create","type":"string"}},"required":["name"],"type":"object"},"Ignition":{"additionalProperties":false,"description":"Ignition configuration","properties":{"embedded":{"$ref":"#/components/schemas/IgnitionEmbedded"},"firstboot":{"$ref":"#/components/schemas/IgnitionFirstboot"}},"type":"object"},"IgnitionEmbedded":{"additionalProperties":false,"properties":{"config":{"type":"string"}},"required":["config"],"type":"object"},"IgnitionFirstboot":{"additionalProperties":false,"properties":{"url":{"description":"Provisioning URL","type":"string"}},"required":["url"],"type":"object"},"ImageRequest":{"additionalProperties":false,"properties":{"architecture":{"example":"x86_64","type":"string"},"image_type":{"$ref":"#/components/schemas/ImageTypes"},"ostree":{"$ref":"#/components/schemas/OSTree"},"repositories":{"items":{"$ref":"#/components/schemas/Repository"},"type":"array"},"size":{"default":0,"description":"Size of image, in bytes. When set to 0 the image size is a minimum\ndefined by the image type.\n","example":4294967296,"x-go-type":"uint64"},"upload_options":{"$ref":"#/components/schemas/UploadOptions"},"upload_targets":{"description":"The type and options for multiple upload targets. Each item defines\na separate upload destination with its own options. Multiple\ndifferent targets as well as multiple targets of the same kind are\nsupported.\n","items":{"$ref":"#/components/schemas/UploadTarget"},"type":"array"}},"required":["architecture","image_type","repositories"]},"ImageSBOM":{"properties":{"pipeline_name":{"description":"The name of the osbuild pipeline which has the packages described\nin the SBOM installed.","type":"string"},"pipeline_purpose":{"description":"The purpose of the pipeline. The `buildroot` pipeline was used for\nthe build environment dueing the image build. The `image` pipeline\nrepresents the actual content of the image. Due to the nature of\nsome image types, there may be multiple pipelines of the same\npurpose.","enum":["buildroot","image"],"type":"string"},"sbom":{"description":"The SBOM document in the 'sbom_type' format.","type":"object","x-go-type":"interface{}"},"sbom_type":{"description":"The type of the SBOM document. Currently only SPDX is supported.","enum":["spdx"],"type":"string"}},"required":["sbom","sbom_type","pipeline_name","pipeline_purpose"]},"ImageStatus":{"properties":{"error":{"$ref":"#/components/schemas/ComposeStatusError"},"progress":{"$ref":"#/components/schemas/Progress"},"status":{"$ref":"#/components/schemas/ImageStatusValue"},"upload_status":{"$ref":"#/components/schemas/UploadStatus"},"upload_statuses":{"items":{"$ref":"#/components/schemas/UploadStatus"},"type":"array"}},"required":["status"]},"ImageStatusValue":{"enum":["success","failure","pending","building","uploading","registering"],"type":"string"},"ImageTypeInfo":{"additionalProperties":false,"description":"Image type metadata from images library","properties":{"aliases":{"description":"Alternative names for this image type","items":{"example":"aws","type":"string"},"type":"array"},"base_partition_table":{"$ref":"#/components/schemas/Disk"},"boot_mode":{"description":"Boot mode for the image","enum":["legacy","uefi","hybrid","none"],"type":"string"},"default_size":{"description":"Default image size in bytes","example":1073741824,"format":"uint64","type":"integer"},"exports":{"description":"Names of stages that produce the build output","items":{"example":"image","type":"string"},"type":"array"},"filename":{"description":"Canonical filename for the image","example":"image.raw","type":"string"},"iso_label":{"description":"ISO label (only for ISO image types)","nullable":true,"type":"string"},"mime_type":{"description":"MIME type of the image","example":"application/octet-stream","type":"string"},"name":{"description":"Image type name","example":"ami","type":"string"},"ostree_ref":{"description":"Default OSTree ref for this image type","example":"","type":"string"},"partition_type":{"description":"Partition table type","enum":["gpt","dos"],"type":"string"},"payload_package_sets":{"description":"Package set names safe for custom packages via custom repos","items":{"example":"blueprint","type":"string"},"type":"array"},"required_blueprint_options":{"description":"Customization options required by this image type","items":{"type":"string"},"type":"array"},"supported_blueprint_options":{"description":"Customization options supported by this image type","example":["distro","packages","customizations.cacerts","customizations.sshkey"],"items":{"type":"string"},"type":"array"}},"required":["name"],"type":"object"},"ImageTypes":{"enum":["aws","aws-cvm","aws-ha-rhui","aws-rhui","aws-sap-rhui","azure","azure-cvm","azure-eap7-rhui","azure-rhui","azure-sapapps-rhui","azure-sap-rhui","edge-commit","edge-container","edge-installer","gcp","gcp-rhui","guest-image","image-installer","iot-bootable-container","iot-commit","iot-container","iot-installer","iot-raw-image","iot-simplified-installer","live-installer","minimal-raw","network-installer","everything-network-installer","server-network-installer","oci","pxe-tar-xz","vsphere","vsphere-ova","wsl"],"type":"string"},"ImportKeys":{"properties":{"files":{"items":{"type":"string"},"type":"array"}},"type":"object"},"Installer":{"properties":{"sudo-nopasswd":{"items":{"type":"string"},"type":"array"},"unattended":{"type":"boolean"}},"type":"object"},"Kernel":{"additionalProperties":false,"properties":{"append":{"description":"Appends arguments to the bootloader kernel command line","example":"nosmt=force","type":"string"},"name":{"description":"Name of the kernel to use","example":"kernel-debug","type":"string"}},"type":"object"},"Koji":{"additionalProperties":false,"properties":{"name":{"example":"Fedora-Cloud-Base","type":"string"},"release":{"example":"20200907.0","type":"string"},"server":{"example":"https://koji.fedoraproject.org/kojihub","format":"uri","type":"string"},"task_id":{"example":42,"type":"integer"},"version":{"example":"31","type":"string"}},"required":["server","task_id","name","version","release"],"type":"object"},"KojiLogs":{"properties":{"import":{},"init":{}},"required":["init","import"],"type":"object"},"KojiStatus":{"properties":{"build_id":{"example":42,"type":"integer"}},"type":"object"},"List":{"properties":{"kind":{"type":"string"},"page":{"type":"integer"},"size":{"type":"integer"},"total":{"type":"integer"}},"required":["kind","page","size","total","items"],"type":"object"},"LocalUploadOptions":{"additionalProperties":false,"type":"object"},"LocalUploadStatus":{"properties":{"artifact_path":{"type":"string"}},"required":["artifact_path"],"type":"object"},"Locale":{"additionalProperties":false,"description":"Locale configuration","properties":{"keyboard":{"description":"Sets the keyboard layout","example":"us","type":"string"},"languages":{"description":"List of locales to be installed, the first one becomes primary, subsequent ones are secondary\n","example":["en_US.UTF-8"],"items":{"type":"string"},"type":"array"}},"type":"object"},"LogicalVolume":{"properties":{"fs_type":{"description":"The filesystem type for the logical volume. Swap LVs must have an empty mountpoint.\n","enum":["ext4","xfs","vfat","swap"],"type":"string"},"label":{"type":"string"},"minsize":{"$ref":"#/components/schemas/minsize"},"mountpoint":{"description":"Mountpoint for the logical volume\n","type":"string"},"name":{"type":"string"}},"required":["fs_type"],"type":"object"},"Module":{"additionalProperties":false,"properties":{"name":{"description":"Name of the module to enable.\n","example":"nodejs","type":"string"},"stream":{"description":"Stream to enable.\n","example":"22","type":"string"}},"required":["name","stream"],"type":"object"},"OCIUploadOptions":{"additionalProperties":false,"type":"object"},"OCIUploadStatus":{"properties":{"url":{"type":"string"}},"required":["url"],"type":"object"},"OSTree":{"properties":{"contenturl":{"description":"A URL which, if set, is used for fetching content. Implies that `url` is set as well,\nwhich will be used for metadata only.\n","type":"string"},"parent":{"description":"Can be either a commit (example: 02604b2da6e954bd34b8b82a835e5a77d2b60ffa), or a branch-like reference (example: rhel/8/x86_64/edge)\n","example":"rhel/8/x86_64/edge","type":"string"},"ref":{"example":"rhel/8/x86_64/edge","type":"string"},"rhsm":{"default":false,"description":"Determines whether a valid subscription manager (candlepin) identity is required to\naccess this repository. Consumer certificates will be used as client certificates when\nfetching metadata and content.\n","type":"boolean"},"url":{"type":"string"}},"type":"object"},"ObjectReference":{"properties":{"href":{"type":"string"},"id":{"type":"string"},"kind":{"type":"string"}},"required":["id","kind","href"],"type":"object"},"OpenSCAP":{"properties":{"json_tailoring":{"$ref":"#/components/schemas/OpenSCAPJSONTailoring"},"policy_id":{"description":"Puts a specified policy ID in the RHSM facts, so that any instances registered to\ninsights will be automatically connected to the compliance policy in the console.\n","format":"uuid","type":"string"},"profile_id":{"type":"string"},"tailoring":{"$ref":"#/components/schemas/OpenSCAPTailoring"}},"required":["profile_id"],"type":"object"},"OpenSCAPJSONTailoring":{"properties":{"filepath":{"type":"string"},"profile_id":{"type":"string"}},"required":["profile_id","filepath"],"type":"object"},"OpenSCAPTailoring":{"properties":{"selected":{"items":{"type":"string"},"type":"array"},"unselected":{"items":{"type":"string"},"type":"array"}},"type":"object"},"Package":{"additionalProperties":false,"properties":{"name":{"description":"Name of the package to install. File globbing is supported,\neg. 'openssh-*'\n","example":"tmux","type":"string"},"version":{"description":"Optional version of the package to install. If left blank the\nlatest available version will be used. Wildcards are supported\neg. '4.11.*'\n","example":"3.3a","type":"string"}},"required":["name"],"type":"object"},"PackageDetails":{"properties":{"arch":{"type":"string"},"buildtime":{"type":"string"},"description":{"type":"string"},"epoch":{"type":"string"},"license":{"type":"string"},"name":{"type":"string"},"release":{"type":"string"},"summary":{"type":"string"},"url":{"type":"string"},"version":{"type":"string"}},"required":["name","version","release","arch"],"type":"object"},"PackageGroup":{"additionalProperties":false,"properties":{"name":{"description":"Package group name","example":"anaconda-tools","type":"string"}},"required":["name"],"type":"object"},"PackageMetadata":{"allOf":[{"$ref":"#/components/schemas/PackageMetadataCommon"},{"properties":{"sigmd5":{"type":"string"}},"required":["sigmd5"],"type":"object"}]},"PackageMetadataCommon":{"properties":{"arch":{"type":"string"},"checksum":{"description":"Optional package checksum using ALGO:HASH form","example":"sha256:525788de3dd44497c27d4172568366b20380a6b6707f0a1970473e4d97046a4f","type":"string"},"epoch":{"type":"string"},"name":{"type":"string"},"release":{"type":"string"},"signature":{"type":"string"},"type":{"type":"string"},"version":{"type":"string"}},"required":["type","name","version","release","arch","sigmd5"]},"Partition":{"oneOf":[{"$ref":"#/components/schemas/FilesystemTyped"},{"$ref":"#/components/schemas/BtrfsVolume"},{"$ref":"#/components/schemas/VolumeGroup"}],"type":"object"},"Progress":{"allOf":[{"$ref":"#/components/schemas/SubProgress"},{"properties":{"subprogress":{"$ref":"#/components/schemas/SubProgress"}},"type":"object"}]},"PulpOSTreeUploadOptions":{"additionalProperties":false,"properties":{"basepath":{"description":"Basepath for distributing the repository","type":"string"},"repository":{"description":"Repository to import the ostree commit to","type":"string"},"server_address":{"format":"uri","type":"string"}},"required":["basepath"],"type":"object"},"PulpOSTreeUploadStatus":{"properties":{"repo_url":{"type":"string"}},"required":["repo_url"],"type":"object"},"RHSMConfig":{"properties":{"dnf_plugins":{"$ref":"#/components/schemas/SubManDNFPluginsConfig"},"subscription_manager":{"$ref":"#/components/schemas/SubManConfig"}},"type":"object"},"RHSMCustomization":{"properties":{"config":{"$ref":"#/components/schemas/RHSMConfig"}},"type":"object"},"RPMCustomization":{"properties":{"import_keys":{"$ref":"#/components/schemas/ImportKeys"}},"type":"object"},"Repository":{"description":"Repository configuration.\nAt least one of the 'baseurl', 'mirrorlist', 'metalink' properties must\nbe specified. If more of them are specified, the order of precedence is\nthe same as listed above.\n","properties":{"baseurl":{"example":"https://cdn.redhat.com/content/dist/rhel8/8/x86_64/baseos/os/","format":"uri","type":"string"},"check_gpg":{"type":"boolean"},"check_repo_gpg":{"default":false,"description":"Enables gpg verification of the repository metadata\n","type":"boolean"},"gpgkey":{"description":"GPG key used to sign packages in this repository.","example":"-----BEGIN PGP PUBLIC KEY BLOCK-----\n\nmQINBGAcScoBEADLf8YHkezJ6adlMYw7aGGIlJalt8Jj2x/B2K+hIfIuxGtpVj7e\nLRgDU76jaT5pVD5mFMJ3pkeneR/cTmqqQkNyQshX2oQXwEzUSb1CNMCfCGgkX8Q2\nzZkrIcCrF0Q2wrKblaudhU+iVanADsm18YEqsb5AU37dtUrM3QYdWg9R+XiPfV8R\nKBjT03vVBOdMSsY39LaCn6Ip1Ovp8IEo/IeEVY1qmCOPAaK0bJH3ufg4Cueks+TS\nwQWTeCLxuZL6OMXoOPKwvMQfxbg1XD8vuZ0Ktj/cNH2xau0xmsAu9HJpekvOPRxl\nyqtjyZfroVieFypwZgvQwtnnM8/gSEu/JVTrY052mEUT7Ccb74kcHFTFfMklnkG/\n0fU4ARa504H3xj0ktbe3vKcPXoPOuKBVsHSv00UGYAyPeuy+87cU/YEhM7k3SVKj\n6eIZgyiMO0wl1YGDRKculwks9A+ulkg1oTb4s3zmZvP07GoTxW42jaK5WS+NhZee\n860XoVhbc1KpS+jfZojsrEtZ8PbUZ+YvF8RprdWArjHbJk2JpRKAxThxsQAsBhG1\n0Lux2WaMB0g2I5PcMdJ/cqjo08ccrjBXuixWri5iu9MXp8qT/fSzNmsdIgn8/qZK\ni8Qulfu77uqhW/wt2btnitgRsqjhxMujYU4Zb4hktF8hKU/XX742qhL5KwARAQAB\ntDFGZWRvcmEgKDM1KSA8ZmVkb3JhLTM1LXByaW1hcnlAZmVkb3JhcHJvamVjdC5v\ncmc+iQJOBBMBCAA4FiEEeH6mrhFH7uVsQLMM20Y5cZhnxY8FAmAcScoCGw8FCwkI\nBwIGFQoJCAsCBBYCAwECHgECF4AACgkQ20Y5cZhnxY+NYA/7BYpglySAZYHhjyKh\n/+f6zPfVvbH20Eq3kI7OFBN0nLX+BU1muvS+qTuS3WLrB3m3GultpKREJKLtm5ED\n1rGzXAoT1yp9YI8LADdMCCOyjAjsoWU87YUuC+/bnjrTeR2LROCfyPC76W985iOV\nm5S+bsQDw7C2LrldAM4MDuoyZ1SitGaZ4KQLVt+TEa14isYSGCjzo7PY8V3JOk50\ngqWg82N/bm2EzS7T83WEDb1lvj4IlvxgIqKeg11zXYxmrYSZJJCfvzf+lNS6uxgH\njx/J0ylZ2LibGr6GAAyO9UWrAZSwSM0EcjT8wECnxkSDuyqmWwVvNBXuEIV8Oe3Y\nMiU1fJN8sd7DpsFx5M+XdnMnQS+HrjTPKD3mWrlAdnEThdYV8jZkpWhDys3/99eO\nhk0rLny0jNwkauf/iU8Oc6XvMkjLRMJg5U9VKyJuWWtzwXnjMN5WRFBqK4sZomMM\nftbTH1+5ybRW/A3vBbaxRW2t7UzNjczekSZEiaLN9L/HcJCIR1QF8682DdAlEF9d\nk2gQiYSQAaaJ0JJAzHvRkRJLLgK2YQYiHNVy2t3JyFfsram5wSCWOfhPeIyLBTZJ\nvrpNlPbefsT957Tf2BNIugzZrC5VxDSKkZgRh1VGvSIQnCyzkQy6EU2qPpiW59G/\nhPIXZrKocK3KLS9/izJQTRltjMA=\n=PfT7\n-----END PGP PUBLIC KEY BLOCK-----\n","type":"string"},"ignore_ssl":{"type":"boolean"},"metalink":{"example":"https://mirrors.fedoraproject.org/metalink?repo=fedora-32\u0026arch=x86_64","format":"uri","type":"string"},"mirrorlist":{"example":"http://mirrorlist.centos.org/?release=8-stream\u0026arch=aarch64\u0026repo=BaseOS","format":"uri","type":"string"},"module_hotfixes":{"default":false,"description":"Disables modularity filtering for this repository.\n","type":"boolean"},"package_sets":{"description":"Naming package sets for a repository assigns it to a specific part\n(pipeline) of the build process.\n","example":["build","os"],"items":{"type":"string"},"type":"array"},"rhsm":{"default":false,"description":"Determines whether a valid subscription is required to access this repository.","type":"boolean"}},"type":"object"},"SSHKey":{"additionalProperties":false,"properties":{"key":{"description":"Adds the key to the user's authorized_keys file","example":"ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIASWitkOH4U874EdsBUnytb3bwvRggHlQlbYXl7n10v9\n","type":"string"},"user":{"description":"User to configure the ssh key for","example":"admin","type":"string"}},"required":["user","key"],"type":"object"},"SearchPackagesRequest":{"additionalProperties":false,"properties":{"architecture":{"example":"x86_64","type":"string"},"distribution":{"example":"rhel-8","type":"string"},"packages":{"description":"Array of package names to search for. Supports * wildcards for\nnames, but not for versions.\n","items":{"type":"string"},"type":"array"},"repositories":{"items":{"$ref":"#/components/schemas/Repository"},"type":"array"}},"required":["packages","distribution","architecture"]},"SearchPackagesResponse":{"properties":{"packages":{"description":"Detailed package information from DNF","items":{"$ref":"#/components/schemas/PackageDetails"},"type":"array"}},"required":["packages"],"type":"object"},"Services":{"additionalProperties":false,"properties":{"disabled":{"description":"List of services to disable by default","items":{"example":"firewalld","type":"string"},"minItems":1,"type":"array"},"enabled":{"description":"List of services to enable by default","items":{"example":"nftables","type":"string"},"minItems":1,"type":"array"},"masked":{"description":"List of services to mask by default","items":{"example":"telnetd","type":"string"},"minItems":1,"type":"array"}},"type":"object"},"SubManConfig":{"properties":{"rhsm":{"$ref":"#/components/schemas/SubManRHSMConfig"},"rhsmcertd":{"$ref":"#/components/schemas/SubManRHSMCertdConfig"}},"type":"object"},"SubManDNFPluginsConfig":{"properties":{"product_id":{"$ref":"#/components/schemas/DNFPluginConfig"},"subscription_manager":{"$ref":"#/components/schemas/DNFPluginConfig"}},"type":"object"},"SubManRHSMCertdConfig":{"properties":{"auto_registration":{"type":"boolean"}},"type":"object"},"SubManRHSMConfig":{"properties":{"auto_enable_yum_plugins":{"type":"boolean"},"manage_repos":{"type":"boolean"}},"type":"object"},"SubProgress":{"properties":{"done":{"description":"Amount of completed steps in the build.","type":"integer"},"total":{"description":"Total amount of steps in the build.","type":"integer"}},"required":["done","total"],"type":"object","x-go-name":"SubProgress"},"Subscription":{"properties":{"activation_key":{"example":"my-secret-key","format":"password","type":"string"},"base_url":{"example":"http://cdn.redhat.com/","format":"uri","type":"string"},"content_sets":{"description":"Optional list of repository IDs to enable with subscription-manager on first boot.\n","items":{"example":"content-label-1","type":"string"},"type":"array"},"insights":{"example":true,"type":"boolean"},"insights_client_proxy":{"description":"Optional value to set proxy option when registering the system to Insights\n","format":"uri","type":"string"},"organization":{"example":"2040324","type":"string"},"patch_url":{"description":"Optional value used to specify the patch host when registering the system with Insights.\n","type":"string"},"rhc":{"default":false,"description":"Optional flag to use rhc to register the system, which also always enables Insights.\n","example":true,"type":"boolean"},"server_url":{"example":"subscription.rhsm.redhat.com","format":"uri","type":"string"},"template_name":{"description":"Optional value to register with a template when using rhc to register the system with Insights.\n","type":"string"},"template_uuid":{"description":"Optional value to register with a template when registering the system with Insights.\n","type":"string"}},"required":["organization","activation_key","server_url","base_url","insights"],"type":"object"},"Timezone":{"additionalProperties":false,"description":"Timezone configuration","properties":{"ntpservers":{"description":"List of ntp servers","example":["0.north-america.pool.ntp.org","1.north-america.pool.ntp.org"],"items":{"type":"string"},"type":"array"},"timezone":{"description":"Name of the timezone, defaults to UTC","example":"US/Eastern","type":"string"}},"type":"object"},"UploadOptions":{"anyOf":[{"$ref":"#/components/schemas/AWSEC2UploadOptions"},{"$ref":"#/components/schemas/AWSS3UploadOptions"},{"$ref":"#/components/schemas/GCPUploadOptions"},{"$ref":"#/components/schemas/AzureUploadOptions"},{"$ref":"#/components/schemas/ContainerUploadOptions"},{"$ref":"#/components/schemas/LocalUploadOptions"},{"$ref":"#/components/schemas/OCIUploadOptions"},{"$ref":"#/components/schemas/PulpOSTreeUploadOptions"}],"description":"Options for a given upload destination.\nThis should really be oneOf but AWSS3UploadOptions is a subset of\nAWSEC2UploadOptions. This means that all AWSEC2UploadOptions objects\nare also valid AWSS3UploadOptionas objects which violates the oneOf\nrules. Therefore, we have to use anyOf here but be aware that it isn't\npossible to mix and match more schemas together.\n"},"UploadStatus":{"properties":{"options":{"oneOf":[{"$ref":"#/components/schemas/AWSEC2UploadStatus"},{"$ref":"#/components/schemas/AWSS3UploadStatus"},{"$ref":"#/components/schemas/GCPUploadStatus"},{"$ref":"#/components/schemas/AzureUploadStatus"},{"$ref":"#/components/schemas/ContainerUploadStatus"},{"$ref":"#/components/schemas/OCIUploadStatus"},{"$ref":"#/components/schemas/PulpOSTreeUploadStatus"},{"$ref":"#/components/schemas/LocalUploadStatus"}]},"status":{"$ref":"#/components/schemas/UploadStatusValue"},"type":{"$ref":"#/components/schemas/UploadTypes"}},"required":["status","type","options"]},"UploadStatusValue":{"enum":["success","failure","pending","running"],"type":"string"},"UploadTarget":{"properties":{"type":{"$ref":"#/components/schemas/UploadTypes"},"upload_options":{"$ref":"#/components/schemas/UploadOptions"}},"required":["type","upload_options"],"type":"object"},"UploadTypes":{"enum":["aws","aws.s3","gcp","azure","container","oci.objectstorage","local"],"type":"string"},"User":{"additionalProperties":false,"properties":{"groups":{"items":{"example":"group1","type":"string"},"type":"array"},"key":{"example":"ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAINrGKErMYi+MMUwuHaRAJmRLoIzRf2qD2dD5z0BTx/6x","type":"string"},"name":{"example":"user1","type":"string"},"password":{"description":"If the password starts with $6$, $5$, or $2b$ it will be stored as\nan encrypted password. Otherwise it will be treated as a plain text\npassword.\n","format":"password","type":"string"}},"required":["name"],"type":"object"},"VolumeGroup":{"properties":{"logical_volumes":{"items":{"$ref":"#/components/schemas/LogicalVolume"},"type":"array"},"minsize":{"$ref":"#/components/schemas/minsize"},"name":{"description":"Volume group name (will be automatically generated if omitted)\n","type":"string"},"part_type":{"description":"The partition type GUID for GPT partitions. For DOS partitions, this field can be used to set the (2 hex digit) partition type. If not set, the type will be automatically set based on the mountpoint or the payload type.\n","type":"string"},"type":{"enum":["lvm"],"type":"string"}},"required":["type","logical_volumes"],"type":"object"},"minsize":{"description":"size with data units","example":"2 GiB","type":"string"}},"securitySchemes":{"Bearer":{"bearerFormat":"JWT","scheme":"bearer","type":"http"}}},"info":{"description":"Service to build and install images.","license":{"name":"Apache 2.0","url":"https://www.apache.org/licenses/LICENSE-2.0.html"},"title":"OSBuild Composer cloud api","version":"2"},"openapi":"3.0.1","paths":{"/clones/{id}":{"get":{"description":"Get the status of a running or completed image from a compose.\nThis includes whether or not the image creation succeeded.","operationId":"GetCloneStatus","parameters":[{"description":"ID of image status to get","in":"path","name":"id","required":true,"schema":{"example":"123e4567-e89b-12d3-a456-426655440000","format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloneStatus"}}},"description":"image status"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Invalid compose id"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Auth token is invalid"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Unauthorized to perform operation"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Unknown compose id"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Unexpected error occurred"}},"security":[{"Bearer":[]}],"summary":"The status of a cloned compose"}},"/compose":{"post":{"description":"Create a new compose, potentially consisting of several images and upload each to their destinations.","operationId":"PostCompose","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComposeRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComposeId"}}},"description":"Compose has started"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Invalid compose request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Auth token is invalid"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Unauthorized to perform operation"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Unknown compose id"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Unexpected error occurred"}},"security":[{"Bearer":[]}],"summary":"Create compose"}},"/composes/":{"get":{"description":"Get the list of composes. They may be completed, uploaded,\nlocally saved, or failed.","operationId":"GetComposeList","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComposeList"}}},"description":"list of composes"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Auth token is invalid"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Unauthorized to perform operation"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Unknown compose id"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Unexpected error occurred"}},"security":[{"Bearer":[]}],"summary":"The list of composes"}},"/composes/{id}":{"delete":{"description":"Delete a compose and all of its independent jobs.","operationId":"DeleteCompose","parameters":[{"description":"ID of compose to delete","in":"path","name":"id","required":true,"schema":{"example":"123e4567-e89b-12d3-a456-426655440000","format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComposeDeleteStatus"}}},"description":"compose delete status"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Invalid compose id"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Auth token is invalid"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Unauthorized to perform operation"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Unknown compose id"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Unexpected error occurred"}},"security":[{"Bearer":[]}],"summary":"Delete a compose"},"get":{"description":"Get the status of a running or completed compose.\nThis includes whether or not the compose succeeded.","operationId":"GetComposeStatus","parameters":[{"description":"ID of compose status to get","in":"path","name":"id","required":true,"schema":{"example":"123e4567-e89b-12d3-a456-426655440000","format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComposeStatus"}}},"description":"compose status"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Invalid compose id"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Auth token is invalid"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Unauthorized to perform operation"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Unknown compose id"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Unexpected error occurred"}},"security":[{"Bearer":[]}],"summary":"The status of a compose"}},"/composes/{id}/clone":{"post":{"operationId":"PostCloneCompose","parameters":[{"description":"ID of the compose","in":"path","name":"id","required":true,"schema":{"example":"123e4567-e89b-12d3-a456-426655440000","format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloneComposeBody"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloneComposeResponse"}}},"description":"The new image is being created"},"400":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"Invalid compose id"},"404":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"Unknown compose id"}},"summary":"Clone an existing compose"}},"/composes/{id}/download":{"get":{"description":"Download the  artifact of a finished compose.","operationId":"GetComposeDownload","parameters":[{"description":"ID of compose to download","in":"path","name":"id","required":true,"schema":{"example":"123e4567-e89b-12d3-a456-426655440000","format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/octet-stream":{"schema":{"format":"binary","type":"string"}}},"description":"The metadata for the given compose."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Invalid compose id"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Auth token is invalid"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Unauthorized to perform operation"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Unknown compose id"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Unexpected error occurred"}},"security":[{"Bearer":[]}],"summary":"Download the artifact for a compose."}},"/composes/{id}/logs":{"get":{"description":"Get the status of a running or finished compose. This includes whether or not it succeeded, and also meta information about the result.","operationId":"GetComposeLogs","parameters":[{"description":"ID of compose status to get","in":"path","name":"id","required":true,"schema":{"example":"123e4567-e89b-12d3-a456-426655440000","format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComposeLogs"}}},"description":"The logs for the given compose, in no particular format (though valid JSON)."},"400":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"Invalid compose id"},"404":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"Unknown compose id"}},"summary":"Get logs for a compose."}},"/composes/{id}/manifests":{"get":{"description":"Get the manifests of a running or finished compose. Returns one manifest for each image in the request. Each manifest conforms to the format defined at https://www.osbuild.org/man/osbuild-manifest.5","operationId":"GetComposeManifests","parameters":[{"description":"ID of compose status to get","in":"path","name":"id","required":true,"schema":{"example":"123e4567-e89b-12d3-a456-426655440000","format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComposeManifests"}}},"description":"The manifest for the given compose."},"400":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"Invalid compose id"},"404":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"Unknown compose id"}},"summary":"Get the manifests for a compose."}},"/composes/{id}/metadata":{"get":{"description":"Get the metadata of a finished compose.\nThe exact information returned depends on the requested image type.","operationId":"GetComposeMetadata","parameters":[{"description":"ID of compose status to get","in":"path","name":"id","required":true,"schema":{"example":"123e4567-e89b-12d3-a456-426655440000","format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComposeMetadata"}}},"description":"The metadata for the given compose."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Invalid compose id"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Auth token is invalid"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Unauthorized to perform operation"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Unknown compose id"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Unexpected error occurred"}},"security":[{"Bearer":[]}],"summary":"Get the metadata for a compose."}},"/composes/{id}/sboms":{"get":{"description":"Returns a set of SBOM documents for each image in the request.\nSBOM documents are in the SPDX format.","operationId":"GetComposeSBOMs","parameters":[{"description":"ID of compose for which to get SBOMs","in":"path","name":"id","required":true,"schema":{"example":"123e4567-e89b-12d3-a456-426655440000","format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComposeSBOMs"}}},"description":"The SBOMs for the given compose."},"400":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"Invalid compose id"},"404":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"Unknown compose id"}},"summary":"Get the SBOMs for a compose."}},"/depsolve/blueprint":{"post":{"operationId":"PostDepsolveBlueprint","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DepsolveRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DepsolveResponse"}}},"description":"Depsolved package list"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Invalid depsolve request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Auth token is invalid"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Unauthorized to perform operation"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Unexpected error occurred"}},"security":[{"Bearer":[]}],"summary":"Depsolve one or more blueprints"}},"/distributions":{"get":{"operationId":"GetDistributionList","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DistributionList"}}},"description":"Distribution repositories"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Unexpected error occurred"}},"security":[{"Bearer":[]}],"summary":"Get all of the supported distribution repository details"}},"/distributions/{distro}":{"get":{"operationId":"GetDistribution","parameters":[{"description":"Name of the distribution","in":"path","name":"distro","required":true,"schema":{"example":"rhel-9.6","type":"string"}},{"description":"Filter by image type. Multiple values can be specified.","in":"query","name":"image_type","schema":{"example":["ami","aws"],"items":{"type":"string"},"type":"array"}},{"description":"Filter by architecture. Multiple values can be specified.","in":"query","name":"architecture","schema":{"example":["x86_64","aarch64"],"items":{"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DistributionDetails"}}},"description":"Distribution details"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Distribution not found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Unexpected error occurred"}},"security":[{"Bearer":[]}],"summary":"Get details for a specific distribution"}},"/errors":{"get":{"operationId":"GetErrorList","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/size"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorList"}}},"description":"A list of errors"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Auth token is invalid"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Unauthorized to perform operation"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Unknown error id"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Unexpected error occurred"}},"security":[{"Bearer":[]}],"summary":"Get a list of all possible errors"}},"/errors/{id}":{"get":{"description":"Get an instance of the error specified by id","operationId":"GetError","parameters":[{"description":"ID of the error","in":"path","name":"id","required":true,"schema":{"example":"13","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Error description"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Auth token is invalid"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Unauthorized to perform operation"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Unknown error id"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Unexpected error occurred"}},"security":[{"Bearer":[]}],"summary":"Get error description"}},"/openapi":{"get":{"operationId":"GetOpenapi","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"openapi spec in json format"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Unexpected error occurred"}},"security":[{"Bearer":[]}],"summary":"Get the openapi spec in json format"}},"/search/packages":{"post":{"operationId":"PostSearchPackages","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchPackagesRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchPackagesResponse"}}},"description":"Search response with package details"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Invalid search request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Auth token is invalid"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Unauthorized to perform operation"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Unexpected error occurred"}},"security":[{"Bearer":[]}],"summary":"Search for detailed information on a list of package names"}}},"servers":[{"description":"Main (production) server","url":"https://api.openshift.com/api/image-builder-composer/v2"},{"description":"Staging server","url":"https://api.stage.openshift.com/api/image-builder-composer/v2"},{"description":"current domain","url":"/api/image-builder-composer/v2"}]}