sites

Workspace-Änderungen übernehmen

Speichert alle uncommitted Änderungen des Workspace als EINEN Verlaufseintrag, nach Prüfung durch den Commit-Schutz (keine Geheimnisse, keine .env-Dateien, kein Servercode, gültiges JSON). Nichts zu committen: changed ist false.

POST/v1/sites/{site_id}/workspace:commit

Request

curl --request POST \
  --url 'https://api.atelier201.com/v1/sites/<site_id>/workspace:commit' \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "summary": "<string>"
}'

import json
import requests

url = "https://api.atelier201.com/v1/sites/<site_id>/workspace:commit"
headers = {
  "Authorization": "<api-key>",
  "Content-Type": "application/json"
}
payload = json.loads("{\"summary\":\"<string>\"}")

response = requests.request("POST", url, headers=headers, json=payload)
print(response.json())

const response = await fetch("https://api.atelier201.com/v1/sites/<site_id>/workspace:commit", {
  method: "POST",
  headers: {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "summary": "<string>"
  }),
});

const data = await response.json();
console.log(data);

<?php
$client = curl_init();

curl_setopt($client, CURLOPT_URL, "https://api.atelier201.com/v1/sites/<site_id>/workspace:commit");
curl_setopt($client, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($client, CURLOPT_HTTPHEADER, [
    "Authorization: <api-key>",
    "Content-Type: application/json",
]);
curl_setopt($client, CURLOPT_POSTFIELDS, "{\"summary\":\"<string>\"}");
curl_setopt($client, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($client);
curl_close($client);
echo $response;

package main

import (
  "bytes"
  "fmt"
  "io"
  "net/http"
)

func main() {
  req, _ := http.NewRequest("POST", "https://api.atelier201.com/v1/sites/<site_id>/workspace:commit", bytes.NewBuffer([]byte("{\"summary\":\"<string>\"}")))
  req.Header.Set("Authorization", "<api-key>")
  req.Header.Set("Content-Type", "application/json")
  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  data, _ := io.ReadAll(res.Body)
  fmt.Println(string(data))
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

var request = HttpRequest.newBuilder(URI.create("https://api.atelier201.com/v1/sites/<site_id>/workspace:commit"))
    .header("Authorization", "<api-key>")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\"summary\":\"<string>\"}"))
    .build();

var response = HttpClient.newHttpClient().send(
    request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

require 'net/http'
require 'json'

uri = URI("https://api.atelier201.com/v1/sites/<site_id>/workspace:commit")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "<api-key>"
request["Content-Type"] = "application/json"
request.body = "{\"summary\":\"<string>\"}"

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
  http.request(request)
end

puts response.body

application/json

{
  "data": {
    "revision": "<string>",
    "parent": "<string>",
    "changed": true,
    "changes": [
      {
        "path": "<string>",
        "action": "<string>"
      }
    ],
    "note": null,
    "build": {
      "id": "<string>",
      "state": "<string>",
      "next_action": "<string>"
    },
    "not_committed": [
      "<string>"
    ],
    "warning": "<string>"
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

Erfordert sites:write. Kostet keine Credits. Der Pfad endet mit /workspace:commit. Änderungen betreffen nur den Entwurf. Besucher sehen nichts, bis Sie die Website veröffentlichen.

Alle nicht übernommenen Änderungen des Workspace werden zu einem Verlaufseintrag zusammengefasst, unabhängig von der Anzahl der Dateien. summary ist erforderlich und darf höchstens 500 Zeichen umfassen: ein Satz dazu, was die Änderung bewirkt. Diesen Satz sehen Nutzer im Verlauf.

Für alle Änderungen gilt dieselbe Commit-Prüfung. Ein Geheimnis, eine .env-Datei, Servercode oder ungültiges JSON wird mit 400 und einer Begründung abgelehnt; es wird nichts gespeichert. Korrigieren Sie die Datei im Workspace und versuchen Sie es erneut. Alle Fundstellen werden auf einmal mit Datei und Zeile aufgeführt.

Eine Datei, die in der .gitignore des Projekts aufgeführt ist (etwa .env.local oder eine Schlüsseldatei), wird nie in einen Commit aufgenommen und daher auch nicht abgelehnt, sondern ausgelassen. Wenn eine solche Datei wie ein Geheimnis aussieht, wird sie in der Antwort unter not_committed mit einer warning aufgeführt: Sie wurde nicht gespeichert, gelangt nie auf die Website und geht beim Neustart des Workspace verloren.

Wenn keine nicht übernommenen Änderungen vorliegen, ist der Aufruf mit changed: false erfolgreich und es wird kein neuer Eintrag angelegt. Andernfalls enthält revision den neuen Eintrag, parent den vorherigen und changes die betroffenen Pfade. Wurde der Entwurf zwischenzeitlich anderweitig geändert, werden Ihre Bearbeitungen übernommen und note weist darauf hin.

Als Nächstes können Sie einen Build starten, um das Ergebnis in einer Vorschau anzusehen.

Autorisierung

Authorizationbearerin headerrequired

Pfadparameter

site_idstringrequired

ID der Website oder ihr Slug (die Adresse vor .atelier201.page).

Body

application/jsonrequired

summarystringrequiredlength: 1–500 chars

Was die Änderung bewirkt, in einem Satz: der Verlaufseintrag, den Nutzer lesen.

Antwort

application/json

Die Änderungen des Workspace committen

dataobjectrequired

Show child attributes

data.revisionstringrequiredlength: 40–40 chars

Eine Git-Commit-ID (40 hexadezimale Zeichen) des Repositorys der Website.

data.parentstring | nullrequired

data.changedbooleanrequired

data.changesobject[]required

Show child attributes

data.changes.pathstringrequired

data.changes.actionstringrequired

data.notestringnullrequired

data.buildobject | nullrequired

Der Build, den diese Änderung gestartet oder übernommen hat: Die Vorschau folgt diesem Build. Kein Aufruf von build_site erforderlich.

Show child attributes

data.build.idstringrequired

data.build.statestringrequired

data.build.next_actionstringrequired

data.not_committedstring[]

Dateien, die wie Geheimnisse aussehen (z. B. .env.local oder eine Schlüsseldatei) und die der .gitignore des Projekts von jedem Commit ausschließt: Sie werden niemals gespeichert oder veröffentlicht.

data.warningstring

In einem Satz erklären, was not_committed bedeutet.

request_idstringrequired

curl --request POST \ --url 'https://api.atelier201.com/v1/sites/<site_id>/workspace:commit' \ --header 'Authorization: <api-key>' \ --header 'Content-Type: application/json' \ --data '{ "summary": "<string>" }'

{ "data": { "revision": "<string>", "parent": "<string>", "changed": true, "changes": [ { "path": "<string>", "action": "<string>" } ], "note": null, "build": { "id": "<string>", "state": "<string>", "next_action": "<string>" }, "not_committed": [ "<string>" ], "warning": "<string>" }, "request_id": "<string>" }

{ "error": { "type": "<string>", "code": "<string>", "message": "<string>", "param": "<string>", "docs_url": "<string>", "action_url": "<string>", "details": {} }, "request_id": "<string>" }

Workspace-Änderungen übernehmen

Autorisierung

Pfadparameter

Body

Antwort

Use these docs with your AI tools

Query these docs via MCP

Query these docs over HTTP

Read these docs as Markdown

Cookies