Save a template project workspace
Validates the effective project tree and saves it as one Git commit on the template repository's default branch.
POST
Validates the effective project tree and saves it as one Git commit on the template repository's default branch.
apiKeyheader
x-api-key<token>id*stringMatch
^tmpl_[0-9a-hjkmnp-tv-z]{16,24}$idempotency-key*stringLength
1 <= length <= 255application/json- body
expectedRevision*stringexpectedHead*stringMatch
^[a-f0-9]{40}$message*stringLength
1 <= length <= 512Success
application/json- response
commit*stringMatch
^[a-f0-9]{40}$parentCommit*stringMatch
^[a-f0-9]{40}$tree*stringMatch
^[a-f0-9]{40}$revision*stringchangedPaths*array<>sourceDigest*stringMatch
^[a-f0-9]{64}$buildDigest*stringMatch
^[a-f0-9]{64}$warnings*array<>incompatibilities*array<>import { createClient } from "samva";
const samva = createClient({ apiKey: process.env.SAMVA_API_KEY! });
const result = await samva.templates.saveWorkspace({
"id": "example",
"expectedRevision": "example",
"expectedHead": "example",
"message": "example"
});Example Response
{
"commit": "string",
"parentCommit": "string",
"tree": "string",
"revision": "string",
"changedPaths": [
"string"
],
"sourceDigest": "string",
"buildDigest": "string",
"warnings": [
{
"code": "string",
"severity": "error",
"message": "string",
"origins": [
{
"fileName": "string",
"lineNumber": 1,
"columnNumber": 1
}
],
"clients": [
"string"
],
"notes": "string",
"provenance": "string",
"fixtures": [
"string"
],
"occurrences": [
[
{
"fileName": "string",
"lineNumber": 1,
"columnNumber": 1
}
]
],
"compatibility": {
"assessment": "risk",
"title": "string"
}
}
],
"incompatibilities": [
{
"code": "string",
"severity": "error",
"message": "string",
"origins": [
{
"fileName": "string",
"lineNumber": 1,
"columnNumber": 1
}
],
"clients": [
"string"
],
"notes": "string",
"provenance": "string",
"fixtures": [
"string"
],
"occurrences": [
[
{
"fileName": "string",
"lineNumber": 1,
"columnNumber": 1
}
]
],
"compatibility": {
"assessment": "risk",
"title": "string"
}
}
]
}