Project

Get VersionSet

Gets a single ProjectVersionSet A ProjectVersionSet represents a configuration, layout or structure of a Project that is consistent for a range of ProjectReleases. A ProjectComponent is associated with a single ProjectVersionSet. We track changes to the componentry and structure of a Project over time using ProjectVersionSets. ProjectVersionSets are uniquely identified by the Project ID or Alias and a simple integer, separated by a ':' character. Examples of ProjectVersionSet identifiers: * argo-workflows:1: the first ProjectVersionSet of the Argo Workflows Project, using the "argo-workflows" Alias as the identifier. * proj_dda0b12f-9a76-43ff-a024-9839ed3ee57b:3 the third ProjectVersionSet of the Argo Workflows Project, using the Argo Workflow Project's UUID as the identifier. Each ProjectVersionSet has a Constraint field that is a Semantic Versioning 2 Version Constraint, e.g. >=1.2.1 or <2.34.50. This Version Constraint indicates which ProjectReleases the ProjectVersionSet describes.

GET

projects

{project}

versionsets

{number}

Get VersionSet

curl --request GET \
  --url https://api.example.com/projects/{project}/versionsets/{number}/

{
  "created_by": "<string>",
  "created_on": "2023-11-07T05:31:56Z",
  "last_modified_by": "<string>",
  "last_modified_on": "2023-11-07T05:31:56Z",
  "number": 1,
  "project": "<string>",
  "version_constraint": "<string>",
  "$schema": "<string>"
}

Response

created_by

string

required

user who created the record.

created_on

string<date-time>

required

timestamp of when the record was created.

last_modified_by

string

required

user who last modified the record.

last_modified_on

string<date-time>

required

timestamp of when the record was last modified.

number

integer<int64>

required

The sequence number of this ProjectVersionSet. Represents the number of times a change to the Project's configuration, component breakdown or architecture has been tracked.

Required range: x >= 0

Example:

1

project

string

required

ID of the Project for this ProjectVersionSet.

Example:

"proj_fc8c119c-0741-4062-8959-fe1a04b3842f"

version_constraint

string

required

Version constraint that describes which range of Project Release versions this ProjectVersionSet applies to.

Example:

">=1.0 <2"

$schema

string<uri>

read-only

A URL to the JSON Schema for this object.

Example:

"https://example.com/schemas/ProjectVersionSet.json"

Update VersionSetUpdate an existing ProjectVersionSet A ProjectVersionSet represents a configuration, layout or structure of a Project that is consistent for a range of ProjectReleases. A ProjectComponent is associated with a single ProjectVersionSet. We track changes to the componentry and structure of a Project over time using ProjectVersionSets. ProjectVersionSets are uniquely identified by the Project ID or Alias and a simple integer, separated by a ':' character. Examples of ProjectVersionSet identifiers: * argo-workflows:1: the first ProjectVersionSet of the Argo Workflows Project, using the "argo-workflows" Alias as the identifier. * proj_dda0b12f-9a76-43ff-a024-9839ed3ee57b:3 the third ProjectVersionSet of the Argo Workflows Project, using the Argo Workflow Project's UUID as the identifier. Each ProjectVersionSet has a Constraint field that is a Semantic Versioning 2 Version Constraint, e.g. >=1.2.1 or <2.34.50. This Version Constraint indicates which ProjectReleases the ProjectVersionSet describes.

⌘I

Get VersionSet

curl --request GET \
  --url https://api.example.com/projects/{project}/versionsets/{number}/

{
  "created_by": "<string>",
  "created_on": "2023-11-07T05:31:56Z",
  "last_modified_by": "<string>",
  "last_modified_on": "2023-11-07T05:31:56Z",
  "number": 1,
  "project": "<string>",
  "version_constraint": "<string>",
  "$schema": "<string>"
}