Create one immutable manual-edit source revision.

POST

/api/workspace/admin/ui-project/source-revisions/manual-edit

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Post,
    RequestUri = new Uri("https://example.com/api/workspace/admin/ui-project/source-revisions/manual-edit"),
    Content = new StringContent("{ \"BaseRevisionId\": \"example\", \"BaseSourceChecksum\": \"example\", \"Comment\": \"example\", \"Changes\": [ { \"Operation\": 0, \"Path\": \"example\", \"NewPath\": \"example\", \"ContentUtf8\": \"example\", \"ExpectedContentHash\": \"example\" } ] }")
    {
        Headers =
        {
            ContentType = new MediaTypeHeaderValue("application/json")
        }
    }
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

const url = 'https://example.com/api/workspace/admin/ui-project/source-revisions/manual-edit';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: '{"BaseRevisionId":"example","BaseSourceChecksum":"example","Comment":"example","Changes":[{"Operation":0,"Path":"example","NewPath":"example","ContentUtf8":"example","ExpectedContentHash":"example"}]}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://example.com/api/workspace/admin/ui-project/source-revisions/manual-edit \
  --header 'Content-Type: application/json' \
  --data '{ "BaseRevisionId": "example", "BaseSourceChecksum": "example", "Comment": "example", "Changes": [ { "Operation": 0, "Path": "example", "NewPath": "example", "ContentUtf8": "example", "ExpectedContentHash": "example" } ] }'

Authorizations

None

Parameters

Query Parameters

access_token

string

Optional access token for clients that cannot set Authorization headers. Prefer Authorization: Bearer <token> when possible.

Request Body

Create an immutable manual-edit Workspace UI source revision.

object

BaseRevisionId

Working revision on which the edit is based.

string

nullable

BaseSourceChecksum

Expected checksum of the base revision.

string

nullable

Comment

Optional revision comment.

string

nullable

Changes

Source-file changes to apply to the base revision.

Array<object>

nullable

One source-file change for an immutable Workspace UI revision.

object

Operation

integer format: int32

Allowed values: 0 1 2

Path

Existing or target normalized relative project path.

string

nullable

NewPath

New normalized relative project path for a rename.

string

nullable

ContentUtf8

UTF-8 text content for an upsert.

string

nullable

ExpectedContentHash

Expected SHA-256 hash of the existing file.

string

nullable

Responses

200

application/json

object

Data

Immutable Workspace UI source revision metadata.

object

Revision identifier.

string

nullable

ProjectId

Workspace UI project identifier.

string

nullable

RevisionNumber

Monotonic revision number.

integer format: int32

SourceKind

integer format: int32

Allowed values: 0 1 2 3

Status

integer format: int32

Allowed values: 0 1 2 3 4

Comment

Optional revision comment.

string

nullable

SourceChecksum

SHA-256 checksum of the canonical source tree.

string

nullable

CreatedAt

Creation timestamp.

string format: date-time

CreatedByUserId

Creating user identifier.

string

nullable

FileCount

Number of stored source files.

integer format: int32

Errors

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Warnings

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Success

boolean

Example

{
  "Data": {
    "SourceKind": 0,
    "Status": 0
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

400

Bad Request

application/json

object

Data

Immutable Workspace UI source revision metadata.

object

Revision identifier.

string

nullable

ProjectId

Workspace UI project identifier.

string

nullable

RevisionNumber

Monotonic revision number.

integer format: int32

SourceKind

integer format: int32

Allowed values: 0 1 2 3

Status

integer format: int32

Allowed values: 0 1 2 3 4

Comment

Optional revision comment.

string

nullable

SourceChecksum

SHA-256 checksum of the canonical source tree.

string

nullable

CreatedAt

Creation timestamp.

string format: date-time

CreatedByUserId

Creating user identifier.

string

nullable

FileCount

Number of stored source files.

integer format: int32

Errors

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Warnings

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Success

boolean

Example

{
  "Data": {
    "SourceKind": 0,
    "Status": 0
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

403

Forbidden

application/json

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

key

additional properties

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

409

Conflict

application/json

object

Data

Immutable Workspace UI source revision metadata.

object

Revision identifier.

string

nullable

ProjectId

Workspace UI project identifier.

string

nullable

RevisionNumber

Monotonic revision number.

integer format: int32

SourceKind

integer format: int32

Allowed values: 0 1 2 3

Status

integer format: int32

Allowed values: 0 1 2 3 4

Comment

Optional revision comment.

string

nullable

SourceChecksum

SHA-256 checksum of the canonical source tree.

string

nullable

CreatedAt

Creation timestamp.

string format: date-time

CreatedByUserId

Creating user identifier.

string

nullable

FileCount

Number of stored source files.

integer format: int32

Errors

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Warnings

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Success

boolean

Example

{
  "Data": {
    "SourceKind": 0,
    "Status": 0
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

Create one immutable manual-edit source revision.

Authorizations

Parameters

Query Parameters

Request Body

Responses

200

Example

400

Example

403

Examplegenerated

409

Example

Example^generated