latestOpenAPI 3.0.02026-08-10221235717.8 KB

e21ad140ec3c

public
ArtefactVersion

Convert a Score specification, optional overrides, and extensions into the contents for a deployment set.

post/orgs/{orgId}/artefact-versions/convert-score

Path parameters

orgIdstring required

The organization ID.

Request body

specobject required

A Json object containing the workload specification. Score v1b1 is expected.

imagestring

An optional default image to assign to any containers in the workload that do not have an image set or whose image is '.'

overridesobject

An optional Json object containing the workload overrides. Score v1b1 is expected.

property_overridesobject

An optional set of path overrides that will be applied to the workload.

resource_type_aliasesobject

An optional set of resource types overrides that will be applied in the deployment set.

Example request

{
  "spec": {
    "apiVersion": "score.dev/v1b1",
    "metadata": {
      "name": "hello-world"
    }
  },
  "image": "busybox:latest",
  "overrides": {
    "apiVersion": "score.dev/v1b1",
    "profile": "humanitec/default-module"
  },
  "property_overrides": {
    "containers.my-container.image": "busybox:latest",
    "containers.my-container.variables.DEBUG": null
  },
  "resource_type_aliases": {
    "s3": "my-org/s3"
  },
  "extensions": {
    "apiVersion": "humanitec.org/v1b1",
    "profile": "humanitec/default-module",
    "spec": {
      "labels": {
        "my-label": "my-value"
      }
    }
  }
}

Response

The deployment set contents.

modulesobject required

The set of workloads to add when deployed, the key is the name of the workload.

sharedobject required

The set of shared resources to depend on, the key is the resource identifier.