files

Dateien ändern

Wendet put-, delete- und move-Operationen als EINEN Verlaufseintrag an. Für jede Operation kann der gelesene expected_hash angegeben werden. Wurde eine Datei inzwischen geändert, wird ein 409 mit der aktuellen Revision zurückgegeben und nichts geschrieben. Verwenden Sie für Texte, Einträge und Geschäftsinformationen vorzugsweise die Content-Endpunkte: Sie validieren die Daten anhand des Content-Modells der Website und können deren Layout nicht beschädigen.

POST/v1/sites/{site_id}/commits

Request

curl --request POST \
  --url 'https://api.atelier201.com/v1/sites/<site_id>/commits' \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "summary": "<string>",
  "operations": [
    {
      "op": "<string>",
      "path": "<string>",
      "content": "<string>"
    }
  ]
}'

import json
import requests

url = "https://api.atelier201.com/v1/sites/<site_id>/commits"
headers = {
  "Authorization": "<api-key>",
  "Content-Type": "application/json"
}
payload = json.loads("{\"summary\":\"<string>\",\"operations\":[{\"op\":\"<string>\",\"path\":\"<string>\",\"content\":\"<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>/commits", {
  method: "POST",
  headers: {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "summary": "<string>",
    "operations": [
      {
        "op": "<string>",
        "path": "<string>",
        "content": "<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>/commits");
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>\",\"operations\":[{\"op\":\"<string>\",\"path\":\"<string>\",\"content\":\"<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>/commits", bytes.NewBuffer([]byte("{\"summary\":\"<string>\",\"operations\":[{\"op\":\"<string>\",\"path\":\"<string>\",\"content\":\"<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>/commits"))
    .header("Authorization", "<api-key>")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\"summary\":\"<string>\",\"operations\":[{\"op\":\"<string>\",\"path\":\"<string>\",\"content\":\"<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>/commits")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "<api-key>"
request["Content-Type"] = "application/json"
request.body = "{\"summary\":\"<string>\",\"operations\":[{\"op\":\"<string>\",\"path\":\"<string>\",\"content\":\"<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>"
      }
    ],
    "build": {
      "id": "<string>",
      "state": "<string>",
      "next_action": "<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 kein Guthaben. Ändert nur den Entwurf. Besucher sehen die Änderungen erst, wenn Sie sie veröffentlichen.

Verwenden Sie diesen Endpunkt, um Code zu ändern: Layouts, Komponenten oder das Inhaltsmodell. Für Texte, Einträge und Geschäftsdaten verwenden Sie die Inhaltsendpunkte. Diese prüfen die Angaben anhand des Inhaltsmodells und können das Layout nicht beschädigen.

Änderungen anderer nicht überschreiben

Geben Sie bei jeder Operation den gelesenen hash als expected_hash an. Wurde eine dieser Dateien inzwischen geändert, wird die gesamte Änderung mit 409 conflict abgelehnt und nichts geschrieben. Die details des Fehlers enthalten die aktuelle Revision:

JSON{
  "error": {
    "code": "conflict",
    "details": {
      "reason": "revision_conflict",
      "current_revision": "9f2c...",
      "paths": [
        { "path": "src/pages/index.astro", "expected": "a1b2...", "found": "c3d4..." }
      ]
    }
  },
  "request_id": "req_01K9X7"
}

Lesen Sie die Dateien in paths erneut aus. Für jede Datei sind dort der erwartete und der gefundene Hash aufgeführt. Nehmen Sie Ihre Änderung auf dieser Grundlage vor und versuchen Sie es erneut. base_revision gibt an, welche Revision Sie gelesen haben. Die Änderung wird trotzdem angewendet, wenn sich die bearbeiteten Dateien nicht geändert haben.

Halten Sie die Website als statische Astro-Website: ohne Server-Adapter und ohne serverseitiges Rendering.

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 Text für den Verlaufseintrag, den Nutzer lesen.

base_revisionstringlength: 40–40 chars

Die Revision, die du gelesen hast. Die Änderung wird trotzdem übernommen, wenn sich die betroffenen Dateien seitdem nicht geändert haben. Andernfalls erhältst du 409 mit der aktuellen Revision.

operationsobject | object | object[]requireditems: 1–500 items

Show child attributes

operations.opstringrequired

operations.pathstringrequiredlength: 1–600 chars

operations.contentstringrequired

operations.encodingenum<string>one of: utf8, base64

operations.expected_hashstringnull

Der Hash, den du gelesen hast (null: die Datei darf noch nicht existieren). Bei einer Abweichung wird die gesamte Änderung abgelehnt.

Antwort

application/json

Dateien ändern (ein Commit)

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.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

request_idstringrequired

curl --request POST \ --url 'https://api.atelier201.com/v1/sites/<site_id>/commits' \ --header 'Authorization: <api-key>' \ --header 'Content-Type: application/json' \ --data '{ "summary": "<string>", "operations": [ { "op": "<string>", "path": "<string>", "content": "<string>" } ] }'

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

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

Dateien ändern

Änderungen anderer nicht überschreiben

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