publishing

Vor der Veröffentlichung prüfen

Nimmt keine Änderungen vor. Zeigt, welcher Build veröffentlicht würde, ob es sich um den neuesten Entwurf handelt, was die Veröffentlichung verhindert und welchen Wert für expected_generation du an publishSite übergeben musst, damit nur DER geprüfte Stand veröffentlicht wird.

GET/v1/sites/{site_id}/publish/review

Request

curl --request GET \
  --url 'https://api.atelier201.com/v1/sites/<site_id>/publish/review' \
  --header 'Authorization: <api-key>'

import json
import requests

url = "https://api.atelier201.com/v1/sites/<site_id>/publish/review"
headers = {
  "Authorization": "<api-key>"
}

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

const response = await fetch("https://api.atelier201.com/v1/sites/<site_id>/publish/review", {
  method: "GET",
  headers: {
    "Authorization": "<api-key>"
  },
});

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>/publish/review");
curl_setopt($client, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($client, CURLOPT_HTTPHEADER, [
    "Authorization: <api-key>",
]);
curl_setopt($client, CURLOPT_RETURNTRANSFER, true);

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

package main

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

func main() {
  req, _ := http.NewRequest("GET", "https://api.atelier201.com/v1/sites/<site_id>/publish/review", nil)
  req.Header.Set("Authorization", "<api-key>")
  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>/publish/review"))
    .header("Authorization", "<api-key>")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .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>/publish/review")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "<api-key>"

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": {
    "site_id": "<string>",
    "url": "<string>",
    "platform_address": {
      "slug": "<string>",
      "domain": "<string>",
      "is_main": true
    },
    "build": {
      "id": "<string>",
      "site_id": "<string>",
      "revision": "<string>",
      "state": "queued",
      "target_origin": "<string>",
      "profile": "standard",
      "file_count": 123,
      "total_bytes": 123,
      "duration_ms": 123,
      "error": {
        "code": "<string>",
        "message": null
      },
      "warnings": [
        "<string>"
      ],
      "created_at": "<string>",
      "started_at": "<string>",
      "finished_at": "<string>"
    },
    "revision": "<string>",
    "draft_revision": "<string>",
    "is_latest_draft": true,
    "live_build_id": null,
    "expected_generation": 123,
    "can_publish": true,
    "blockers": [
      {
        "code": "<string>",
        "message": "<string>"
      }
    ],
    "warnings": [
      {
        "code": "<string>",
        "message": "<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:read. Es werden keine Änderungen vorgenommen.

Rufen Sie diese Funktion vor jeder Veröffentlichung auf und zeigen Sie der Person das Ergebnis. Senden Sie expected_generation an Einen Build veröffentlichen, damit nur der geprüfte Stand live geht.

Ein Build kann nicht veröffentlicht werden, solange blockers nicht leer ist. Jeder Blocker hat einen code und eine message: guest_site, site_unavailable, plan_required (die Website ist ein Entwurf: Für die Veröffentlichung ist der Site-Tarif erforderlich), no_build, build_not_ready, origin_changed, manual_check (diese Version wartet auf eine kurze Prüfung unsererseits: Es gibt nichts zu beheben) oder older_than_draft. Weitere Informationen unter So geht eine Website live.

warnings verhindern die Veröffentlichung nicht. Lesen Sie sie vor der Veröffentlichung: sample_text nennt Beispielttexte, die noch vorhanden sind, etwa Lorem ipsum, einschließlich Datei und Zeile.

Autorisierung

Authorizationbearerin headerrequired

Pfadparameter

site_idstringrequired

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

Query-Parameter

build_idstring<uuid>pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

allow_older_buildboolean

Einen Build prüfen, der älter als der Entwurf ist und den du veröffentlichen möchtest. older_than_draft ist in diesem Fall ein Hinweis, kein Hindernis.

Antwort

application/json

Vor der Veröffentlichung prüfen

dataobjectrequired

Show child attributes

data.site_idstringrequired

data.urlstringrequired

data.platform_addressobjectrequired

Die mit der Website gelieferte Adresse, die set_site_address ändert. is_main: Besucher landen auf dieser Adresse, solange keine eigene Domain übernommen wurde.

Show child attributes

data.platform_address.slugstringrequired

data.platform_address.domainstringrequired

data.platform_address.is_mainbooleanrequired

data.buildobject | nullrequired

Show child attributes

data.build.idstringrequired

data.build.site_idstringrequired

data.build.revisionstringrequiredlength: 40–40 chars

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

data.build.stateenum<string>requiredone of: queued, building, collecting, ready, failed, cancelled

data.build.target_originstringrequired

data.build.profileenum<string>requiredone of: standard, guest-demo

data.build.file_countinteger | nullrequired

data.build.total_bytesinteger | nullrequired

data.build.duration_msinteger | nullrequired

data.build.errorobject | nullrequired

Show child attributes

data.build.error.codestringrequired

data.build.error.messagestringnullrequired

data.build.warningsstring[]required

data.build.created_atstringrequired

ISO 8601, UTC.

data.build.started_atstring | nullrequired

data.build.finished_atstring | nullrequired

data.revisionstring | nullrequired

data.draft_revisionstring | nullrequired

data.is_latest_draftbooleanrequired

data.live_build_idstringnullrequired

data.expected_generationintegerrequiredrange: -9007199254740991–9007199254740991

data.can_publishbooleanrequired

data.blockersobject[]required

Show child attributes

data.blockers.codestringrequired

data.blockers.messagestringrequired

data.warningsobject[]required

Zulässig, aber eine bewusste Entscheidung. older_than_draft bedeutet hier, dass der geprüfte Build älter als der Entwurf ist und zugelassen wurde (allow_older_build), oder dass keine build_id angegeben wurde.

Show child attributes

data.warnings.codestringrequired

data.warnings.messagestringrequired

request_idstringrequired

{ "data": { "site_id": "<string>", "url": "<string>", "platform_address": { "slug": "<string>", "domain": "<string>", "is_main": true }, "build": { "id": "<string>", "site_id": "<string>", "revision": "<string>", "state": "queued", "target_origin": "<string>", "profile": "standard", "file_count": 123, "total_bytes": 123, "duration_ms": 123, "error": { "code": "<string>", "message": null }, "warnings": [ "<string>" ], "created_at": "<string>", "started_at": "<string>", "finished_at": "<string>" }, "revision": "<string>", "draft_revision": "<string>", "is_latest_draft": true, "live_build_id": null, "expected_generation": 123, "can_publish": true, "blockers": [ { "code": "<string>", "message": "<string>" } ], "warnings": [ { "code": "<string>", "message": "<string>" } ] }, "request_id": "<string>" }

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

Vor der Veröffentlichung prüfen

Autorisierung

Pfadparameter

Query-Parameter

Antwort

Use these docs with your AI tools

Query these docs via MCP

Query these docs over HTTP

Read these docs as Markdown

Cookies