保存草稿
curl --request PUT \
--url https://api-datahub.bazhuayu.com/v1/data-apps/{app_id}/workspace \
--header 'Content-Type: application/json' \
--data '
{
"manifest": "<string>",
"files": {},
"secrets": {},
"expected_revision": 123
}
'import requests
url = "https://api-datahub.bazhuayu.com/v1/data-apps/{app_id}/workspace"
payload = {
"manifest": "<string>",
"files": {},
"secrets": {},
"expected_revision": 123
}
headers = {"Content-Type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({manifest: '<string>', files: {}, secrets: {}, expected_revision: 123})
};
fetch('https://api-datahub.bazhuayu.com/v1/data-apps/{app_id}/workspace', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const options = {
method: 'PUT',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({manifest: '<string>', files: {}, secrets: {}, expected_revision: 123})
};
fetch('https://api-datahub.bazhuayu.com/v1/data-apps/{app_id}/workspace', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api-datahub.bazhuayu.com/v1/data-apps/{app_id}/workspace"
payload := strings.NewReader("{\n \"manifest\": \"<string>\",\n \"files\": {},\n \"secrets\": {},\n \"expected_revision\": 123\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api-datahub.bazhuayu.com/v1/data-apps/{app_id}/workspace")
.header("Content-Type", "application/json")
.body("{\n \"manifest\": \"<string>\",\n \"files\": {},\n \"secrets\": {},\n \"expected_revision\": 123\n}")
.asString();<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-datahub.bazhuayu.com/v1/data-apps/{app_id}/workspace",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'manifest' => '<string>',
'files' => [
],
'secrets' => [
],
'expected_revision' => 123
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}require 'uri'
require 'net/http'
url = URI("https://api-datahub.bazhuayu.com/v1/data-apps/{app_id}/workspace")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"manifest\": \"<string>\",\n \"files\": {},\n \"secrets\": {},\n \"expected_revision\": 123\n}"
response = http.request(request)
puts response.read_bodyusing RestSharp;
var options = new RestClientOptions("https://api-datahub.bazhuayu.com/v1/data-apps/{app_id}/workspace");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddJsonBody("{\n \"manifest\": \"<string>\",\n \"files\": {},\n \"secrets\": {},\n \"expected_revision\": 123\n}", false);
var response = await client.PutAsync(request);
Console.WriteLine("{0}", response.Content);
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"manifest\": \"<string>\",\n \"files\": {},\n \"secrets\": {},\n \"expected_revision\": 123\n}")
val request = Request.Builder()
.url("https://api-datahub.bazhuayu.com/v1/data-apps/{app_id}/workspace")
.put(body)
.addHeader("Content-Type", "application/json")
.build()
val response = client.newCall(request).execute()false{
"app_name": "<string>",
"app_id": "<string>",
"namespace": "<string>",
"revision": 123,
"valid": true,
"issues": [
{
"path": "<string>",
"message": "<string>"
}
],
"missing_secrets": [
"<string>"
],
"secrets_deferred": [
"<string>"
],
"name_reused_from": "<string>"
}发布与运营
保存草稿
保存 App 的可变草稿(工作区);校验不通过也能保存,结果随响应返回。
PUT
/
v1
/
data-apps
/
{app_id}
/
workspace
保存草稿
curl --request PUT \
--url https://api-datahub.bazhuayu.com/v1/data-apps/{app_id}/workspace \
--header 'Content-Type: application/json' \
--data '
{
"manifest": "<string>",
"files": {},
"secrets": {},
"expected_revision": 123
}
'import requests
url = "https://api-datahub.bazhuayu.com/v1/data-apps/{app_id}/workspace"
payload = {
"manifest": "<string>",
"files": {},
"secrets": {},
"expected_revision": 123
}
headers = {"Content-Type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({manifest: '<string>', files: {}, secrets: {}, expected_revision: 123})
};
fetch('https://api-datahub.bazhuayu.com/v1/data-apps/{app_id}/workspace', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const options = {
method: 'PUT',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({manifest: '<string>', files: {}, secrets: {}, expected_revision: 123})
};
fetch('https://api-datahub.bazhuayu.com/v1/data-apps/{app_id}/workspace', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api-datahub.bazhuayu.com/v1/data-apps/{app_id}/workspace"
payload := strings.NewReader("{\n \"manifest\": \"<string>\",\n \"files\": {},\n \"secrets\": {},\n \"expected_revision\": 123\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api-datahub.bazhuayu.com/v1/data-apps/{app_id}/workspace")
.header("Content-Type", "application/json")
.body("{\n \"manifest\": \"<string>\",\n \"files\": {},\n \"secrets\": {},\n \"expected_revision\": 123\n}")
.asString();<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-datahub.bazhuayu.com/v1/data-apps/{app_id}/workspace",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'manifest' => '<string>',
'files' => [
],
'secrets' => [
],
'expected_revision' => 123
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}require 'uri'
require 'net/http'
url = URI("https://api-datahub.bazhuayu.com/v1/data-apps/{app_id}/workspace")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"manifest\": \"<string>\",\n \"files\": {},\n \"secrets\": {},\n \"expected_revision\": 123\n}"
response = http.request(request)
puts response.read_bodyusing RestSharp;
var options = new RestClientOptions("https://api-datahub.bazhuayu.com/v1/data-apps/{app_id}/workspace");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddJsonBody("{\n \"manifest\": \"<string>\",\n \"files\": {},\n \"secrets\": {},\n \"expected_revision\": 123\n}", false);
var response = await client.PutAsync(request);
Console.WriteLine("{0}", response.Content);
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"manifest\": \"<string>\",\n \"files\": {},\n \"secrets\": {},\n \"expected_revision\": 123\n}")
val request = Request.Builder()
.url("https://api-datahub.bazhuayu.com/v1/data-apps/{app_id}/workspace")
.put(body)
.addHeader("Content-Type", "application/json")
.build()
val response = client.newCall(request).execute()false{
"app_name": "<string>",
"app_id": "<string>",
"namespace": "<string>",
"revision": 123,
"valid": true,
"issues": [
{
"path": "<string>",
"message": "<string>"
}
],
"missing_secrets": [
"<string>"
],
"secrets_deferred": [
"<string>"
],
"name_reused_from": "<string>"
}端点
PUT https://api-datahub.bazhuayu.com/v1/data-apps/{app_id}/workspace
404。
保存 App 的可变草稿。保存永远不会因校验失败而被拒绝:完整校验照常运行,结果(valid / issues)随响应一起返回。「先存一半,回头再改」是模型承诺。
App 身份在第一次保存时隐式创建,没有单独的「创建 App」端点。只有三条最小硬检查(400):账号已有用户名、内容在大小限制内、随附文件名合法。manifest 里的 identity.app_name 不再与路径比对:路由名跟随引用,文件里声明的名字只在创建时消费一次。
expected_revision 提供乐观并发控制(409 revision-conflict),多个标签页不会静默互相覆盖。随附的密钥只在本次保存有效时才存储,未存储的名称通过 secrets_deferred 报告。已弃用的 App 仍可编辑;被拒绝的只是新的 Release。
请求
路径参数
string
必填
App 引用,
app_<hex> 或 <namespace>/<app_name>。首次保存时用后者。请求体
string
必填
manifest 原文。
object
随附文件,键为相对路径,值为文本内容。
object
随附的密钥名到明文的映射,本次保存有效时才存储。
integer
期望的当前草稿版本号,不一致则
409。示例请求
curl -X PUT \
-H "Authorization: Bearer $BAZHUAYU_API_KEY" \
-H "Content-Type: application/json" \
-d '{"manifest": "spec_version: \"0.2\"\n…", "files": {}, "expected_revision": 3}' \
"https://api-datahub.bazhuayu.com/v1/data-apps/carol/reviews-query/workspace"
响应
200 成功
{
"data": {
"app_name": "string",
"app_id": "string",
"namespace": "string",
"revision": 0,
"valid": false,
"issues": [
{
"path": "string",
"message": "string"
}
],
"missing_secrets": [
"string"
],
"secrets_deferred": [
"string"
],
"name_reused_from": "string"
}
}
data 字段中,其内容如下。
string
必填
—
string
必填
App 的稳定标识。
string
—
integer
必填
保存后的草稿版本号。
boolean
必填
当前内容是否通过校验。
string[]
—
string[]
因本次保存无效而未存储的密钥名。
string
—
错误
| HTTP | code | category | 说明 |
|---|---|---|---|
| 401 | unauthorized | forbidden | 缺少或无效的 API Key。 |
| 400 | username-required | invalid_input | 账号尚未设置用户名,无法形成 <username>/<app_name> 引用。 |
| 409 | revision-conflict | invalid_input | expected_revision 与当前草稿版本号不一致,说明有并发修改。 |
| 400 | invalid-app-name | invalid_input | 名称不符合命名规则或是保留字。 |
| 409 | app-name-reserved | forbidden | 该名称被他人的历史绑定占用(用户名易主后的 30 天冻结期)。 |
| 413 | payload-too-large | invalid_input | 请求体超过大小限制。 |
{"error": {code, category, message, retryable}},见错误。
