@atelier201/cli 0.14.0 → 0.16.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/AGENTS.md +3 -0
- package/README.md +4 -0
- package/dist/api-types.generated.js.map +1 -1
- package/dist/commands/analytics.js +41 -8
- package/dist/commands/analytics.js.map +1 -1
- package/dist/commands/api.js +10 -1
- package/dist/commands/api.js.map +1 -1
- package/dist/commands/content.js +1 -1
- package/dist/commands/content.js.map +1 -1
- package/dist/commands/settings.js +58 -0
- package/dist/commands/settings.js.map +1 -0
- package/dist/http.js +12 -1
- package/dist/http.js.map +1 -1
- package/dist/index.js +2 -0
- package/dist/index.js.map +1 -1
- package/dist/operations.generated.js +1772 -767
- package/dist/operations.generated.js.map +1 -1
- package/package.json +1 -1
|
@@ -7220,7 +7220,7 @@ export const API_OPERATIONS = [
|
|
|
7220
7220
|
"method": "GET",
|
|
7221
7221
|
"path": "/v1/sites/{site_id}/analytics",
|
|
7222
7222
|
"summary": "Read a site's visitor numbers",
|
|
7223
|
-
"description": "Page views of the live site by people, with pages, sources, countries and devices, over a period (a preset, or from and to). No credits. Visitor figures are null when the owner turned visitor counting off, which only the owner can change, in the dashboard.",
|
|
7223
|
+
"description": "Page views of the live site by people, with pages, sources, countries and devices, over a period (a preset, or from and to). With filter, one channel, assistant, source, page, country or device and where its views went (the pages people from ChatGPT landed on). No credits. Visitor figures are null when the owner turned visitor counting off, which only the owner can change, in the dashboard.",
|
|
7224
7224
|
"authentication_required": true,
|
|
7225
7225
|
"scope": "sites:read",
|
|
7226
7226
|
"surfaces": {
|
|
@@ -7272,6 +7272,26 @@ export const API_OPERATIONS = [
|
|
|
7272
7272
|
"type": "string",
|
|
7273
7273
|
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
|
|
7274
7274
|
}
|
|
7275
|
+
},
|
|
7276
|
+
{
|
|
7277
|
+
"name": "sections",
|
|
7278
|
+
"in": "query",
|
|
7279
|
+
"required": false,
|
|
7280
|
+
"schema": {
|
|
7281
|
+
"description": "Only these parts besides the totals, comma-separated: series, pages, sources, channels, assistants, countries, devices, browsers, os, robots, markdown, not_found, forms. robots also brings bot_views. Leave it out for everything. A smaller answer costs less context.",
|
|
7282
|
+
"type": "string",
|
|
7283
|
+
"maxLength": 200
|
|
7284
|
+
}
|
|
7285
|
+
},
|
|
7286
|
+
{
|
|
7287
|
+
"name": "filter",
|
|
7288
|
+
"in": "query",
|
|
7289
|
+
"required": false,
|
|
7290
|
+
"schema": {
|
|
7291
|
+
"description": "Only the views of one channel, assistant, source, page, country or device, as dimension:value, e.g. assistant:ChatGPT, channel:ai, source:google.com, page:/menu, country:FR, device:mobile. The other breakdowns then show where those views went: the pages people from ChatGPT arrived on, the countries that read the menu. Covers the last 85 days. With a filter only series, pages, sources, channels, assistants, countries and devices come back, and visits and form sends are null.",
|
|
7292
|
+
"type": "string",
|
|
7293
|
+
"maxLength": 220
|
|
7294
|
+
}
|
|
7275
7295
|
}
|
|
7276
7296
|
],
|
|
7277
7297
|
"request_body": null,
|
|
@@ -7287,6 +7307,36 @@ export const API_OPERATIONS = [
|
|
|
7287
7307
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
7288
7308
|
"type": "object",
|
|
7289
7309
|
"properties": {
|
|
7310
|
+
"filter": {
|
|
7311
|
+
"description": "Present when the answer is filtered: every figure below is about those views only.",
|
|
7312
|
+
"type": "object",
|
|
7313
|
+
"properties": {
|
|
7314
|
+
"dimension": {
|
|
7315
|
+
"type": "string",
|
|
7316
|
+
"enum": [
|
|
7317
|
+
"channel",
|
|
7318
|
+
"assistant",
|
|
7319
|
+
"source",
|
|
7320
|
+
"page",
|
|
7321
|
+
"country",
|
|
7322
|
+
"device"
|
|
7323
|
+
]
|
|
7324
|
+
},
|
|
7325
|
+
"value": {
|
|
7326
|
+
"type": "string"
|
|
7327
|
+
},
|
|
7328
|
+
"arrivals_only": {
|
|
7329
|
+
"type": "boolean",
|
|
7330
|
+
"description": "True for a channel, assistant or source: only the views people ARRIVED on are theirs, so pages are the pages they landed on, not every page they read after."
|
|
7331
|
+
}
|
|
7332
|
+
},
|
|
7333
|
+
"required": [
|
|
7334
|
+
"dimension",
|
|
7335
|
+
"value",
|
|
7336
|
+
"arrivals_only"
|
|
7337
|
+
],
|
|
7338
|
+
"additionalProperties": false
|
|
7339
|
+
},
|
|
7290
7340
|
"period": {
|
|
7291
7341
|
"type": "string",
|
|
7292
7342
|
"enum": [
|
|
@@ -7349,8 +7399,11 @@ export const API_OPERATIONS = [
|
|
|
7349
7399
|
]
|
|
7350
7400
|
},
|
|
7351
7401
|
"form_sends": {
|
|
7352
|
-
"
|
|
7353
|
-
"
|
|
7402
|
+
"description": "Form sends the site kept, spam aside. Counted on every site: a send carries no visitor hash. Null with a filter.",
|
|
7403
|
+
"type": [
|
|
7404
|
+
"number",
|
|
7405
|
+
"null"
|
|
7406
|
+
]
|
|
7354
7407
|
}
|
|
7355
7408
|
},
|
|
7356
7409
|
"required": [
|
|
@@ -7404,8 +7457,11 @@ export const API_OPERATIONS = [
|
|
|
7404
7457
|
]
|
|
7405
7458
|
},
|
|
7406
7459
|
"form_sends": {
|
|
7407
|
-
"
|
|
7408
|
-
"
|
|
7460
|
+
"description": "Form sends the site kept, spam aside. Counted on every site: a send carries no visitor hash. Null with a filter.",
|
|
7461
|
+
"type": [
|
|
7462
|
+
"number",
|
|
7463
|
+
"null"
|
|
7464
|
+
]
|
|
7409
7465
|
}
|
|
7410
7466
|
},
|
|
7411
7467
|
"required": [
|
|
@@ -7866,20 +7922,6 @@ export const API_OPERATIONS = [
|
|
|
7866
7922
|
"visitor_counting",
|
|
7867
7923
|
"totals",
|
|
7868
7924
|
"previous",
|
|
7869
|
-
"series",
|
|
7870
|
-
"pages",
|
|
7871
|
-
"sources",
|
|
7872
|
-
"channels",
|
|
7873
|
-
"assistants",
|
|
7874
|
-
"countries",
|
|
7875
|
-
"devices",
|
|
7876
|
-
"browsers",
|
|
7877
|
-
"os",
|
|
7878
|
-
"bot_views",
|
|
7879
|
-
"bots",
|
|
7880
|
-
"markdown",
|
|
7881
|
-
"not_found",
|
|
7882
|
-
"forms",
|
|
7883
7925
|
"updated_at"
|
|
7884
7926
|
],
|
|
7885
7927
|
"additionalProperties": false
|
|
@@ -7935,32 +7977,59 @@ export const API_OPERATIONS = [
|
|
|
7935
7977
|
}
|
|
7936
7978
|
},
|
|
7937
7979
|
{
|
|
7938
|
-
"operation_id": "
|
|
7980
|
+
"operation_id": "getWorkspaceAnalytics",
|
|
7939
7981
|
"method": "GET",
|
|
7940
|
-
"path": "/v1/
|
|
7941
|
-
"summary": "Read
|
|
7942
|
-
"description": "
|
|
7982
|
+
"path": "/v1/analytics",
|
|
7983
|
+
"summary": "Read every site's visitor numbers",
|
|
7984
|
+
"description": "One row per site of the workspace over a period: views, visitors, form sends, the period before, and the leading page, channel and AI assistant. Live sites first. No credits. For one site's detail, getSiteAnalytics.",
|
|
7943
7985
|
"authentication_required": true,
|
|
7944
7986
|
"scope": "sites:read",
|
|
7945
7987
|
"surfaces": {
|
|
7946
|
-
"cli": "atelier201
|
|
7947
|
-
"mcp": "
|
|
7988
|
+
"cli": "atelier201 analytics --all",
|
|
7989
|
+
"mcp": "get_workspace_analytics"
|
|
7948
7990
|
},
|
|
7949
7991
|
"parameters": [
|
|
7950
7992
|
{
|
|
7951
|
-
"name": "
|
|
7952
|
-
"in": "
|
|
7953
|
-
"required":
|
|
7993
|
+
"name": "period",
|
|
7994
|
+
"in": "query",
|
|
7995
|
+
"required": false,
|
|
7954
7996
|
"schema": {
|
|
7955
|
-
"
|
|
7956
|
-
|
|
7957
|
-
|
|
7997
|
+
"description": "today, 7d, 30d, 90d or 12m, ending today. Default 30d. Leave it out when you give from and to.",
|
|
7998
|
+
"type": "string",
|
|
7999
|
+
"enum": [
|
|
8000
|
+
"today",
|
|
8001
|
+
"7d",
|
|
8002
|
+
"30d",
|
|
8003
|
+
"90d",
|
|
8004
|
+
"12m"
|
|
8005
|
+
]
|
|
8006
|
+
}
|
|
8007
|
+
},
|
|
8008
|
+
{
|
|
8009
|
+
"name": "from",
|
|
8010
|
+
"in": "query",
|
|
8011
|
+
"required": false,
|
|
8012
|
+
"schema": {
|
|
8013
|
+
"description": "First UTC day of a range of your own, YYYY-MM-DD, with to. At most 366 days.",
|
|
8014
|
+
"type": "string",
|
|
8015
|
+
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
|
|
8016
|
+
}
|
|
8017
|
+
},
|
|
8018
|
+
{
|
|
8019
|
+
"name": "to",
|
|
8020
|
+
"in": "query",
|
|
8021
|
+
"required": false,
|
|
8022
|
+
"schema": {
|
|
8023
|
+
"description": "Last UTC day of the range, YYYY-MM-DD, today at the latest.",
|
|
8024
|
+
"type": "string",
|
|
8025
|
+
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
|
|
8026
|
+
}
|
|
7958
8027
|
}
|
|
7959
8028
|
],
|
|
7960
8029
|
"request_body": null,
|
|
7961
8030
|
"responses": {
|
|
7962
8031
|
"200": {
|
|
7963
|
-
"description": "Read
|
|
8032
|
+
"description": "Read every site's visitor numbers",
|
|
7964
8033
|
"content": {
|
|
7965
8034
|
"application/json": {
|
|
7966
8035
|
"schema": {
|
|
@@ -7970,210 +8039,252 @@ export const API_OPERATIONS = [
|
|
|
7970
8039
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
7971
8040
|
"type": "object",
|
|
7972
8041
|
"properties": {
|
|
7973
|
-
"
|
|
7974
|
-
"type": "boolean",
|
|
7975
|
-
"description": "The owner's choice. Off until someone turns it on."
|
|
7976
|
-
},
|
|
7977
|
-
"applies_at_next_publication": {
|
|
7978
|
-
"type": "boolean",
|
|
7979
|
-
"description": "The choice differs from what the live site does. It reaches visitors with the next publication."
|
|
7980
|
-
},
|
|
7981
|
-
"state": {
|
|
8042
|
+
"period": {
|
|
7982
8043
|
"type": "string",
|
|
7983
8044
|
"enum": [
|
|
7984
|
-
"
|
|
7985
|
-
"
|
|
7986
|
-
"
|
|
7987
|
-
"
|
|
7988
|
-
"
|
|
7989
|
-
|
|
7990
|
-
"description": "What the live site does: nothing published yet, consent off, no third party to ask about, a banner asks, or a consent tool of the owner's own."
|
|
7991
|
-
},
|
|
7992
|
-
"own_tool": {
|
|
7993
|
-
"description": "The owner's consent tool found in the latest build. Atelier201 then keeps no proof.",
|
|
7994
|
-
"type": [
|
|
7995
|
-
"string",
|
|
7996
|
-
"null"
|
|
8045
|
+
"today",
|
|
8046
|
+
"7d",
|
|
8047
|
+
"30d",
|
|
8048
|
+
"90d",
|
|
8049
|
+
"12m",
|
|
8050
|
+
"custom"
|
|
7997
8051
|
]
|
|
7998
8052
|
},
|
|
7999
|
-
"
|
|
8000
|
-
"
|
|
8001
|
-
{
|
|
8002
|
-
"type": "string",
|
|
8003
|
-
"enum": [
|
|
8004
|
-
"standard",
|
|
8005
|
-
"custom"
|
|
8006
|
-
]
|
|
8007
|
-
},
|
|
8008
|
-
{
|
|
8009
|
-
"type": "null"
|
|
8010
|
-
}
|
|
8011
|
-
],
|
|
8012
|
-
"description": "Which banner the live site shows. Null when it shows none."
|
|
8013
|
-
},
|
|
8014
|
-
"third_parties": {
|
|
8015
|
-
"type": "array",
|
|
8016
|
-
"items": {
|
|
8017
|
-
"type": "object",
|
|
8018
|
-
"properties": {
|
|
8019
|
-
"name": {
|
|
8020
|
-
"type": "string"
|
|
8021
|
-
},
|
|
8022
|
-
"category": {
|
|
8023
|
-
"type": "string",
|
|
8024
|
-
"enum": [
|
|
8025
|
-
"analytics",
|
|
8026
|
-
"marketing",
|
|
8027
|
-
"media",
|
|
8028
|
-
"none"
|
|
8029
|
-
],
|
|
8030
|
-
"description": "What it waits for. none: it stores nothing on the device, so it asks for nothing."
|
|
8031
|
-
}
|
|
8032
|
-
},
|
|
8033
|
-
"required": [
|
|
8034
|
-
"name",
|
|
8035
|
-
"category"
|
|
8036
|
-
],
|
|
8037
|
-
"additionalProperties": false
|
|
8038
|
-
},
|
|
8039
|
-
"description": "The known services in the latest build of the site, whether consent is on or off."
|
|
8040
|
-
},
|
|
8041
|
-
"unknown_hosts": {
|
|
8042
|
-
"type": "array",
|
|
8043
|
-
"items": {
|
|
8044
|
-
"type": "string"
|
|
8045
|
-
},
|
|
8046
|
-
"description": "Services nobody classified, in the latest build: they load for everyone until a tag says otherwise."
|
|
8053
|
+
"from": {
|
|
8054
|
+
"type": "string"
|
|
8047
8055
|
},
|
|
8048
|
-
"
|
|
8049
|
-
"type": "
|
|
8050
|
-
"items": {
|
|
8051
|
-
"type": "string",
|
|
8052
|
-
"enum": [
|
|
8053
|
-
"analytics",
|
|
8054
|
-
"marketing",
|
|
8055
|
-
"media"
|
|
8056
|
-
]
|
|
8057
|
-
},
|
|
8058
|
-
"description": "What visitors of the live site are asked about."
|
|
8056
|
+
"to": {
|
|
8057
|
+
"type": "string"
|
|
8059
8058
|
},
|
|
8060
|
-
"
|
|
8059
|
+
"totals": {
|
|
8061
8060
|
"type": "object",
|
|
8062
8061
|
"properties": {
|
|
8063
|
-
"
|
|
8064
|
-
"type": "
|
|
8065
|
-
},
|
|
8066
|
-
"ends_at_period_end": {
|
|
8067
|
-
"type": "boolean"
|
|
8062
|
+
"views": {
|
|
8063
|
+
"type": "number"
|
|
8068
8064
|
},
|
|
8069
|
-
"
|
|
8070
|
-
"
|
|
8071
|
-
|
|
8072
|
-
|
|
8073
|
-
|
|
8074
|
-
},
|
|
8075
|
-
{
|
|
8076
|
-
"type": "null"
|
|
8077
|
-
}
|
|
8065
|
+
"visitors": {
|
|
8066
|
+
"description": "Null when no site counts visitors. Otherwise the sum over the sites that do.",
|
|
8067
|
+
"type": [
|
|
8068
|
+
"number",
|
|
8069
|
+
"null"
|
|
8078
8070
|
]
|
|
8079
8071
|
},
|
|
8080
|
-
"
|
|
8072
|
+
"form_sends": {
|
|
8081
8073
|
"type": "number"
|
|
8082
8074
|
}
|
|
8083
8075
|
},
|
|
8084
8076
|
"required": [
|
|
8085
|
-
"
|
|
8086
|
-
"
|
|
8087
|
-
"
|
|
8088
|
-
"price_eur"
|
|
8077
|
+
"views",
|
|
8078
|
+
"visitors",
|
|
8079
|
+
"form_sends"
|
|
8089
8080
|
],
|
|
8090
8081
|
"additionalProperties": false,
|
|
8091
|
-
"description": "
|
|
8082
|
+
"description": "Every live site together."
|
|
8092
8083
|
},
|
|
8093
|
-
"
|
|
8094
|
-
"type": "
|
|
8095
|
-
"
|
|
8096
|
-
"
|
|
8097
|
-
|
|
8098
|
-
"
|
|
8099
|
-
|
|
8100
|
-
|
|
8101
|
-
"
|
|
8102
|
-
|
|
8103
|
-
|
|
8104
|
-
|
|
8105
|
-
|
|
8106
|
-
|
|
8107
|
-
|
|
8108
|
-
|
|
8109
|
-
|
|
8110
|
-
|
|
8111
|
-
|
|
8112
|
-
|
|
8113
|
-
|
|
8114
|
-
|
|
8115
|
-
|
|
8116
|
-
|
|
8117
|
-
|
|
8118
|
-
|
|
8119
|
-
|
|
8120
|
-
|
|
8121
|
-
|
|
8122
|
-
|
|
8123
|
-
|
|
8124
|
-
|
|
8125
|
-
|
|
8126
|
-
|
|
8127
|
-
|
|
8128
|
-
|
|
8129
|
-
|
|
8130
|
-
|
|
8131
|
-
|
|
8132
|
-
|
|
8133
|
-
|
|
8134
|
-
|
|
8135
|
-
|
|
8136
|
-
|
|
8137
|
-
|
|
8138
|
-
|
|
8139
|
-
|
|
8140
|
-
|
|
8141
|
-
|
|
8142
|
-
|
|
8143
|
-
|
|
8144
|
-
|
|
8145
|
-
|
|
8146
|
-
|
|
8147
|
-
|
|
8148
|
-
|
|
8084
|
+
"sites": {
|
|
8085
|
+
"type": "array",
|
|
8086
|
+
"items": {
|
|
8087
|
+
"type": "object",
|
|
8088
|
+
"properties": {
|
|
8089
|
+
"site_id": {
|
|
8090
|
+
"type": "string"
|
|
8091
|
+
},
|
|
8092
|
+
"name": {
|
|
8093
|
+
"type": "string"
|
|
8094
|
+
},
|
|
8095
|
+
"url": {
|
|
8096
|
+
"type": "string"
|
|
8097
|
+
},
|
|
8098
|
+
"live": {
|
|
8099
|
+
"type": "boolean",
|
|
8100
|
+
"description": "Published: only a live site has visitors. A site never published has no figures."
|
|
8101
|
+
},
|
|
8102
|
+
"visitor_counting": {
|
|
8103
|
+
"type": "boolean"
|
|
8104
|
+
},
|
|
8105
|
+
"totals": {
|
|
8106
|
+
"anyOf": [
|
|
8107
|
+
{
|
|
8108
|
+
"type": "object",
|
|
8109
|
+
"properties": {
|
|
8110
|
+
"views": {
|
|
8111
|
+
"type": "number"
|
|
8112
|
+
},
|
|
8113
|
+
"visitors": {
|
|
8114
|
+
"type": [
|
|
8115
|
+
"number",
|
|
8116
|
+
"null"
|
|
8117
|
+
]
|
|
8118
|
+
},
|
|
8119
|
+
"visits": {
|
|
8120
|
+
"type": [
|
|
8121
|
+
"number",
|
|
8122
|
+
"null"
|
|
8123
|
+
]
|
|
8124
|
+
},
|
|
8125
|
+
"bounce_rate": {
|
|
8126
|
+
"description": "Share of visits with a single page view, 0 to 1.",
|
|
8127
|
+
"type": [
|
|
8128
|
+
"number",
|
|
8129
|
+
"null"
|
|
8130
|
+
]
|
|
8131
|
+
},
|
|
8132
|
+
"visit_seconds": {
|
|
8133
|
+
"type": [
|
|
8134
|
+
"number",
|
|
8135
|
+
"null"
|
|
8136
|
+
]
|
|
8137
|
+
},
|
|
8138
|
+
"views_per_visit": {
|
|
8139
|
+
"type": [
|
|
8140
|
+
"number",
|
|
8141
|
+
"null"
|
|
8142
|
+
]
|
|
8143
|
+
},
|
|
8144
|
+
"form_sends": {
|
|
8145
|
+
"description": "Form sends the site kept, spam aside. Counted on every site: a send carries no visitor hash. Null with a filter.",
|
|
8146
|
+
"type": [
|
|
8147
|
+
"number",
|
|
8148
|
+
"null"
|
|
8149
|
+
]
|
|
8150
|
+
}
|
|
8151
|
+
},
|
|
8152
|
+
"required": [
|
|
8153
|
+
"views",
|
|
8154
|
+
"visitors",
|
|
8155
|
+
"visits",
|
|
8156
|
+
"bounce_rate",
|
|
8157
|
+
"visit_seconds",
|
|
8158
|
+
"views_per_visit",
|
|
8159
|
+
"form_sends"
|
|
8160
|
+
],
|
|
8161
|
+
"additionalProperties": false
|
|
8162
|
+
},
|
|
8163
|
+
{
|
|
8164
|
+
"type": "null"
|
|
8165
|
+
}
|
|
8166
|
+
]
|
|
8167
|
+
},
|
|
8168
|
+
"previous": {
|
|
8169
|
+
"anyOf": [
|
|
8170
|
+
{
|
|
8171
|
+
"type": "object",
|
|
8172
|
+
"properties": {
|
|
8173
|
+
"views": {
|
|
8174
|
+
"type": "number"
|
|
8175
|
+
},
|
|
8176
|
+
"visitors": {
|
|
8177
|
+
"type": [
|
|
8178
|
+
"number",
|
|
8179
|
+
"null"
|
|
8180
|
+
]
|
|
8181
|
+
},
|
|
8182
|
+
"visits": {
|
|
8183
|
+
"type": [
|
|
8184
|
+
"number",
|
|
8185
|
+
"null"
|
|
8186
|
+
]
|
|
8187
|
+
},
|
|
8188
|
+
"bounce_rate": {
|
|
8189
|
+
"description": "Share of visits with a single page view, 0 to 1.",
|
|
8190
|
+
"type": [
|
|
8191
|
+
"number",
|
|
8192
|
+
"null"
|
|
8193
|
+
]
|
|
8194
|
+
},
|
|
8195
|
+
"visit_seconds": {
|
|
8196
|
+
"type": [
|
|
8197
|
+
"number",
|
|
8198
|
+
"null"
|
|
8199
|
+
]
|
|
8200
|
+
},
|
|
8201
|
+
"views_per_visit": {
|
|
8202
|
+
"type": [
|
|
8203
|
+
"number",
|
|
8204
|
+
"null"
|
|
8205
|
+
]
|
|
8206
|
+
},
|
|
8207
|
+
"form_sends": {
|
|
8208
|
+
"description": "Form sends the site kept, spam aside. Counted on every site: a send carries no visitor hash. Null with a filter.",
|
|
8209
|
+
"type": [
|
|
8210
|
+
"number",
|
|
8211
|
+
"null"
|
|
8212
|
+
]
|
|
8213
|
+
}
|
|
8214
|
+
},
|
|
8215
|
+
"required": [
|
|
8216
|
+
"views",
|
|
8217
|
+
"visitors",
|
|
8218
|
+
"visits",
|
|
8219
|
+
"bounce_rate",
|
|
8220
|
+
"visit_seconds",
|
|
8221
|
+
"views_per_visit",
|
|
8222
|
+
"form_sends"
|
|
8223
|
+
],
|
|
8224
|
+
"additionalProperties": false
|
|
8225
|
+
},
|
|
8226
|
+
{
|
|
8227
|
+
"type": "null"
|
|
8228
|
+
}
|
|
8229
|
+
],
|
|
8230
|
+
"description": "The same number of days just before."
|
|
8231
|
+
},
|
|
8232
|
+
"top_page": {
|
|
8233
|
+
"type": [
|
|
8234
|
+
"string",
|
|
8235
|
+
"null"
|
|
8236
|
+
]
|
|
8237
|
+
},
|
|
8238
|
+
"top_channel": {
|
|
8239
|
+
"anyOf": [
|
|
8240
|
+
{
|
|
8241
|
+
"type": "string",
|
|
8242
|
+
"enum": [
|
|
8243
|
+
"search",
|
|
8244
|
+
"ai",
|
|
8245
|
+
"social",
|
|
8246
|
+
"email",
|
|
8247
|
+
"referral",
|
|
8248
|
+
"campaign",
|
|
8249
|
+
"direct"
|
|
8250
|
+
]
|
|
8251
|
+
},
|
|
8252
|
+
{
|
|
8253
|
+
"type": "null"
|
|
8254
|
+
}
|
|
8255
|
+
]
|
|
8256
|
+
},
|
|
8257
|
+
"top_assistant": {
|
|
8258
|
+
"description": "The AI assistant that sent the most people, when any did.",
|
|
8259
|
+
"type": [
|
|
8260
|
+
"string",
|
|
8261
|
+
"null"
|
|
8262
|
+
]
|
|
8263
|
+
}
|
|
8149
8264
|
},
|
|
8150
|
-
"
|
|
8151
|
-
"
|
|
8152
|
-
"
|
|
8153
|
-
|
|
8265
|
+
"required": [
|
|
8266
|
+
"site_id",
|
|
8267
|
+
"name",
|
|
8268
|
+
"url",
|
|
8269
|
+
"live",
|
|
8270
|
+
"visitor_counting",
|
|
8271
|
+
"totals",
|
|
8272
|
+
"previous",
|
|
8273
|
+
"top_page",
|
|
8274
|
+
"top_channel",
|
|
8275
|
+
"top_assistant"
|
|
8276
|
+
],
|
|
8277
|
+
"additionalProperties": false
|
|
8154
8278
|
},
|
|
8155
|
-
"
|
|
8156
|
-
"total",
|
|
8157
|
-
"first_at",
|
|
8158
|
-
"last_at",
|
|
8159
|
-
"last_30_days",
|
|
8160
|
-
"versions",
|
|
8161
|
-
"retention_days"
|
|
8162
|
-
],
|
|
8163
|
-
"additionalProperties": false
|
|
8279
|
+
"description": "One row per site, live sites first, most viewed first. For the detail of one, getSiteAnalytics."
|
|
8164
8280
|
}
|
|
8165
8281
|
},
|
|
8166
8282
|
"required": [
|
|
8167
|
-
"
|
|
8168
|
-
"
|
|
8169
|
-
"
|
|
8170
|
-
"
|
|
8171
|
-
"
|
|
8172
|
-
"third_parties",
|
|
8173
|
-
"unknown_hosts",
|
|
8174
|
-
"categories",
|
|
8175
|
-
"addon",
|
|
8176
|
-
"proofs"
|
|
8283
|
+
"period",
|
|
8284
|
+
"from",
|
|
8285
|
+
"to",
|
|
8286
|
+
"totals",
|
|
8287
|
+
"sites"
|
|
8177
8288
|
],
|
|
8178
8289
|
"additionalProperties": false
|
|
8179
8290
|
},
|
|
@@ -8228,16 +8339,16 @@ export const API_OPERATIONS = [
|
|
|
8228
8339
|
}
|
|
8229
8340
|
},
|
|
8230
8341
|
{
|
|
8231
|
-
"operation_id": "
|
|
8232
|
-
"method": "
|
|
8342
|
+
"operation_id": "getSiteConsent",
|
|
8343
|
+
"method": "GET",
|
|
8233
8344
|
"path": "/v1/sites/{site_id}/consent",
|
|
8234
|
-
"summary": "
|
|
8235
|
-
"description": "
|
|
8345
|
+
"summary": "Read a site's cookie consent",
|
|
8346
|
+
"description": "Costs no credits. What the live site asks visitors about, which services it holds back, which it does not know, and how many proofs are kept. Atelier201 keeps proofs; it never certifies a site as compliant.",
|
|
8236
8347
|
"authentication_required": true,
|
|
8237
|
-
"scope": "sites:
|
|
8348
|
+
"scope": "sites:read",
|
|
8238
8349
|
"surfaces": {
|
|
8239
|
-
"cli": "atelier201 consent
|
|
8240
|
-
"mcp": "
|
|
8350
|
+
"cli": "atelier201 consent status",
|
|
8351
|
+
"mcp": "get_site_consent"
|
|
8241
8352
|
},
|
|
8242
8353
|
"parameters": [
|
|
8243
8354
|
{
|
|
@@ -8250,29 +8361,10 @@ export const API_OPERATIONS = [
|
|
|
8250
8361
|
"description": "The site's id, or its slug (the address before .atelier201.page)."
|
|
8251
8362
|
}
|
|
8252
8363
|
],
|
|
8253
|
-
"request_body":
|
|
8254
|
-
"required": true,
|
|
8255
|
-
"content": {
|
|
8256
|
-
"application/json": {
|
|
8257
|
-
"schema": {
|
|
8258
|
-
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
8259
|
-
"type": "object",
|
|
8260
|
-
"properties": {
|
|
8261
|
-
"enabled": {
|
|
8262
|
-
"type": "boolean",
|
|
8263
|
-
"description": "true: third parties wait for each visitor's yes, and each answer is kept as a proof. false: the site asks nothing and its pages are not changed."
|
|
8264
|
-
}
|
|
8265
|
-
},
|
|
8266
|
-
"required": [
|
|
8267
|
-
"enabled"
|
|
8268
|
-
]
|
|
8269
|
-
}
|
|
8270
|
-
}
|
|
8271
|
-
}
|
|
8272
|
-
},
|
|
8364
|
+
"request_body": null,
|
|
8273
8365
|
"responses": {
|
|
8274
8366
|
"200": {
|
|
8275
|
-
"description": "
|
|
8367
|
+
"description": "Read a site's cookie consent",
|
|
8276
8368
|
"content": {
|
|
8277
8369
|
"application/json": {
|
|
8278
8370
|
"schema": {
|
|
@@ -8389,6 +8481,18 @@ export const API_OPERATIONS = [
|
|
|
8389
8481
|
}
|
|
8390
8482
|
]
|
|
8391
8483
|
},
|
|
8484
|
+
"stops_on": {
|
|
8485
|
+
"anyOf": [
|
|
8486
|
+
{
|
|
8487
|
+
"type": "string",
|
|
8488
|
+
"description": "ISO 8601, UTC."
|
|
8489
|
+
},
|
|
8490
|
+
{
|
|
8491
|
+
"type": "null"
|
|
8492
|
+
}
|
|
8493
|
+
],
|
|
8494
|
+
"description": "Stopped by the owner: it stays until this day, already paid for, then the next publication shows the standard banner."
|
|
8495
|
+
},
|
|
8392
8496
|
"price_eur": {
|
|
8393
8497
|
"type": "number"
|
|
8394
8498
|
}
|
|
@@ -8397,6 +8501,7 @@ export const API_OPERATIONS = [
|
|
|
8397
8501
|
"active",
|
|
8398
8502
|
"ends_at_period_end",
|
|
8399
8503
|
"current_period_end",
|
|
8504
|
+
"stops_on",
|
|
8400
8505
|
"price_eur"
|
|
8401
8506
|
],
|
|
8402
8507
|
"additionalProperties": false,
|
|
@@ -8540,16 +8645,16 @@ export const API_OPERATIONS = [
|
|
|
8540
8645
|
}
|
|
8541
8646
|
},
|
|
8542
8647
|
{
|
|
8543
|
-
"operation_id": "
|
|
8544
|
-
"method": "
|
|
8545
|
-
"path": "/v1/sites/{site_id}/consent
|
|
8546
|
-
"summary": "
|
|
8547
|
-
"description": "
|
|
8648
|
+
"operation_id": "setSiteConsent",
|
|
8649
|
+
"method": "PUT",
|
|
8650
|
+
"path": "/v1/sites/{site_id}/consent",
|
|
8651
|
+
"summary": "Turn a site's cookie consent on or off",
|
|
8652
|
+
"description": "Off until someone turns it on. On, third parties wait for each visitor's yes and each answer is kept as a proof. Off, the site asks nothing and its pages are not changed; proofs already kept stay until they expire. Starts a build; publish it to finish. No credits. Requires a workspace admin.",
|
|
8548
8653
|
"authentication_required": true,
|
|
8549
|
-
"scope": "sites:
|
|
8654
|
+
"scope": "sites:write",
|
|
8550
8655
|
"surfaces": {
|
|
8551
|
-
"cli": "atelier201 consent
|
|
8552
|
-
"mcp": "
|
|
8656
|
+
"cli": "atelier201 consent enable",
|
|
8657
|
+
"mcp": "set_site_consent"
|
|
8553
8658
|
},
|
|
8554
8659
|
"parameters": [
|
|
8555
8660
|
{
|
|
@@ -8560,19 +8665,344 @@ export const API_OPERATIONS = [
|
|
|
8560
8665
|
"type": "string"
|
|
8561
8666
|
},
|
|
8562
8667
|
"description": "The site's id, or its slug (the address before .atelier201.page)."
|
|
8563
|
-
}
|
|
8564
|
-
|
|
8565
|
-
|
|
8566
|
-
|
|
8567
|
-
|
|
8568
|
-
"
|
|
8569
|
-
"
|
|
8570
|
-
|
|
8571
|
-
|
|
8572
|
-
|
|
8668
|
+
}
|
|
8669
|
+
],
|
|
8670
|
+
"request_body": {
|
|
8671
|
+
"required": true,
|
|
8672
|
+
"content": {
|
|
8673
|
+
"application/json": {
|
|
8674
|
+
"schema": {
|
|
8675
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
8676
|
+
"type": "object",
|
|
8677
|
+
"properties": {
|
|
8678
|
+
"enabled": {
|
|
8679
|
+
"type": "boolean",
|
|
8680
|
+
"description": "true: third parties wait for each visitor's yes, and each answer is kept as a proof. false: the site asks nothing and its pages are not changed."
|
|
8681
|
+
}
|
|
8682
|
+
},
|
|
8683
|
+
"required": [
|
|
8684
|
+
"enabled"
|
|
8685
|
+
]
|
|
8686
|
+
}
|
|
8573
8687
|
}
|
|
8574
|
-
}
|
|
8575
|
-
|
|
8688
|
+
}
|
|
8689
|
+
},
|
|
8690
|
+
"responses": {
|
|
8691
|
+
"200": {
|
|
8692
|
+
"description": "Turn a site's cookie consent on or off",
|
|
8693
|
+
"content": {
|
|
8694
|
+
"application/json": {
|
|
8695
|
+
"schema": {
|
|
8696
|
+
"type": "object",
|
|
8697
|
+
"properties": {
|
|
8698
|
+
"data": {
|
|
8699
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
8700
|
+
"type": "object",
|
|
8701
|
+
"properties": {
|
|
8702
|
+
"enabled": {
|
|
8703
|
+
"type": "boolean",
|
|
8704
|
+
"description": "The owner's choice. Off until someone turns it on."
|
|
8705
|
+
},
|
|
8706
|
+
"applies_at_next_publication": {
|
|
8707
|
+
"type": "boolean",
|
|
8708
|
+
"description": "The choice differs from what the live site does. It reaches visitors with the next publication."
|
|
8709
|
+
},
|
|
8710
|
+
"state": {
|
|
8711
|
+
"type": "string",
|
|
8712
|
+
"enum": [
|
|
8713
|
+
"not_published",
|
|
8714
|
+
"off",
|
|
8715
|
+
"nothing_to_ask",
|
|
8716
|
+
"asking",
|
|
8717
|
+
"own_tool"
|
|
8718
|
+
],
|
|
8719
|
+
"description": "What the live site does: nothing published yet, consent off, no third party to ask about, a banner asks, or a consent tool of the owner's own."
|
|
8720
|
+
},
|
|
8721
|
+
"own_tool": {
|
|
8722
|
+
"description": "The owner's consent tool found in the latest build. Atelier201 then keeps no proof.",
|
|
8723
|
+
"type": [
|
|
8724
|
+
"string",
|
|
8725
|
+
"null"
|
|
8726
|
+
]
|
|
8727
|
+
},
|
|
8728
|
+
"banner": {
|
|
8729
|
+
"anyOf": [
|
|
8730
|
+
{
|
|
8731
|
+
"type": "string",
|
|
8732
|
+
"enum": [
|
|
8733
|
+
"standard",
|
|
8734
|
+
"custom"
|
|
8735
|
+
]
|
|
8736
|
+
},
|
|
8737
|
+
{
|
|
8738
|
+
"type": "null"
|
|
8739
|
+
}
|
|
8740
|
+
],
|
|
8741
|
+
"description": "Which banner the live site shows. Null when it shows none."
|
|
8742
|
+
},
|
|
8743
|
+
"third_parties": {
|
|
8744
|
+
"type": "array",
|
|
8745
|
+
"items": {
|
|
8746
|
+
"type": "object",
|
|
8747
|
+
"properties": {
|
|
8748
|
+
"name": {
|
|
8749
|
+
"type": "string"
|
|
8750
|
+
},
|
|
8751
|
+
"category": {
|
|
8752
|
+
"type": "string",
|
|
8753
|
+
"enum": [
|
|
8754
|
+
"analytics",
|
|
8755
|
+
"marketing",
|
|
8756
|
+
"media",
|
|
8757
|
+
"none"
|
|
8758
|
+
],
|
|
8759
|
+
"description": "What it waits for. none: it stores nothing on the device, so it asks for nothing."
|
|
8760
|
+
}
|
|
8761
|
+
},
|
|
8762
|
+
"required": [
|
|
8763
|
+
"name",
|
|
8764
|
+
"category"
|
|
8765
|
+
],
|
|
8766
|
+
"additionalProperties": false
|
|
8767
|
+
},
|
|
8768
|
+
"description": "The known services in the latest build of the site, whether consent is on or off."
|
|
8769
|
+
},
|
|
8770
|
+
"unknown_hosts": {
|
|
8771
|
+
"type": "array",
|
|
8772
|
+
"items": {
|
|
8773
|
+
"type": "string"
|
|
8774
|
+
},
|
|
8775
|
+
"description": "Services nobody classified, in the latest build: they load for everyone until a tag says otherwise."
|
|
8776
|
+
},
|
|
8777
|
+
"categories": {
|
|
8778
|
+
"type": "array",
|
|
8779
|
+
"items": {
|
|
8780
|
+
"type": "string",
|
|
8781
|
+
"enum": [
|
|
8782
|
+
"analytics",
|
|
8783
|
+
"marketing",
|
|
8784
|
+
"media"
|
|
8785
|
+
]
|
|
8786
|
+
},
|
|
8787
|
+
"description": "What visitors of the live site are asked about."
|
|
8788
|
+
},
|
|
8789
|
+
"addon": {
|
|
8790
|
+
"type": "object",
|
|
8791
|
+
"properties": {
|
|
8792
|
+
"active": {
|
|
8793
|
+
"type": "boolean"
|
|
8794
|
+
},
|
|
8795
|
+
"ends_at_period_end": {
|
|
8796
|
+
"type": "boolean"
|
|
8797
|
+
},
|
|
8798
|
+
"current_period_end": {
|
|
8799
|
+
"anyOf": [
|
|
8800
|
+
{
|
|
8801
|
+
"type": "string",
|
|
8802
|
+
"description": "ISO 8601, UTC."
|
|
8803
|
+
},
|
|
8804
|
+
{
|
|
8805
|
+
"type": "null"
|
|
8806
|
+
}
|
|
8807
|
+
]
|
|
8808
|
+
},
|
|
8809
|
+
"stops_on": {
|
|
8810
|
+
"anyOf": [
|
|
8811
|
+
{
|
|
8812
|
+
"type": "string",
|
|
8813
|
+
"description": "ISO 8601, UTC."
|
|
8814
|
+
},
|
|
8815
|
+
{
|
|
8816
|
+
"type": "null"
|
|
8817
|
+
}
|
|
8818
|
+
],
|
|
8819
|
+
"description": "Stopped by the owner: it stays until this day, already paid for, then the next publication shows the standard banner."
|
|
8820
|
+
},
|
|
8821
|
+
"price_eur": {
|
|
8822
|
+
"type": "number"
|
|
8823
|
+
}
|
|
8824
|
+
},
|
|
8825
|
+
"required": [
|
|
8826
|
+
"active",
|
|
8827
|
+
"ends_at_period_end",
|
|
8828
|
+
"current_period_end",
|
|
8829
|
+
"stops_on",
|
|
8830
|
+
"price_eur"
|
|
8831
|
+
],
|
|
8832
|
+
"additionalProperties": false,
|
|
8833
|
+
"description": "The custom banner add-on. Bought in the dashboard."
|
|
8834
|
+
},
|
|
8835
|
+
"proofs": {
|
|
8836
|
+
"type": "object",
|
|
8837
|
+
"properties": {
|
|
8838
|
+
"total": {
|
|
8839
|
+
"type": "number",
|
|
8840
|
+
"description": "Decisions kept."
|
|
8841
|
+
},
|
|
8842
|
+
"first_at": {
|
|
8843
|
+
"anyOf": [
|
|
8844
|
+
{
|
|
8845
|
+
"type": "string",
|
|
8846
|
+
"description": "ISO 8601, UTC."
|
|
8847
|
+
},
|
|
8848
|
+
{
|
|
8849
|
+
"type": "null"
|
|
8850
|
+
}
|
|
8851
|
+
]
|
|
8852
|
+
},
|
|
8853
|
+
"last_at": {
|
|
8854
|
+
"anyOf": [
|
|
8855
|
+
{
|
|
8856
|
+
"type": "string",
|
|
8857
|
+
"description": "ISO 8601, UTC."
|
|
8858
|
+
},
|
|
8859
|
+
{
|
|
8860
|
+
"type": "null"
|
|
8861
|
+
}
|
|
8862
|
+
]
|
|
8863
|
+
},
|
|
8864
|
+
"last_30_days": {
|
|
8865
|
+
"type": "object",
|
|
8866
|
+
"properties": {
|
|
8867
|
+
"accept": {
|
|
8868
|
+
"type": "number"
|
|
8869
|
+
},
|
|
8870
|
+
"reject": {
|
|
8871
|
+
"type": "number"
|
|
8872
|
+
},
|
|
8873
|
+
"custom": {
|
|
8874
|
+
"type": "number"
|
|
8875
|
+
},
|
|
8876
|
+
"withdraw": {
|
|
8877
|
+
"type": "number"
|
|
8878
|
+
}
|
|
8879
|
+
},
|
|
8880
|
+
"required": [
|
|
8881
|
+
"accept",
|
|
8882
|
+
"reject",
|
|
8883
|
+
"custom",
|
|
8884
|
+
"withdraw"
|
|
8885
|
+
],
|
|
8886
|
+
"additionalProperties": false
|
|
8887
|
+
},
|
|
8888
|
+
"versions": {
|
|
8889
|
+
"type": "number",
|
|
8890
|
+
"description": "Distinct versions of the banner and its third parties kept."
|
|
8891
|
+
},
|
|
8892
|
+
"retention_days": {
|
|
8893
|
+
"type": "number",
|
|
8894
|
+
"description": "How long a proof is kept before it is erased."
|
|
8895
|
+
}
|
|
8896
|
+
},
|
|
8897
|
+
"required": [
|
|
8898
|
+
"total",
|
|
8899
|
+
"first_at",
|
|
8900
|
+
"last_at",
|
|
8901
|
+
"last_30_days",
|
|
8902
|
+
"versions",
|
|
8903
|
+
"retention_days"
|
|
8904
|
+
],
|
|
8905
|
+
"additionalProperties": false
|
|
8906
|
+
}
|
|
8907
|
+
},
|
|
8908
|
+
"required": [
|
|
8909
|
+
"enabled",
|
|
8910
|
+
"applies_at_next_publication",
|
|
8911
|
+
"state",
|
|
8912
|
+
"own_tool",
|
|
8913
|
+
"banner",
|
|
8914
|
+
"third_parties",
|
|
8915
|
+
"unknown_hosts",
|
|
8916
|
+
"categories",
|
|
8917
|
+
"addon",
|
|
8918
|
+
"proofs"
|
|
8919
|
+
],
|
|
8920
|
+
"additionalProperties": false
|
|
8921
|
+
},
|
|
8922
|
+
"request_id": {
|
|
8923
|
+
"type": "string"
|
|
8924
|
+
}
|
|
8925
|
+
},
|
|
8926
|
+
"required": [
|
|
8927
|
+
"data",
|
|
8928
|
+
"request_id"
|
|
8929
|
+
]
|
|
8930
|
+
}
|
|
8931
|
+
}
|
|
8932
|
+
}
|
|
8933
|
+
},
|
|
8934
|
+
"400": {
|
|
8935
|
+
"$ref": "#/components/responses/Error400"
|
|
8936
|
+
},
|
|
8937
|
+
"401": {
|
|
8938
|
+
"$ref": "#/components/responses/Error401"
|
|
8939
|
+
},
|
|
8940
|
+
"402": {
|
|
8941
|
+
"$ref": "#/components/responses/Error402"
|
|
8942
|
+
},
|
|
8943
|
+
"403": {
|
|
8944
|
+
"$ref": "#/components/responses/Error403"
|
|
8945
|
+
},
|
|
8946
|
+
"404": {
|
|
8947
|
+
"$ref": "#/components/responses/Error404"
|
|
8948
|
+
},
|
|
8949
|
+
"409": {
|
|
8950
|
+
"$ref": "#/components/responses/Error409"
|
|
8951
|
+
},
|
|
8952
|
+
"410": {
|
|
8953
|
+
"$ref": "#/components/responses/Error410"
|
|
8954
|
+
},
|
|
8955
|
+
"413": {
|
|
8956
|
+
"$ref": "#/components/responses/Error413"
|
|
8957
|
+
},
|
|
8958
|
+
"422": {
|
|
8959
|
+
"$ref": "#/components/responses/Error422"
|
|
8960
|
+
},
|
|
8961
|
+
"429": {
|
|
8962
|
+
"$ref": "#/components/responses/Error429"
|
|
8963
|
+
},
|
|
8964
|
+
"500": {
|
|
8965
|
+
"$ref": "#/components/responses/Error500"
|
|
8966
|
+
},
|
|
8967
|
+
"503": {
|
|
8968
|
+
"$ref": "#/components/responses/Error503"
|
|
8969
|
+
}
|
|
8970
|
+
}
|
|
8971
|
+
},
|
|
8972
|
+
{
|
|
8973
|
+
"operation_id": "listSiteConsentDecisions",
|
|
8974
|
+
"method": "GET",
|
|
8975
|
+
"path": "/v1/sites/{site_id}/consent/decisions",
|
|
8976
|
+
"summary": "List the consent decisions kept",
|
|
8977
|
+
"description": "Costs no credits. Newest first, one page at a time, or the one a visitor quotes by its reference. A decision says what a browser carrying this reference chose and when; nothing identifies the visitor.",
|
|
8978
|
+
"authentication_required": true,
|
|
8979
|
+
"scope": "sites:read",
|
|
8980
|
+
"surfaces": {
|
|
8981
|
+
"cli": "atelier201 consent decisions",
|
|
8982
|
+
"mcp": "list_consent_decisions"
|
|
8983
|
+
},
|
|
8984
|
+
"parameters": [
|
|
8985
|
+
{
|
|
8986
|
+
"name": "site_id",
|
|
8987
|
+
"in": "path",
|
|
8988
|
+
"required": true,
|
|
8989
|
+
"schema": {
|
|
8990
|
+
"type": "string"
|
|
8991
|
+
},
|
|
8992
|
+
"description": "The site's id, or its slug (the address before .atelier201.page)."
|
|
8993
|
+
},
|
|
8994
|
+
{
|
|
8995
|
+
"name": "reference",
|
|
8996
|
+
"in": "query",
|
|
8997
|
+
"required": false,
|
|
8998
|
+
"schema": {
|
|
8999
|
+
"description": "The reference a visitor quotes: finds that one decision.",
|
|
9000
|
+
"type": "string",
|
|
9001
|
+
"minLength": 16,
|
|
9002
|
+
"maxLength": 64
|
|
9003
|
+
}
|
|
9004
|
+
},
|
|
9005
|
+
{
|
|
8576
9006
|
"name": "cursor",
|
|
8577
9007
|
"in": "query",
|
|
8578
9008
|
"required": false,
|
|
@@ -17123,43 +17553,491 @@ export const API_OPERATIONS = [
|
|
|
17123
17553
|
{
|
|
17124
17554
|
"type": "null"
|
|
17125
17555
|
}
|
|
17126
|
-
]
|
|
17556
|
+
]
|
|
17557
|
+
}
|
|
17558
|
+
},
|
|
17559
|
+
"required": [
|
|
17560
|
+
"id",
|
|
17561
|
+
"site_id",
|
|
17562
|
+
"revision",
|
|
17563
|
+
"state",
|
|
17564
|
+
"target_origin",
|
|
17565
|
+
"profile",
|
|
17566
|
+
"file_count",
|
|
17567
|
+
"total_bytes",
|
|
17568
|
+
"duration_ms",
|
|
17569
|
+
"error",
|
|
17570
|
+
"warnings",
|
|
17571
|
+
"created_at",
|
|
17572
|
+
"started_at",
|
|
17573
|
+
"finished_at"
|
|
17574
|
+
],
|
|
17575
|
+
"additionalProperties": false
|
|
17576
|
+
},
|
|
17577
|
+
{
|
|
17578
|
+
"type": "null"
|
|
17579
|
+
}
|
|
17580
|
+
]
|
|
17581
|
+
},
|
|
17582
|
+
"next_action": {
|
|
17583
|
+
"type": [
|
|
17584
|
+
"string",
|
|
17585
|
+
"null"
|
|
17586
|
+
]
|
|
17587
|
+
}
|
|
17588
|
+
},
|
|
17589
|
+
"required": [
|
|
17590
|
+
"hostname",
|
|
17591
|
+
"rebuild",
|
|
17592
|
+
"next_action"
|
|
17593
|
+
],
|
|
17594
|
+
"additionalProperties": false
|
|
17595
|
+
},
|
|
17596
|
+
"request_id": {
|
|
17597
|
+
"type": "string"
|
|
17598
|
+
}
|
|
17599
|
+
},
|
|
17600
|
+
"required": [
|
|
17601
|
+
"data",
|
|
17602
|
+
"request_id"
|
|
17603
|
+
]
|
|
17604
|
+
}
|
|
17605
|
+
}
|
|
17606
|
+
}
|
|
17607
|
+
},
|
|
17608
|
+
"400": {
|
|
17609
|
+
"$ref": "#/components/responses/Error400"
|
|
17610
|
+
},
|
|
17611
|
+
"401": {
|
|
17612
|
+
"$ref": "#/components/responses/Error401"
|
|
17613
|
+
},
|
|
17614
|
+
"402": {
|
|
17615
|
+
"$ref": "#/components/responses/Error402"
|
|
17616
|
+
},
|
|
17617
|
+
"403": {
|
|
17618
|
+
"$ref": "#/components/responses/Error403"
|
|
17619
|
+
},
|
|
17620
|
+
"404": {
|
|
17621
|
+
"$ref": "#/components/responses/Error404"
|
|
17622
|
+
},
|
|
17623
|
+
"409": {
|
|
17624
|
+
"$ref": "#/components/responses/Error409"
|
|
17625
|
+
},
|
|
17626
|
+
"410": {
|
|
17627
|
+
"$ref": "#/components/responses/Error410"
|
|
17628
|
+
},
|
|
17629
|
+
"413": {
|
|
17630
|
+
"$ref": "#/components/responses/Error413"
|
|
17631
|
+
},
|
|
17632
|
+
"422": {
|
|
17633
|
+
"$ref": "#/components/responses/Error422"
|
|
17634
|
+
},
|
|
17635
|
+
"429": {
|
|
17636
|
+
"$ref": "#/components/responses/Error429"
|
|
17637
|
+
},
|
|
17638
|
+
"500": {
|
|
17639
|
+
"$ref": "#/components/responses/Error500"
|
|
17640
|
+
},
|
|
17641
|
+
"503": {
|
|
17642
|
+
"$ref": "#/components/responses/Error503"
|
|
17643
|
+
}
|
|
17644
|
+
}
|
|
17645
|
+
},
|
|
17646
|
+
{
|
|
17647
|
+
"operation_id": "getContentModel",
|
|
17648
|
+
"method": "GET",
|
|
17649
|
+
"path": "/v1/sites/{site_id}/content",
|
|
17650
|
+
"summary": "Read the content model",
|
|
17651
|
+
"description": "The site's collections (blog, services, team…) and singletons (business details, theme, navigation), each with its JSON Schema. Read this before writing content: every write is validated against it.",
|
|
17652
|
+
"authentication_required": true,
|
|
17653
|
+
"scope": "sites:read",
|
|
17654
|
+
"surfaces": {
|
|
17655
|
+
"cli": "atelier201 content model",
|
|
17656
|
+
"mcp": "get_content_model"
|
|
17657
|
+
},
|
|
17658
|
+
"parameters": [
|
|
17659
|
+
{
|
|
17660
|
+
"name": "site_id",
|
|
17661
|
+
"in": "path",
|
|
17662
|
+
"required": true,
|
|
17663
|
+
"schema": {
|
|
17664
|
+
"type": "string"
|
|
17665
|
+
},
|
|
17666
|
+
"description": "The site's id, or its slug (the address before .atelier201.page)."
|
|
17667
|
+
}
|
|
17668
|
+
],
|
|
17669
|
+
"request_body": null,
|
|
17670
|
+
"responses": {
|
|
17671
|
+
"200": {
|
|
17672
|
+
"description": "Read the content model",
|
|
17673
|
+
"content": {
|
|
17674
|
+
"application/json": {
|
|
17675
|
+
"schema": {
|
|
17676
|
+
"type": "object",
|
|
17677
|
+
"properties": {
|
|
17678
|
+
"data": {
|
|
17679
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
17680
|
+
"type": "object",
|
|
17681
|
+
"properties": {
|
|
17682
|
+
"version": {
|
|
17683
|
+
"type": "number",
|
|
17684
|
+
"const": 1
|
|
17685
|
+
},
|
|
17686
|
+
"build_id": {
|
|
17687
|
+
"type": "string",
|
|
17688
|
+
"description": "The build that exported this model, or \"starter\" before a new site's first build: the starter's own model, while the files it is built from are still the starter's."
|
|
17689
|
+
},
|
|
17690
|
+
"revision": {
|
|
17691
|
+
"type": "string",
|
|
17692
|
+
"minLength": 40,
|
|
17693
|
+
"maxLength": 40,
|
|
17694
|
+
"description": "A Git commit id (40 hex characters) of the site's repository."
|
|
17695
|
+
},
|
|
17696
|
+
"draft_revision": {
|
|
17697
|
+
"anyOf": [
|
|
17698
|
+
{
|
|
17699
|
+
"type": "string",
|
|
17700
|
+
"minLength": 40,
|
|
17701
|
+
"maxLength": 40,
|
|
17702
|
+
"description": "A Git commit id (40 hex characters) of the site's repository."
|
|
17703
|
+
},
|
|
17704
|
+
{
|
|
17705
|
+
"type": "null"
|
|
17706
|
+
}
|
|
17707
|
+
],
|
|
17708
|
+
"description": "The draft's revision now. It differs from revision once content was saved since that build, which is fine."
|
|
17709
|
+
},
|
|
17710
|
+
"stale": {
|
|
17711
|
+
"type": "boolean",
|
|
17712
|
+
"description": "True when the files the model is built from changed since this build: writes are then refused (stale_content_model) until the draft is built. Agents never see it true: the call waits for that build."
|
|
17713
|
+
},
|
|
17714
|
+
"collections": {
|
|
17715
|
+
"type": "object",
|
|
17716
|
+
"propertyNames": {
|
|
17717
|
+
"type": "string"
|
|
17718
|
+
},
|
|
17719
|
+
"additionalProperties": {
|
|
17720
|
+
"type": "object",
|
|
17721
|
+
"properties": {
|
|
17722
|
+
"label": {
|
|
17723
|
+
"type": "string"
|
|
17724
|
+
},
|
|
17725
|
+
"kind": {
|
|
17726
|
+
"type": "string",
|
|
17727
|
+
"enum": [
|
|
17728
|
+
"content",
|
|
17729
|
+
"data"
|
|
17730
|
+
]
|
|
17731
|
+
},
|
|
17732
|
+
"folder": {
|
|
17733
|
+
"type": "string"
|
|
17734
|
+
},
|
|
17735
|
+
"extension": {
|
|
17736
|
+
"type": "string"
|
|
17737
|
+
},
|
|
17738
|
+
"schema": {
|
|
17739
|
+
"type": "object",
|
|
17740
|
+
"propertyNames": {
|
|
17741
|
+
"type": "string"
|
|
17742
|
+
},
|
|
17743
|
+
"additionalProperties": {}
|
|
17744
|
+
}
|
|
17745
|
+
},
|
|
17746
|
+
"required": [
|
|
17747
|
+
"label",
|
|
17748
|
+
"kind",
|
|
17749
|
+
"folder",
|
|
17750
|
+
"extension",
|
|
17751
|
+
"schema"
|
|
17752
|
+
],
|
|
17753
|
+
"additionalProperties": {}
|
|
17754
|
+
}
|
|
17755
|
+
},
|
|
17756
|
+
"singletons": {
|
|
17757
|
+
"type": "object",
|
|
17758
|
+
"propertyNames": {
|
|
17759
|
+
"type": "string"
|
|
17760
|
+
},
|
|
17761
|
+
"additionalProperties": {
|
|
17762
|
+
"type": "object",
|
|
17763
|
+
"properties": {
|
|
17764
|
+
"label": {
|
|
17765
|
+
"type": "string"
|
|
17766
|
+
},
|
|
17767
|
+
"file": {
|
|
17768
|
+
"type": "string"
|
|
17769
|
+
},
|
|
17770
|
+
"schema": {
|
|
17771
|
+
"type": "object",
|
|
17772
|
+
"propertyNames": {
|
|
17773
|
+
"type": "string"
|
|
17774
|
+
},
|
|
17775
|
+
"additionalProperties": {}
|
|
17776
|
+
}
|
|
17777
|
+
},
|
|
17778
|
+
"required": [
|
|
17779
|
+
"label",
|
|
17780
|
+
"file",
|
|
17781
|
+
"schema"
|
|
17782
|
+
],
|
|
17783
|
+
"additionalProperties": {}
|
|
17784
|
+
}
|
|
17785
|
+
},
|
|
17786
|
+
"settings": {
|
|
17787
|
+
"description": "The settings the owner sees, as site.config.json declares them: get_site_settings reads them with their values.",
|
|
17788
|
+
"type": "array",
|
|
17789
|
+
"items": {
|
|
17790
|
+
"type": "object",
|
|
17791
|
+
"properties": {
|
|
17792
|
+
"id": {
|
|
17793
|
+
"type": "string"
|
|
17794
|
+
},
|
|
17795
|
+
"label": {
|
|
17796
|
+
"type": "string"
|
|
17797
|
+
},
|
|
17798
|
+
"fields": {
|
|
17799
|
+
"type": "array",
|
|
17800
|
+
"items": {
|
|
17801
|
+
"type": "object",
|
|
17802
|
+
"properties": {
|
|
17803
|
+
"field": {
|
|
17804
|
+
"type": "string"
|
|
17805
|
+
}
|
|
17806
|
+
},
|
|
17807
|
+
"required": [
|
|
17808
|
+
"field"
|
|
17809
|
+
],
|
|
17810
|
+
"additionalProperties": {}
|
|
17127
17811
|
}
|
|
17128
|
-
}
|
|
17129
|
-
|
|
17130
|
-
|
|
17131
|
-
|
|
17132
|
-
|
|
17133
|
-
|
|
17134
|
-
|
|
17135
|
-
|
|
17136
|
-
|
|
17137
|
-
|
|
17138
|
-
|
|
17139
|
-
|
|
17140
|
-
|
|
17141
|
-
|
|
17142
|
-
|
|
17143
|
-
|
|
17144
|
-
|
|
17145
|
-
|
|
17812
|
+
}
|
|
17813
|
+
},
|
|
17814
|
+
"required": [
|
|
17815
|
+
"id",
|
|
17816
|
+
"label",
|
|
17817
|
+
"fields"
|
|
17818
|
+
],
|
|
17819
|
+
"additionalProperties": {}
|
|
17820
|
+
}
|
|
17821
|
+
}
|
|
17822
|
+
},
|
|
17823
|
+
"required": [
|
|
17824
|
+
"version",
|
|
17825
|
+
"build_id",
|
|
17826
|
+
"revision",
|
|
17827
|
+
"draft_revision",
|
|
17828
|
+
"stale",
|
|
17829
|
+
"collections",
|
|
17830
|
+
"singletons"
|
|
17831
|
+
],
|
|
17832
|
+
"additionalProperties": false
|
|
17833
|
+
},
|
|
17834
|
+
"request_id": {
|
|
17835
|
+
"type": "string"
|
|
17836
|
+
}
|
|
17837
|
+
},
|
|
17838
|
+
"required": [
|
|
17839
|
+
"data",
|
|
17840
|
+
"request_id"
|
|
17841
|
+
]
|
|
17842
|
+
}
|
|
17843
|
+
}
|
|
17844
|
+
}
|
|
17845
|
+
},
|
|
17846
|
+
"400": {
|
|
17847
|
+
"$ref": "#/components/responses/Error400"
|
|
17848
|
+
},
|
|
17849
|
+
"401": {
|
|
17850
|
+
"$ref": "#/components/responses/Error401"
|
|
17851
|
+
},
|
|
17852
|
+
"402": {
|
|
17853
|
+
"$ref": "#/components/responses/Error402"
|
|
17854
|
+
},
|
|
17855
|
+
"403": {
|
|
17856
|
+
"$ref": "#/components/responses/Error403"
|
|
17857
|
+
},
|
|
17858
|
+
"404": {
|
|
17859
|
+
"$ref": "#/components/responses/Error404"
|
|
17860
|
+
},
|
|
17861
|
+
"409": {
|
|
17862
|
+
"$ref": "#/components/responses/Error409"
|
|
17863
|
+
},
|
|
17864
|
+
"410": {
|
|
17865
|
+
"$ref": "#/components/responses/Error410"
|
|
17866
|
+
},
|
|
17867
|
+
"413": {
|
|
17868
|
+
"$ref": "#/components/responses/Error413"
|
|
17869
|
+
},
|
|
17870
|
+
"422": {
|
|
17871
|
+
"$ref": "#/components/responses/Error422"
|
|
17872
|
+
},
|
|
17873
|
+
"429": {
|
|
17874
|
+
"$ref": "#/components/responses/Error429"
|
|
17875
|
+
},
|
|
17876
|
+
"500": {
|
|
17877
|
+
"$ref": "#/components/responses/Error500"
|
|
17878
|
+
},
|
|
17879
|
+
"503": {
|
|
17880
|
+
"$ref": "#/components/responses/Error503"
|
|
17881
|
+
}
|
|
17882
|
+
}
|
|
17883
|
+
},
|
|
17884
|
+
{
|
|
17885
|
+
"operation_id": "listContentEntries",
|
|
17886
|
+
"method": "GET",
|
|
17887
|
+
"path": "/v1/sites/{site_id}/content/{collection}",
|
|
17888
|
+
"summary": "List entries of a collection",
|
|
17889
|
+
"description": "Entries with their title, draft flag, hash and where they appear on the site.",
|
|
17890
|
+
"authentication_required": true,
|
|
17891
|
+
"scope": "sites:read",
|
|
17892
|
+
"surfaces": {
|
|
17893
|
+
"cli": "atelier201 content list",
|
|
17894
|
+
"mcp": "list_entries"
|
|
17895
|
+
},
|
|
17896
|
+
"parameters": [
|
|
17897
|
+
{
|
|
17898
|
+
"name": "site_id",
|
|
17899
|
+
"in": "path",
|
|
17900
|
+
"required": true,
|
|
17901
|
+
"schema": {
|
|
17902
|
+
"type": "string"
|
|
17903
|
+
},
|
|
17904
|
+
"description": "The site's id, or its slug (the address before .atelier201.page)."
|
|
17905
|
+
},
|
|
17906
|
+
{
|
|
17907
|
+
"name": "collection",
|
|
17908
|
+
"in": "path",
|
|
17909
|
+
"required": true,
|
|
17910
|
+
"schema": {
|
|
17911
|
+
"type": "string"
|
|
17912
|
+
}
|
|
17913
|
+
}
|
|
17914
|
+
],
|
|
17915
|
+
"request_body": null,
|
|
17916
|
+
"responses": {
|
|
17917
|
+
"200": {
|
|
17918
|
+
"description": "List entries of a collection",
|
|
17919
|
+
"content": {
|
|
17920
|
+
"application/json": {
|
|
17921
|
+
"schema": {
|
|
17922
|
+
"type": "object",
|
|
17923
|
+
"properties": {
|
|
17924
|
+
"data": {
|
|
17925
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
17926
|
+
"type": "object",
|
|
17927
|
+
"properties": {
|
|
17928
|
+
"collection": {
|
|
17929
|
+
"type": "string"
|
|
17930
|
+
},
|
|
17931
|
+
"revision": {
|
|
17932
|
+
"anyOf": [
|
|
17933
|
+
{
|
|
17934
|
+
"type": "string",
|
|
17935
|
+
"minLength": 40,
|
|
17936
|
+
"maxLength": 40,
|
|
17937
|
+
"description": "A Git commit id (40 hex characters) of the site's repository."
|
|
17146
17938
|
},
|
|
17147
17939
|
{
|
|
17148
17940
|
"type": "null"
|
|
17149
17941
|
}
|
|
17150
17942
|
]
|
|
17151
17943
|
},
|
|
17152
|
-
"
|
|
17153
|
-
"type":
|
|
17154
|
-
|
|
17155
|
-
"
|
|
17156
|
-
|
|
17944
|
+
"counts": {
|
|
17945
|
+
"type": "object",
|
|
17946
|
+
"properties": {
|
|
17947
|
+
"total": {
|
|
17948
|
+
"type": "integer",
|
|
17949
|
+
"minimum": -9007199254740991,
|
|
17950
|
+
"maximum": 9007199254740991
|
|
17951
|
+
},
|
|
17952
|
+
"published": {
|
|
17953
|
+
"type": "integer",
|
|
17954
|
+
"minimum": -9007199254740991,
|
|
17955
|
+
"maximum": 9007199254740991
|
|
17956
|
+
},
|
|
17957
|
+
"draft": {
|
|
17958
|
+
"type": "integer",
|
|
17959
|
+
"minimum": -9007199254740991,
|
|
17960
|
+
"maximum": 9007199254740991
|
|
17961
|
+
}
|
|
17962
|
+
},
|
|
17963
|
+
"required": [
|
|
17964
|
+
"total",
|
|
17965
|
+
"published",
|
|
17966
|
+
"draft"
|
|
17967
|
+
],
|
|
17968
|
+
"additionalProperties": false,
|
|
17969
|
+
"description": "How many entries, and how many are drafts (hidden from visitors)."
|
|
17970
|
+
},
|
|
17971
|
+
"entries": {
|
|
17972
|
+
"type": "array",
|
|
17973
|
+
"items": {
|
|
17974
|
+
"type": "object",
|
|
17975
|
+
"properties": {
|
|
17976
|
+
"slug": {
|
|
17977
|
+
"type": "string"
|
|
17978
|
+
},
|
|
17979
|
+
"path": {
|
|
17980
|
+
"type": "string"
|
|
17981
|
+
},
|
|
17982
|
+
"title": {
|
|
17983
|
+
"type": "string"
|
|
17984
|
+
},
|
|
17985
|
+
"draft": {
|
|
17986
|
+
"type": "boolean"
|
|
17987
|
+
},
|
|
17988
|
+
"hash": {
|
|
17989
|
+
"type": "string"
|
|
17990
|
+
},
|
|
17991
|
+
"preview_path": {
|
|
17992
|
+
"type": [
|
|
17993
|
+
"string",
|
|
17994
|
+
"null"
|
|
17995
|
+
]
|
|
17996
|
+
},
|
|
17997
|
+
"image": {
|
|
17998
|
+
"description": "The entry's first picture field (a /media path), for a thumbnail. Null when the collection has none or it is empty.",
|
|
17999
|
+
"type": [
|
|
18000
|
+
"string",
|
|
18001
|
+
"null"
|
|
18002
|
+
]
|
|
18003
|
+
},
|
|
18004
|
+
"created_at": {
|
|
18005
|
+
"type": "string",
|
|
18006
|
+
"description": "When the entry was first saved (ISO 8601). An entry written with the site dates from the site."
|
|
18007
|
+
},
|
|
18008
|
+
"edited_at": {
|
|
18009
|
+
"type": "string",
|
|
18010
|
+
"description": "When the entry was last saved (ISO 8601)."
|
|
18011
|
+
},
|
|
18012
|
+
"edited_by": {
|
|
18013
|
+
"description": "Who saved it last (a member, the assistant, an API key). Null when no recorded save names it.",
|
|
18014
|
+
"type": [
|
|
18015
|
+
"string",
|
|
18016
|
+
"null"
|
|
18017
|
+
]
|
|
18018
|
+
}
|
|
18019
|
+
},
|
|
18020
|
+
"required": [
|
|
18021
|
+
"slug",
|
|
18022
|
+
"path",
|
|
18023
|
+
"title",
|
|
18024
|
+
"draft",
|
|
18025
|
+
"hash",
|
|
18026
|
+
"preview_path",
|
|
18027
|
+
"image",
|
|
18028
|
+
"created_at",
|
|
18029
|
+
"edited_at",
|
|
18030
|
+
"edited_by"
|
|
18031
|
+
],
|
|
18032
|
+
"additionalProperties": false
|
|
18033
|
+
}
|
|
17157
18034
|
}
|
|
17158
18035
|
},
|
|
17159
18036
|
"required": [
|
|
17160
|
-
"
|
|
17161
|
-
"
|
|
17162
|
-
"
|
|
18037
|
+
"collection",
|
|
18038
|
+
"revision",
|
|
18039
|
+
"counts",
|
|
18040
|
+
"entries"
|
|
17163
18041
|
],
|
|
17164
18042
|
"additionalProperties": false
|
|
17165
18043
|
},
|
|
@@ -17214,16 +18092,16 @@ export const API_OPERATIONS = [
|
|
|
17214
18092
|
}
|
|
17215
18093
|
},
|
|
17216
18094
|
{
|
|
17217
|
-
"operation_id": "
|
|
18095
|
+
"operation_id": "getContentEntry",
|
|
17218
18096
|
"method": "GET",
|
|
17219
|
-
"path": "/v1/sites/{site_id}/content",
|
|
17220
|
-
"summary": "Read
|
|
17221
|
-
"description": "
|
|
18097
|
+
"path": "/v1/sites/{site_id}/content/{collection}/{slug}",
|
|
18098
|
+
"summary": "Read an entry",
|
|
18099
|
+
"description": "An entry's fields and, for Markdown collections, its body.",
|
|
17222
18100
|
"authentication_required": true,
|
|
17223
18101
|
"scope": "sites:read",
|
|
17224
18102
|
"surfaces": {
|
|
17225
|
-
"cli": "atelier201 content
|
|
17226
|
-
"mcp": "
|
|
18103
|
+
"cli": "atelier201 content get",
|
|
18104
|
+
"mcp": "get_entry"
|
|
17227
18105
|
},
|
|
17228
18106
|
"parameters": [
|
|
17229
18107
|
{
|
|
@@ -17234,12 +18112,28 @@ export const API_OPERATIONS = [
|
|
|
17234
18112
|
"type": "string"
|
|
17235
18113
|
},
|
|
17236
18114
|
"description": "The site's id, or its slug (the address before .atelier201.page)."
|
|
18115
|
+
},
|
|
18116
|
+
{
|
|
18117
|
+
"name": "collection",
|
|
18118
|
+
"in": "path",
|
|
18119
|
+
"required": true,
|
|
18120
|
+
"schema": {
|
|
18121
|
+
"type": "string"
|
|
18122
|
+
}
|
|
18123
|
+
},
|
|
18124
|
+
{
|
|
18125
|
+
"name": "slug",
|
|
18126
|
+
"in": "path",
|
|
18127
|
+
"required": true,
|
|
18128
|
+
"schema": {
|
|
18129
|
+
"type": "string"
|
|
18130
|
+
}
|
|
17237
18131
|
}
|
|
17238
18132
|
],
|
|
17239
18133
|
"request_body": null,
|
|
17240
18134
|
"responses": {
|
|
17241
18135
|
"200": {
|
|
17242
|
-
"description": "Read
|
|
18136
|
+
"description": "Read an entry",
|
|
17243
18137
|
"content": {
|
|
17244
18138
|
"application/json": {
|
|
17245
18139
|
"schema": {
|
|
@@ -17249,13 +18143,14 @@ export const API_OPERATIONS = [
|
|
|
17249
18143
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
17250
18144
|
"type": "object",
|
|
17251
18145
|
"properties": {
|
|
17252
|
-
"
|
|
17253
|
-
"type": "
|
|
17254
|
-
"const": 1
|
|
18146
|
+
"collection": {
|
|
18147
|
+
"type": "string"
|
|
17255
18148
|
},
|
|
17256
|
-
"
|
|
17257
|
-
"type": "string"
|
|
17258
|
-
|
|
18149
|
+
"slug": {
|
|
18150
|
+
"type": "string"
|
|
18151
|
+
},
|
|
18152
|
+
"path": {
|
|
18153
|
+
"type": "string"
|
|
17259
18154
|
},
|
|
17260
18155
|
"revision": {
|
|
17261
18156
|
"type": "string",
|
|
@@ -17263,105 +18158,31 @@ export const API_OPERATIONS = [
|
|
|
17263
18158
|
"maxLength": 40,
|
|
17264
18159
|
"description": "A Git commit id (40 hex characters) of the site's repository."
|
|
17265
18160
|
},
|
|
17266
|
-
"
|
|
17267
|
-
"
|
|
17268
|
-
{
|
|
17269
|
-
"type": "string",
|
|
17270
|
-
"minLength": 40,
|
|
17271
|
-
"maxLength": 40,
|
|
17272
|
-
"description": "A Git commit id (40 hex characters) of the site's repository."
|
|
17273
|
-
},
|
|
17274
|
-
{
|
|
17275
|
-
"type": "null"
|
|
17276
|
-
}
|
|
17277
|
-
],
|
|
17278
|
-
"description": "The draft's revision now. It differs from revision once content was saved since that build, which is fine."
|
|
17279
|
-
},
|
|
17280
|
-
"stale": {
|
|
17281
|
-
"type": "boolean",
|
|
17282
|
-
"description": "True when the files the model is built from changed since this build: writes are then refused (stale_content_model) until the draft is built. Agents never see it true: the call waits for that build."
|
|
18161
|
+
"hash": {
|
|
18162
|
+
"type": "string"
|
|
17283
18163
|
},
|
|
17284
|
-
"
|
|
18164
|
+
"data": {
|
|
17285
18165
|
"type": "object",
|
|
17286
18166
|
"propertyNames": {
|
|
17287
18167
|
"type": "string"
|
|
17288
18168
|
},
|
|
17289
|
-
"additionalProperties": {
|
|
17290
|
-
"type": "object",
|
|
17291
|
-
"properties": {
|
|
17292
|
-
"label": {
|
|
17293
|
-
"type": "string"
|
|
17294
|
-
},
|
|
17295
|
-
"kind": {
|
|
17296
|
-
"type": "string",
|
|
17297
|
-
"enum": [
|
|
17298
|
-
"content",
|
|
17299
|
-
"data"
|
|
17300
|
-
]
|
|
17301
|
-
},
|
|
17302
|
-
"folder": {
|
|
17303
|
-
"type": "string"
|
|
17304
|
-
},
|
|
17305
|
-
"extension": {
|
|
17306
|
-
"type": "string"
|
|
17307
|
-
},
|
|
17308
|
-
"schema": {
|
|
17309
|
-
"type": "object",
|
|
17310
|
-
"propertyNames": {
|
|
17311
|
-
"type": "string"
|
|
17312
|
-
},
|
|
17313
|
-
"additionalProperties": {}
|
|
17314
|
-
}
|
|
17315
|
-
},
|
|
17316
|
-
"required": [
|
|
17317
|
-
"label",
|
|
17318
|
-
"kind",
|
|
17319
|
-
"folder",
|
|
17320
|
-
"extension",
|
|
17321
|
-
"schema"
|
|
17322
|
-
],
|
|
17323
|
-
"additionalProperties": {}
|
|
17324
|
-
}
|
|
18169
|
+
"additionalProperties": {}
|
|
17325
18170
|
},
|
|
17326
|
-
"
|
|
17327
|
-
"type":
|
|
17328
|
-
|
|
17329
|
-
"
|
|
17330
|
-
|
|
17331
|
-
"additionalProperties": {
|
|
17332
|
-
"type": "object",
|
|
17333
|
-
"properties": {
|
|
17334
|
-
"label": {
|
|
17335
|
-
"type": "string"
|
|
17336
|
-
},
|
|
17337
|
-
"file": {
|
|
17338
|
-
"type": "string"
|
|
17339
|
-
},
|
|
17340
|
-
"schema": {
|
|
17341
|
-
"type": "object",
|
|
17342
|
-
"propertyNames": {
|
|
17343
|
-
"type": "string"
|
|
17344
|
-
},
|
|
17345
|
-
"additionalProperties": {}
|
|
17346
|
-
}
|
|
17347
|
-
},
|
|
17348
|
-
"required": [
|
|
17349
|
-
"label",
|
|
17350
|
-
"file",
|
|
17351
|
-
"schema"
|
|
17352
|
-
],
|
|
17353
|
-
"additionalProperties": {}
|
|
17354
|
-
}
|
|
18171
|
+
"body": {
|
|
18172
|
+
"type": [
|
|
18173
|
+
"string",
|
|
18174
|
+
"null"
|
|
18175
|
+
]
|
|
17355
18176
|
}
|
|
17356
18177
|
},
|
|
17357
18178
|
"required": [
|
|
17358
|
-
"
|
|
17359
|
-
"
|
|
18179
|
+
"collection",
|
|
18180
|
+
"slug",
|
|
18181
|
+
"path",
|
|
17360
18182
|
"revision",
|
|
17361
|
-
"
|
|
17362
|
-
"
|
|
17363
|
-
"
|
|
17364
|
-
"singletons"
|
|
18183
|
+
"hash",
|
|
18184
|
+
"data",
|
|
18185
|
+
"body"
|
|
17365
18186
|
],
|
|
17366
18187
|
"additionalProperties": false
|
|
17367
18188
|
},
|
|
@@ -17416,16 +18237,16 @@ export const API_OPERATIONS = [
|
|
|
17416
18237
|
}
|
|
17417
18238
|
},
|
|
17418
18239
|
{
|
|
17419
|
-
"operation_id": "
|
|
17420
|
-
"method": "
|
|
17421
|
-
"path": "/v1/sites/{site_id}/content/{collection}",
|
|
17422
|
-
"summary": "
|
|
17423
|
-
"description": "
|
|
18240
|
+
"operation_id": "saveContentEntry",
|
|
18241
|
+
"method": "PUT",
|
|
18242
|
+
"path": "/v1/sites/{site_id}/content/{collection}/{slug}",
|
|
18243
|
+
"summary": "Create or update an entry",
|
|
18244
|
+
"description": "Validated against the collection's schema first: an invalid field is a 400 naming the field, and nothing is written. A new entry created through the API starts as a draft when the collection has a draft field. One history entry.",
|
|
17424
18245
|
"authentication_required": true,
|
|
17425
|
-
"scope": "sites:
|
|
18246
|
+
"scope": "sites:write",
|
|
17426
18247
|
"surfaces": {
|
|
17427
|
-
"cli": "atelier201 content
|
|
17428
|
-
"mcp": "
|
|
18248
|
+
"cli": "atelier201 content save",
|
|
18249
|
+
"mcp": "save_entry"
|
|
17429
18250
|
},
|
|
17430
18251
|
"parameters": [
|
|
17431
18252
|
{
|
|
@@ -17444,12 +18265,59 @@ export const API_OPERATIONS = [
|
|
|
17444
18265
|
"schema": {
|
|
17445
18266
|
"type": "string"
|
|
17446
18267
|
}
|
|
18268
|
+
},
|
|
18269
|
+
{
|
|
18270
|
+
"name": "slug",
|
|
18271
|
+
"in": "path",
|
|
18272
|
+
"required": true,
|
|
18273
|
+
"schema": {
|
|
18274
|
+
"type": "string"
|
|
18275
|
+
}
|
|
17447
18276
|
}
|
|
17448
18277
|
],
|
|
17449
|
-
"request_body":
|
|
18278
|
+
"request_body": {
|
|
18279
|
+
"required": true,
|
|
18280
|
+
"content": {
|
|
18281
|
+
"application/json": {
|
|
18282
|
+
"schema": {
|
|
18283
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
18284
|
+
"type": "object",
|
|
18285
|
+
"properties": {
|
|
18286
|
+
"data": {
|
|
18287
|
+
"type": "object",
|
|
18288
|
+
"propertyNames": {
|
|
18289
|
+
"type": "string"
|
|
18290
|
+
},
|
|
18291
|
+
"additionalProperties": {},
|
|
18292
|
+
"description": "The fields of the entry, as the collection's schema defines them (get_content_model)."
|
|
18293
|
+
},
|
|
18294
|
+
"body": {
|
|
18295
|
+
"description": "Markdown body, for content collections.",
|
|
18296
|
+
"type": "string",
|
|
18297
|
+
"maxLength": 500000
|
|
18298
|
+
},
|
|
18299
|
+
"expected_hash": {
|
|
18300
|
+
"type": [
|
|
18301
|
+
"string",
|
|
18302
|
+
"null"
|
|
18303
|
+
]
|
|
18304
|
+
},
|
|
18305
|
+
"create_only": {
|
|
18306
|
+
"description": "Refuse instead of overwriting when the entry exists.",
|
|
18307
|
+
"type": "boolean"
|
|
18308
|
+
}
|
|
18309
|
+
},
|
|
18310
|
+
"required": [
|
|
18311
|
+
"data"
|
|
18312
|
+
],
|
|
18313
|
+
"additionalProperties": false
|
|
18314
|
+
}
|
|
18315
|
+
}
|
|
18316
|
+
}
|
|
18317
|
+
},
|
|
17450
18318
|
"responses": {
|
|
17451
18319
|
"200": {
|
|
17452
|
-
"description": "
|
|
18320
|
+
"description": "Create or update an entry",
|
|
17453
18321
|
"content": {
|
|
17454
18322
|
"application/json": {
|
|
17455
18323
|
"schema": {
|
|
@@ -17462,118 +18330,42 @@ export const API_OPERATIONS = [
|
|
|
17462
18330
|
"collection": {
|
|
17463
18331
|
"type": "string"
|
|
17464
18332
|
},
|
|
17465
|
-
"
|
|
17466
|
-
"
|
|
17467
|
-
{
|
|
17468
|
-
"type": "string",
|
|
17469
|
-
"minLength": 40,
|
|
17470
|
-
"maxLength": 40,
|
|
17471
|
-
"description": "A Git commit id (40 hex characters) of the site's repository."
|
|
17472
|
-
},
|
|
17473
|
-
{
|
|
17474
|
-
"type": "null"
|
|
17475
|
-
}
|
|
17476
|
-
]
|
|
18333
|
+
"slug": {
|
|
18334
|
+
"type": "string"
|
|
17477
18335
|
},
|
|
17478
|
-
"
|
|
17479
|
-
"type": "
|
|
17480
|
-
|
|
17481
|
-
|
|
17482
|
-
|
|
17483
|
-
"minimum": -9007199254740991,
|
|
17484
|
-
"maximum": 9007199254740991
|
|
17485
|
-
},
|
|
17486
|
-
"published": {
|
|
17487
|
-
"type": "integer",
|
|
17488
|
-
"minimum": -9007199254740991,
|
|
17489
|
-
"maximum": 9007199254740991
|
|
17490
|
-
},
|
|
17491
|
-
"draft": {
|
|
17492
|
-
"type": "integer",
|
|
17493
|
-
"minimum": -9007199254740991,
|
|
17494
|
-
"maximum": 9007199254740991
|
|
17495
|
-
}
|
|
17496
|
-
},
|
|
17497
|
-
"required": [
|
|
17498
|
-
"total",
|
|
17499
|
-
"published",
|
|
17500
|
-
"draft"
|
|
17501
|
-
],
|
|
17502
|
-
"additionalProperties": false,
|
|
17503
|
-
"description": "How many entries, and how many are drafts (hidden from visitors)."
|
|
18336
|
+
"path": {
|
|
18337
|
+
"type": "string"
|
|
18338
|
+
},
|
|
18339
|
+
"created": {
|
|
18340
|
+
"type": "boolean"
|
|
17504
18341
|
},
|
|
17505
|
-
"
|
|
17506
|
-
"type": "
|
|
17507
|
-
|
|
17508
|
-
|
|
17509
|
-
|
|
17510
|
-
|
|
17511
|
-
|
|
17512
|
-
|
|
17513
|
-
|
|
17514
|
-
|
|
17515
|
-
|
|
17516
|
-
|
|
17517
|
-
|
|
17518
|
-
|
|
17519
|
-
"draft": {
|
|
17520
|
-
"type": "boolean"
|
|
17521
|
-
},
|
|
17522
|
-
"hash": {
|
|
17523
|
-
"type": "string"
|
|
17524
|
-
},
|
|
17525
|
-
"preview_path": {
|
|
17526
|
-
"type": [
|
|
17527
|
-
"string",
|
|
17528
|
-
"null"
|
|
17529
|
-
]
|
|
17530
|
-
},
|
|
17531
|
-
"image": {
|
|
17532
|
-
"description": "The entry's first picture field (a /media path), for a thumbnail. Null when the collection has none or it is empty.",
|
|
17533
|
-
"type": [
|
|
17534
|
-
"string",
|
|
17535
|
-
"null"
|
|
17536
|
-
]
|
|
17537
|
-
},
|
|
17538
|
-
"created_at": {
|
|
17539
|
-
"type": "string",
|
|
17540
|
-
"description": "When the entry was first saved (ISO 8601). An entry written with the site dates from the site."
|
|
17541
|
-
},
|
|
17542
|
-
"edited_at": {
|
|
17543
|
-
"type": "string",
|
|
17544
|
-
"description": "When the entry was last saved (ISO 8601)."
|
|
17545
|
-
},
|
|
17546
|
-
"edited_by": {
|
|
17547
|
-
"description": "Who saved it last (a member, the assistant, an API key). Null when no recorded save names it.",
|
|
17548
|
-
"type": [
|
|
17549
|
-
"string",
|
|
17550
|
-
"null"
|
|
17551
|
-
]
|
|
17552
|
-
}
|
|
17553
|
-
},
|
|
17554
|
-
"required": [
|
|
17555
|
-
"slug",
|
|
17556
|
-
"path",
|
|
17557
|
-
"title",
|
|
17558
|
-
"draft",
|
|
17559
|
-
"hash",
|
|
17560
|
-
"preview_path",
|
|
17561
|
-
"image",
|
|
17562
|
-
"created_at",
|
|
17563
|
-
"edited_at",
|
|
17564
|
-
"edited_by"
|
|
17565
|
-
],
|
|
17566
|
-
"additionalProperties": false
|
|
17567
|
-
}
|
|
18342
|
+
"draft": {
|
|
18343
|
+
"type": "boolean"
|
|
18344
|
+
},
|
|
18345
|
+
"revision": {
|
|
18346
|
+
"type": "string",
|
|
18347
|
+
"minLength": 40,
|
|
18348
|
+
"maxLength": 40,
|
|
18349
|
+
"description": "A Git commit id (40 hex characters) of the site's repository."
|
|
18350
|
+
},
|
|
18351
|
+
"changed": {
|
|
18352
|
+
"type": "boolean"
|
|
18353
|
+
},
|
|
18354
|
+
"next_action": {
|
|
18355
|
+
"type": "string"
|
|
17568
18356
|
}
|
|
17569
18357
|
},
|
|
17570
18358
|
"required": [
|
|
17571
18359
|
"collection",
|
|
18360
|
+
"slug",
|
|
18361
|
+
"path",
|
|
18362
|
+
"created",
|
|
18363
|
+
"draft",
|
|
17572
18364
|
"revision",
|
|
17573
|
-
"
|
|
17574
|
-
"
|
|
18365
|
+
"changed",
|
|
18366
|
+
"next_action"
|
|
17575
18367
|
],
|
|
17576
|
-
"additionalProperties":
|
|
18368
|
+
"additionalProperties": {}
|
|
17577
18369
|
},
|
|
17578
18370
|
"request_id": {
|
|
17579
18371
|
"type": "string"
|
|
@@ -17626,16 +18418,16 @@ export const API_OPERATIONS = [
|
|
|
17626
18418
|
}
|
|
17627
18419
|
},
|
|
17628
18420
|
{
|
|
17629
|
-
"operation_id": "
|
|
17630
|
-
"method": "
|
|
18421
|
+
"operation_id": "deleteContentEntry",
|
|
18422
|
+
"method": "DELETE",
|
|
17631
18423
|
"path": "/v1/sites/{site_id}/content/{collection}/{slug}",
|
|
17632
|
-
"summary": "
|
|
17633
|
-
"description": "
|
|
18424
|
+
"summary": "Delete an entry",
|
|
18425
|
+
"description": "Removes the entry from the draft (one history entry; restorable from the history).",
|
|
17634
18426
|
"authentication_required": true,
|
|
17635
|
-
"scope": "sites:
|
|
18427
|
+
"scope": "sites:write",
|
|
17636
18428
|
"surfaces": {
|
|
17637
|
-
"cli": "atelier201 content
|
|
17638
|
-
"mcp": "
|
|
18429
|
+
"cli": "atelier201 content delete",
|
|
18430
|
+
"mcp": "delete_entry"
|
|
17639
18431
|
},
|
|
17640
18432
|
"parameters": [
|
|
17641
18433
|
{
|
|
@@ -17667,7 +18459,7 @@ export const API_OPERATIONS = [
|
|
|
17667
18459
|
"request_body": null,
|
|
17668
18460
|
"responses": {
|
|
17669
18461
|
"200": {
|
|
17670
|
-
"description": "
|
|
18462
|
+
"description": "Delete an entry",
|
|
17671
18463
|
"content": {
|
|
17672
18464
|
"application/json": {
|
|
17673
18465
|
"schema": {
|
|
@@ -17683,42 +18475,23 @@ export const API_OPERATIONS = [
|
|
|
17683
18475
|
"slug": {
|
|
17684
18476
|
"type": "string"
|
|
17685
18477
|
},
|
|
17686
|
-
"
|
|
17687
|
-
"type": "
|
|
18478
|
+
"deleted": {
|
|
18479
|
+
"type": "boolean"
|
|
17688
18480
|
},
|
|
17689
18481
|
"revision": {
|
|
17690
18482
|
"type": "string",
|
|
17691
18483
|
"minLength": 40,
|
|
17692
18484
|
"maxLength": 40,
|
|
17693
18485
|
"description": "A Git commit id (40 hex characters) of the site's repository."
|
|
17694
|
-
},
|
|
17695
|
-
"hash": {
|
|
17696
|
-
"type": "string"
|
|
17697
|
-
},
|
|
17698
|
-
"data": {
|
|
17699
|
-
"type": "object",
|
|
17700
|
-
"propertyNames": {
|
|
17701
|
-
"type": "string"
|
|
17702
|
-
},
|
|
17703
|
-
"additionalProperties": {}
|
|
17704
|
-
},
|
|
17705
|
-
"body": {
|
|
17706
|
-
"type": [
|
|
17707
|
-
"string",
|
|
17708
|
-
"null"
|
|
17709
|
-
]
|
|
17710
18486
|
}
|
|
17711
18487
|
},
|
|
17712
18488
|
"required": [
|
|
17713
18489
|
"collection",
|
|
17714
18490
|
"slug",
|
|
17715
|
-
"
|
|
17716
|
-
"revision"
|
|
17717
|
-
"hash",
|
|
17718
|
-
"data",
|
|
17719
|
-
"body"
|
|
18491
|
+
"deleted",
|
|
18492
|
+
"revision"
|
|
17720
18493
|
],
|
|
17721
|
-
"additionalProperties":
|
|
18494
|
+
"additionalProperties": {}
|
|
17722
18495
|
},
|
|
17723
18496
|
"request_id": {
|
|
17724
18497
|
"type": "string"
|
|
@@ -17771,16 +18544,16 @@ export const API_OPERATIONS = [
|
|
|
17771
18544
|
}
|
|
17772
18545
|
},
|
|
17773
18546
|
{
|
|
17774
|
-
"operation_id": "
|
|
17775
|
-
"method": "
|
|
17776
|
-
"path": "/v1/sites/{site_id}/content
|
|
17777
|
-
"summary": "Create or
|
|
17778
|
-
"description": "
|
|
18547
|
+
"operation_id": "saveContentEntries",
|
|
18548
|
+
"method": "POST",
|
|
18549
|
+
"path": "/v1/sites/{site_id}/content:batch",
|
|
18550
|
+
"summary": "Create, update or delete many entries",
|
|
18551
|
+
"description": "Up to 200 entries across collections in one history entry: an import or a clean-up. Validated as a whole: if one is refused, nothing is written and the 400 lists every entry to fix. New entries of collections with a draft field start as drafts.",
|
|
17779
18552
|
"authentication_required": true,
|
|
17780
18553
|
"scope": "sites:write",
|
|
17781
18554
|
"surfaces": {
|
|
17782
|
-
"cli": "atelier201 content save",
|
|
17783
|
-
"mcp": "
|
|
18555
|
+
"cli": "atelier201 content save-many",
|
|
18556
|
+
"mcp": "save_entries"
|
|
17784
18557
|
},
|
|
17785
18558
|
"parameters": [
|
|
17786
18559
|
{
|
|
@@ -17791,22 +18564,6 @@ export const API_OPERATIONS = [
|
|
|
17791
18564
|
"type": "string"
|
|
17792
18565
|
},
|
|
17793
18566
|
"description": "The site's id, or its slug (the address before .atelier201.page)."
|
|
17794
|
-
},
|
|
17795
|
-
{
|
|
17796
|
-
"name": "collection",
|
|
17797
|
-
"in": "path",
|
|
17798
|
-
"required": true,
|
|
17799
|
-
"schema": {
|
|
17800
|
-
"type": "string"
|
|
17801
|
-
}
|
|
17802
|
-
},
|
|
17803
|
-
{
|
|
17804
|
-
"name": "slug",
|
|
17805
|
-
"in": "path",
|
|
17806
|
-
"required": true,
|
|
17807
|
-
"schema": {
|
|
17808
|
-
"type": "string"
|
|
17809
|
-
}
|
|
17810
18567
|
}
|
|
17811
18568
|
],
|
|
17812
18569
|
"request_body": {
|
|
@@ -17817,32 +18574,53 @@ export const API_OPERATIONS = [
|
|
|
17817
18574
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
17818
18575
|
"type": "object",
|
|
17819
18576
|
"properties": {
|
|
17820
|
-
"
|
|
17821
|
-
"
|
|
17822
|
-
"propertyNames": {
|
|
17823
|
-
"type": "string"
|
|
17824
|
-
},
|
|
17825
|
-
"additionalProperties": {},
|
|
17826
|
-
"description": "The fields of the entry, as the collection's schema defines them (get_content_model)."
|
|
17827
|
-
},
|
|
17828
|
-
"body": {
|
|
17829
|
-
"description": "Markdown body, for content collections.",
|
|
18577
|
+
"summary": {
|
|
18578
|
+
"description": "One sentence for the history.",
|
|
17830
18579
|
"type": "string",
|
|
17831
|
-
"maxLength":
|
|
17832
|
-
},
|
|
17833
|
-
"expected_hash": {
|
|
17834
|
-
"type": [
|
|
17835
|
-
"string",
|
|
17836
|
-
"null"
|
|
17837
|
-
]
|
|
18580
|
+
"maxLength": 200
|
|
17838
18581
|
},
|
|
17839
|
-
"
|
|
17840
|
-
"
|
|
17841
|
-
"
|
|
18582
|
+
"changes": {
|
|
18583
|
+
"minItems": 1,
|
|
18584
|
+
"maxItems": 200,
|
|
18585
|
+
"type": "array",
|
|
18586
|
+
"items": {
|
|
18587
|
+
"type": "object",
|
|
18588
|
+
"properties": {
|
|
18589
|
+
"collection": {
|
|
18590
|
+
"type": "string"
|
|
18591
|
+
},
|
|
18592
|
+
"slug": {
|
|
18593
|
+
"type": "string",
|
|
18594
|
+
"description": "Lowercase letters, digits and hyphens."
|
|
18595
|
+
},
|
|
18596
|
+
"data": {
|
|
18597
|
+
"description": "The fields, as the collection's schema defines them (not for delete).",
|
|
18598
|
+
"type": "object",
|
|
18599
|
+
"propertyNames": {
|
|
18600
|
+
"type": "string"
|
|
18601
|
+
},
|
|
18602
|
+
"additionalProperties": {}
|
|
18603
|
+
},
|
|
18604
|
+
"body": {
|
|
18605
|
+
"description": "Markdown body, for content collections.",
|
|
18606
|
+
"type": "string",
|
|
18607
|
+
"maxLength": 500000
|
|
18608
|
+
},
|
|
18609
|
+
"delete": {
|
|
18610
|
+
"description": "true to delete this entry.",
|
|
18611
|
+
"type": "boolean"
|
|
18612
|
+
}
|
|
18613
|
+
},
|
|
18614
|
+
"required": [
|
|
18615
|
+
"collection",
|
|
18616
|
+
"slug"
|
|
18617
|
+
],
|
|
18618
|
+
"additionalProperties": false
|
|
18619
|
+
}
|
|
17842
18620
|
}
|
|
17843
18621
|
},
|
|
17844
18622
|
"required": [
|
|
17845
|
-
"
|
|
18623
|
+
"changes"
|
|
17846
18624
|
],
|
|
17847
18625
|
"additionalProperties": false
|
|
17848
18626
|
}
|
|
@@ -17851,7 +18629,7 @@ export const API_OPERATIONS = [
|
|
|
17851
18629
|
},
|
|
17852
18630
|
"responses": {
|
|
17853
18631
|
"200": {
|
|
17854
|
-
"description": "Create or
|
|
18632
|
+
"description": "Create, update or delete many entries",
|
|
17855
18633
|
"content": {
|
|
17856
18634
|
"application/json": {
|
|
17857
18635
|
"schema": {
|
|
@@ -17861,43 +18639,16 @@ export const API_OPERATIONS = [
|
|
|
17861
18639
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
17862
18640
|
"type": "object",
|
|
17863
18641
|
"properties": {
|
|
17864
|
-
"
|
|
17865
|
-
"type": "
|
|
17866
|
-
},
|
|
17867
|
-
"slug": {
|
|
17868
|
-
"type": "string"
|
|
17869
|
-
},
|
|
17870
|
-
"path": {
|
|
17871
|
-
"type": "string"
|
|
17872
|
-
},
|
|
17873
|
-
"created": {
|
|
17874
|
-
"type": "boolean"
|
|
17875
|
-
},
|
|
17876
|
-
"draft": {
|
|
17877
|
-
"type": "boolean"
|
|
17878
|
-
},
|
|
17879
|
-
"revision": {
|
|
17880
|
-
"type": "string",
|
|
17881
|
-
"minLength": 40,
|
|
17882
|
-
"maxLength": 40,
|
|
17883
|
-
"description": "A Git commit id (40 hex characters) of the site's repository."
|
|
17884
|
-
},
|
|
17885
|
-
"changed": {
|
|
17886
|
-
"type": "boolean"
|
|
18642
|
+
"saved": {
|
|
18643
|
+
"type": "number"
|
|
17887
18644
|
},
|
|
17888
|
-
"
|
|
17889
|
-
"type": "
|
|
18645
|
+
"deleted": {
|
|
18646
|
+
"type": "number"
|
|
17890
18647
|
}
|
|
17891
18648
|
},
|
|
17892
18649
|
"required": [
|
|
17893
|
-
"
|
|
17894
|
-
"
|
|
17895
|
-
"path",
|
|
17896
|
-
"created",
|
|
17897
|
-
"draft",
|
|
17898
|
-
"revision",
|
|
17899
|
-
"changed",
|
|
17900
|
-
"next_action"
|
|
18650
|
+
"saved",
|
|
18651
|
+
"deleted"
|
|
17901
18652
|
],
|
|
17902
18653
|
"additionalProperties": {}
|
|
17903
18654
|
},
|
|
@@ -17952,16 +18703,16 @@ export const API_OPERATIONS = [
|
|
|
17952
18703
|
}
|
|
17953
18704
|
},
|
|
17954
18705
|
{
|
|
17955
|
-
"operation_id": "
|
|
17956
|
-
"method": "
|
|
17957
|
-
"path": "/v1/sites/{site_id}/
|
|
17958
|
-
"summary": "
|
|
17959
|
-
"description": "
|
|
18706
|
+
"operation_id": "getSingleton",
|
|
18707
|
+
"method": "GET",
|
|
18708
|
+
"path": "/v1/sites/{site_id}/singletons/{name}",
|
|
18709
|
+
"summary": "Read a singleton",
|
|
18710
|
+
"description": "Business details, theme or navigation: one JSON document.",
|
|
17960
18711
|
"authentication_required": true,
|
|
17961
|
-
"scope": "sites:
|
|
18712
|
+
"scope": "sites:read",
|
|
17962
18713
|
"surfaces": {
|
|
17963
|
-
"cli": "atelier201 content
|
|
17964
|
-
"mcp": "
|
|
18714
|
+
"cli": "atelier201 content singleton",
|
|
18715
|
+
"mcp": "get_singleton"
|
|
17965
18716
|
},
|
|
17966
18717
|
"parameters": [
|
|
17967
18718
|
{
|
|
@@ -17974,15 +18725,7 @@ export const API_OPERATIONS = [
|
|
|
17974
18725
|
"description": "The site's id, or its slug (the address before .atelier201.page)."
|
|
17975
18726
|
},
|
|
17976
18727
|
{
|
|
17977
|
-
"name": "
|
|
17978
|
-
"in": "path",
|
|
17979
|
-
"required": true,
|
|
17980
|
-
"schema": {
|
|
17981
|
-
"type": "string"
|
|
17982
|
-
}
|
|
17983
|
-
},
|
|
17984
|
-
{
|
|
17985
|
-
"name": "slug",
|
|
18728
|
+
"name": "name",
|
|
17986
18729
|
"in": "path",
|
|
17987
18730
|
"required": true,
|
|
17988
18731
|
"schema": {
|
|
@@ -17993,7 +18736,7 @@ export const API_OPERATIONS = [
|
|
|
17993
18736
|
"request_body": null,
|
|
17994
18737
|
"responses": {
|
|
17995
18738
|
"200": {
|
|
17996
|
-
"description": "
|
|
18739
|
+
"description": "Read a singleton",
|
|
17997
18740
|
"content": {
|
|
17998
18741
|
"application/json": {
|
|
17999
18742
|
"schema": {
|
|
@@ -18003,29 +18746,37 @@ export const API_OPERATIONS = [
|
|
|
18003
18746
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
18004
18747
|
"type": "object",
|
|
18005
18748
|
"properties": {
|
|
18006
|
-
"
|
|
18749
|
+
"singleton": {
|
|
18007
18750
|
"type": "string"
|
|
18008
18751
|
},
|
|
18009
|
-
"
|
|
18752
|
+
"path": {
|
|
18010
18753
|
"type": "string"
|
|
18011
18754
|
},
|
|
18012
|
-
"deleted": {
|
|
18013
|
-
"type": "boolean"
|
|
18014
|
-
},
|
|
18015
18755
|
"revision": {
|
|
18016
18756
|
"type": "string",
|
|
18017
18757
|
"minLength": 40,
|
|
18018
18758
|
"maxLength": 40,
|
|
18019
18759
|
"description": "A Git commit id (40 hex characters) of the site's repository."
|
|
18760
|
+
},
|
|
18761
|
+
"hash": {
|
|
18762
|
+
"type": "string"
|
|
18763
|
+
},
|
|
18764
|
+
"data": {
|
|
18765
|
+
"type": "object",
|
|
18766
|
+
"propertyNames": {
|
|
18767
|
+
"type": "string"
|
|
18768
|
+
},
|
|
18769
|
+
"additionalProperties": {}
|
|
18020
18770
|
}
|
|
18021
18771
|
},
|
|
18022
18772
|
"required": [
|
|
18023
|
-
"
|
|
18024
|
-
"
|
|
18025
|
-
"
|
|
18026
|
-
"
|
|
18773
|
+
"singleton",
|
|
18774
|
+
"path",
|
|
18775
|
+
"revision",
|
|
18776
|
+
"hash",
|
|
18777
|
+
"data"
|
|
18027
18778
|
],
|
|
18028
|
-
"additionalProperties":
|
|
18779
|
+
"additionalProperties": false
|
|
18029
18780
|
},
|
|
18030
18781
|
"request_id": {
|
|
18031
18782
|
"type": "string"
|
|
@@ -18078,16 +18829,16 @@ export const API_OPERATIONS = [
|
|
|
18078
18829
|
}
|
|
18079
18830
|
},
|
|
18080
18831
|
{
|
|
18081
|
-
"operation_id": "
|
|
18082
|
-
"method": "
|
|
18083
|
-
"path": "/v1/sites/{site_id}/
|
|
18084
|
-
"summary": "
|
|
18085
|
-
"description": "
|
|
18832
|
+
"operation_id": "saveSingleton",
|
|
18833
|
+
"method": "PUT",
|
|
18834
|
+
"path": "/v1/sites/{site_id}/singletons/{name}",
|
|
18835
|
+
"summary": "Replace a singleton",
|
|
18836
|
+
"description": "The whole document, validated against its schema. To change one text, setContentField is safer.",
|
|
18086
18837
|
"authentication_required": true,
|
|
18087
18838
|
"scope": "sites:write",
|
|
18088
18839
|
"surfaces": {
|
|
18089
|
-
"cli": "atelier201 content save-
|
|
18090
|
-
"mcp": "
|
|
18840
|
+
"cli": "atelier201 content save-singleton",
|
|
18841
|
+
"mcp": "save_singleton"
|
|
18091
18842
|
},
|
|
18092
18843
|
"parameters": [
|
|
18093
18844
|
{
|
|
@@ -18098,6 +18849,14 @@ export const API_OPERATIONS = [
|
|
|
18098
18849
|
"type": "string"
|
|
18099
18850
|
},
|
|
18100
18851
|
"description": "The site's id, or its slug (the address before .atelier201.page)."
|
|
18852
|
+
},
|
|
18853
|
+
{
|
|
18854
|
+
"name": "name",
|
|
18855
|
+
"in": "path",
|
|
18856
|
+
"required": true,
|
|
18857
|
+
"schema": {
|
|
18858
|
+
"type": "string"
|
|
18859
|
+
}
|
|
18101
18860
|
}
|
|
18102
18861
|
],
|
|
18103
18862
|
"request_body": {
|
|
@@ -18108,53 +18867,22 @@ export const API_OPERATIONS = [
|
|
|
18108
18867
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
18109
18868
|
"type": "object",
|
|
18110
18869
|
"properties": {
|
|
18111
|
-
"
|
|
18112
|
-
"
|
|
18113
|
-
"
|
|
18114
|
-
|
|
18870
|
+
"data": {
|
|
18871
|
+
"type": "object",
|
|
18872
|
+
"propertyNames": {
|
|
18873
|
+
"type": "string"
|
|
18874
|
+
},
|
|
18875
|
+
"additionalProperties": {}
|
|
18115
18876
|
},
|
|
18116
|
-
"
|
|
18117
|
-
"
|
|
18118
|
-
|
|
18119
|
-
|
|
18120
|
-
|
|
18121
|
-
"type": "object",
|
|
18122
|
-
"properties": {
|
|
18123
|
-
"collection": {
|
|
18124
|
-
"type": "string"
|
|
18125
|
-
},
|
|
18126
|
-
"slug": {
|
|
18127
|
-
"type": "string",
|
|
18128
|
-
"description": "Lowercase letters, digits and hyphens."
|
|
18129
|
-
},
|
|
18130
|
-
"data": {
|
|
18131
|
-
"description": "The fields, as the collection's schema defines them (not for delete).",
|
|
18132
|
-
"type": "object",
|
|
18133
|
-
"propertyNames": {
|
|
18134
|
-
"type": "string"
|
|
18135
|
-
},
|
|
18136
|
-
"additionalProperties": {}
|
|
18137
|
-
},
|
|
18138
|
-
"body": {
|
|
18139
|
-
"description": "Markdown body, for content collections.",
|
|
18140
|
-
"type": "string",
|
|
18141
|
-
"maxLength": 500000
|
|
18142
|
-
},
|
|
18143
|
-
"delete": {
|
|
18144
|
-
"description": "true to delete this entry.",
|
|
18145
|
-
"type": "boolean"
|
|
18146
|
-
}
|
|
18147
|
-
},
|
|
18148
|
-
"required": [
|
|
18149
|
-
"collection",
|
|
18150
|
-
"slug"
|
|
18151
|
-
],
|
|
18152
|
-
"additionalProperties": false
|
|
18153
|
-
}
|
|
18877
|
+
"expected_hash": {
|
|
18878
|
+
"type": [
|
|
18879
|
+
"string",
|
|
18880
|
+
"null"
|
|
18881
|
+
]
|
|
18154
18882
|
}
|
|
18155
18883
|
},
|
|
18156
18884
|
"required": [
|
|
18157
|
-
"
|
|
18885
|
+
"data"
|
|
18158
18886
|
],
|
|
18159
18887
|
"additionalProperties": false
|
|
18160
18888
|
}
|
|
@@ -18163,7 +18891,7 @@ export const API_OPERATIONS = [
|
|
|
18163
18891
|
},
|
|
18164
18892
|
"responses": {
|
|
18165
18893
|
"200": {
|
|
18166
|
-
"description": "
|
|
18894
|
+
"description": "Replace a singleton",
|
|
18167
18895
|
"content": {
|
|
18168
18896
|
"application/json": {
|
|
18169
18897
|
"schema": {
|
|
@@ -18173,16 +18901,23 @@ export const API_OPERATIONS = [
|
|
|
18173
18901
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
18174
18902
|
"type": "object",
|
|
18175
18903
|
"properties": {
|
|
18176
|
-
"
|
|
18177
|
-
"type": "
|
|
18904
|
+
"singleton": {
|
|
18905
|
+
"type": "string"
|
|
18178
18906
|
},
|
|
18179
|
-
"
|
|
18180
|
-
"type": "
|
|
18907
|
+
"revision": {
|
|
18908
|
+
"type": "string",
|
|
18909
|
+
"minLength": 40,
|
|
18910
|
+
"maxLength": 40,
|
|
18911
|
+
"description": "A Git commit id (40 hex characters) of the site's repository."
|
|
18912
|
+
},
|
|
18913
|
+
"changed": {
|
|
18914
|
+
"type": "boolean"
|
|
18181
18915
|
}
|
|
18182
18916
|
},
|
|
18183
18917
|
"required": [
|
|
18184
|
-
"
|
|
18185
|
-
"
|
|
18918
|
+
"singleton",
|
|
18919
|
+
"revision",
|
|
18920
|
+
"changed"
|
|
18186
18921
|
],
|
|
18187
18922
|
"additionalProperties": {}
|
|
18188
18923
|
},
|
|
@@ -18237,16 +18972,16 @@ export const API_OPERATIONS = [
|
|
|
18237
18972
|
}
|
|
18238
18973
|
},
|
|
18239
18974
|
{
|
|
18240
|
-
"operation_id": "
|
|
18975
|
+
"operation_id": "getSiteSettings",
|
|
18241
18976
|
"method": "GET",
|
|
18242
|
-
"path": "/v1/sites/{site_id}/
|
|
18243
|
-
"summary": "Read
|
|
18244
|
-
"description": "
|
|
18977
|
+
"path": "/v1/sites/{site_id}/settings",
|
|
18978
|
+
"summary": "Read the site's settings",
|
|
18979
|
+
"description": "The settings the owner sees in Content, Customize: sections the site's agent chose, each field with its address (<singleton>:<JSON pointer>), label, widget (color, font, image, select...) and current value. Empty when the site declares none (site.config.json, `settings`). Costs nothing.",
|
|
18245
18980
|
"authentication_required": true,
|
|
18246
18981
|
"scope": "sites:read",
|
|
18247
18982
|
"surfaces": {
|
|
18248
|
-
"cli": "atelier201
|
|
18249
|
-
"mcp": "
|
|
18983
|
+
"cli": "atelier201 settings get",
|
|
18984
|
+
"mcp": "get_site_settings"
|
|
18250
18985
|
},
|
|
18251
18986
|
"parameters": [
|
|
18252
18987
|
{
|
|
@@ -18257,20 +18992,12 @@ export const API_OPERATIONS = [
|
|
|
18257
18992
|
"type": "string"
|
|
18258
18993
|
},
|
|
18259
18994
|
"description": "The site's id, or its slug (the address before .atelier201.page)."
|
|
18260
|
-
},
|
|
18261
|
-
{
|
|
18262
|
-
"name": "name",
|
|
18263
|
-
"in": "path",
|
|
18264
|
-
"required": true,
|
|
18265
|
-
"schema": {
|
|
18266
|
-
"type": "string"
|
|
18267
|
-
}
|
|
18268
18995
|
}
|
|
18269
18996
|
],
|
|
18270
18997
|
"request_body": null,
|
|
18271
18998
|
"responses": {
|
|
18272
18999
|
"200": {
|
|
18273
|
-
"description": "Read
|
|
19000
|
+
"description": "Read the site's settings",
|
|
18274
19001
|
"content": {
|
|
18275
19002
|
"application/json": {
|
|
18276
19003
|
"schema": {
|
|
@@ -18280,35 +19007,133 @@ export const API_OPERATIONS = [
|
|
|
18280
19007
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
18281
19008
|
"type": "object",
|
|
18282
19009
|
"properties": {
|
|
18283
|
-
"singleton": {
|
|
18284
|
-
"type": "string"
|
|
18285
|
-
},
|
|
18286
|
-
"path": {
|
|
18287
|
-
"type": "string"
|
|
18288
|
-
},
|
|
18289
19010
|
"revision": {
|
|
18290
|
-
"
|
|
18291
|
-
|
|
18292
|
-
|
|
18293
|
-
|
|
18294
|
-
|
|
18295
|
-
|
|
18296
|
-
|
|
19011
|
+
"anyOf": [
|
|
19012
|
+
{
|
|
19013
|
+
"type": "string",
|
|
19014
|
+
"minLength": 40,
|
|
19015
|
+
"maxLength": 40,
|
|
19016
|
+
"description": "A Git commit id (40 hex characters) of the site's repository."
|
|
19017
|
+
},
|
|
19018
|
+
{
|
|
19019
|
+
"type": "null"
|
|
19020
|
+
}
|
|
19021
|
+
]
|
|
18297
19022
|
},
|
|
18298
|
-
"
|
|
18299
|
-
"type": "
|
|
18300
|
-
"
|
|
18301
|
-
"type": "
|
|
19023
|
+
"sections": {
|
|
19024
|
+
"type": "array",
|
|
19025
|
+
"items": {
|
|
19026
|
+
"type": "object",
|
|
19027
|
+
"properties": {
|
|
19028
|
+
"id": {
|
|
19029
|
+
"type": "string"
|
|
19030
|
+
},
|
|
19031
|
+
"label": {
|
|
19032
|
+
"type": "string"
|
|
19033
|
+
},
|
|
19034
|
+
"description": {
|
|
19035
|
+
"type": [
|
|
19036
|
+
"string",
|
|
19037
|
+
"null"
|
|
19038
|
+
]
|
|
19039
|
+
},
|
|
19040
|
+
"icon": {
|
|
19041
|
+
"type": [
|
|
19042
|
+
"string",
|
|
19043
|
+
"null"
|
|
19044
|
+
]
|
|
19045
|
+
},
|
|
19046
|
+
"fields": {
|
|
19047
|
+
"type": "array",
|
|
19048
|
+
"items": {
|
|
19049
|
+
"type": "object",
|
|
19050
|
+
"properties": {
|
|
19051
|
+
"field": {
|
|
19052
|
+
"type": "string",
|
|
19053
|
+
"description": "The address, <singleton>:<JSON pointer>, as on the page: theme:/colors/primary."
|
|
19054
|
+
},
|
|
19055
|
+
"label": {
|
|
19056
|
+
"type": "string"
|
|
19057
|
+
},
|
|
19058
|
+
"description": {
|
|
19059
|
+
"type": [
|
|
19060
|
+
"string",
|
|
19061
|
+
"null"
|
|
19062
|
+
]
|
|
19063
|
+
},
|
|
19064
|
+
"widget": {
|
|
19065
|
+
"type": "string",
|
|
19066
|
+
"enum": [
|
|
19067
|
+
"text",
|
|
19068
|
+
"longtext",
|
|
19069
|
+
"color",
|
|
19070
|
+
"font",
|
|
19071
|
+
"image",
|
|
19072
|
+
"url",
|
|
19073
|
+
"email",
|
|
19074
|
+
"number",
|
|
19075
|
+
"toggle",
|
|
19076
|
+
"select",
|
|
19077
|
+
"date",
|
|
19078
|
+
"list",
|
|
19079
|
+
"group"
|
|
19080
|
+
],
|
|
19081
|
+
"description": "How the editor shows it: a colour picker for color, the font catalogue for font, the media library for image, a list for select."
|
|
19082
|
+
},
|
|
19083
|
+
"options": {
|
|
19084
|
+
"anyOf": [
|
|
19085
|
+
{
|
|
19086
|
+
"type": "array",
|
|
19087
|
+
"items": {
|
|
19088
|
+
"type": "string"
|
|
19089
|
+
}
|
|
19090
|
+
},
|
|
19091
|
+
{
|
|
19092
|
+
"type": "null"
|
|
19093
|
+
}
|
|
19094
|
+
],
|
|
19095
|
+
"description": "The choices of a select."
|
|
19096
|
+
},
|
|
19097
|
+
"required": {
|
|
19098
|
+
"type": "boolean"
|
|
19099
|
+
},
|
|
19100
|
+
"value": {
|
|
19101
|
+
"description": "The current value; null when the singleton does not have it yet."
|
|
19102
|
+
},
|
|
19103
|
+
"hash": {
|
|
19104
|
+
"type": "string",
|
|
19105
|
+
"description": "The singleton file's hash: send it back in expected_hashes to refuse a change made meanwhile."
|
|
19106
|
+
}
|
|
19107
|
+
},
|
|
19108
|
+
"required": [
|
|
19109
|
+
"field",
|
|
19110
|
+
"label",
|
|
19111
|
+
"description",
|
|
19112
|
+
"widget",
|
|
19113
|
+
"options",
|
|
19114
|
+
"required",
|
|
19115
|
+
"value",
|
|
19116
|
+
"hash"
|
|
19117
|
+
],
|
|
19118
|
+
"additionalProperties": false
|
|
19119
|
+
}
|
|
19120
|
+
}
|
|
19121
|
+
},
|
|
19122
|
+
"required": [
|
|
19123
|
+
"id",
|
|
19124
|
+
"label",
|
|
19125
|
+
"description",
|
|
19126
|
+
"icon",
|
|
19127
|
+
"fields"
|
|
19128
|
+
],
|
|
19129
|
+
"additionalProperties": false
|
|
18302
19130
|
},
|
|
18303
|
-
"
|
|
19131
|
+
"description": "In the order the site declares them. Empty when the site exposes no settings: they are declared in site.config.json (the settings manual)."
|
|
18304
19132
|
}
|
|
18305
19133
|
},
|
|
18306
19134
|
"required": [
|
|
18307
|
-
"singleton",
|
|
18308
|
-
"path",
|
|
18309
19135
|
"revision",
|
|
18310
|
-
"
|
|
18311
|
-
"data"
|
|
19136
|
+
"sections"
|
|
18312
19137
|
],
|
|
18313
19138
|
"additionalProperties": false
|
|
18314
19139
|
},
|
|
@@ -18363,16 +19188,16 @@ export const API_OPERATIONS = [
|
|
|
18363
19188
|
}
|
|
18364
19189
|
},
|
|
18365
19190
|
{
|
|
18366
|
-
"operation_id": "
|
|
18367
|
-
"method": "
|
|
18368
|
-
"path": "/v1/sites/{site_id}/
|
|
18369
|
-
"summary": "
|
|
18370
|
-
"description": "
|
|
19191
|
+
"operation_id": "updateSiteSettings",
|
|
19192
|
+
"method": "PATCH",
|
|
19193
|
+
"path": "/v1/sites/{site_id}/settings",
|
|
19194
|
+
"summary": "Change several settings at once",
|
|
19195
|
+
"description": "Sets settings getSiteSettings listed, in ONE history entry, each singleton validated after the change, and starts the build. Only declared settings: another field is changed with setContentField. Costs no credits; changes the draft only.",
|
|
18371
19196
|
"authentication_required": true,
|
|
18372
19197
|
"scope": "sites:write",
|
|
18373
19198
|
"surfaces": {
|
|
18374
|
-
"cli": "atelier201
|
|
18375
|
-
"mcp": "
|
|
19199
|
+
"cli": "atelier201 settings set",
|
|
19200
|
+
"mcp": "update_site_settings"
|
|
18376
19201
|
},
|
|
18377
19202
|
"parameters": [
|
|
18378
19203
|
{
|
|
@@ -18383,14 +19208,6 @@ export const API_OPERATIONS = [
|
|
|
18383
19208
|
"type": "string"
|
|
18384
19209
|
},
|
|
18385
19210
|
"description": "The site's id, or its slug (the address before .atelier201.page)."
|
|
18386
|
-
},
|
|
18387
|
-
{
|
|
18388
|
-
"name": "name",
|
|
18389
|
-
"in": "path",
|
|
18390
|
-
"required": true,
|
|
18391
|
-
"schema": {
|
|
18392
|
-
"type": "string"
|
|
18393
|
-
}
|
|
18394
19211
|
}
|
|
18395
19212
|
],
|
|
18396
19213
|
"request_body": {
|
|
@@ -18401,22 +19218,42 @@ export const API_OPERATIONS = [
|
|
|
18401
19218
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
18402
19219
|
"type": "object",
|
|
18403
19220
|
"properties": {
|
|
18404
|
-
"
|
|
19221
|
+
"values": {
|
|
19222
|
+
"minItems": 1,
|
|
19223
|
+
"maxItems": 100,
|
|
19224
|
+
"type": "array",
|
|
19225
|
+
"items": {
|
|
19226
|
+
"type": "object",
|
|
19227
|
+
"properties": {
|
|
19228
|
+
"field": {
|
|
19229
|
+
"type": "string",
|
|
19230
|
+
"minLength": 3,
|
|
19231
|
+
"maxLength": 200,
|
|
19232
|
+
"description": "A setting's address, as get_site_settings lists it."
|
|
19233
|
+
},
|
|
19234
|
+
"value": {}
|
|
19235
|
+
},
|
|
19236
|
+
"required": [
|
|
19237
|
+
"field",
|
|
19238
|
+
"value"
|
|
19239
|
+
],
|
|
19240
|
+
"additionalProperties": false
|
|
19241
|
+
},
|
|
19242
|
+
"description": "The settings to change, with their new values. Only listed settings; another field of a singleton is changed with set_field."
|
|
19243
|
+
},
|
|
19244
|
+
"expected_hashes": {
|
|
19245
|
+
"description": "By singleton, the hash get_site_settings returned: the change is refused if that file changed meanwhile.",
|
|
18405
19246
|
"type": "object",
|
|
18406
19247
|
"propertyNames": {
|
|
18407
19248
|
"type": "string"
|
|
18408
19249
|
},
|
|
18409
|
-
"additionalProperties": {
|
|
18410
|
-
|
|
18411
|
-
|
|
18412
|
-
"type": [
|
|
18413
|
-
"string",
|
|
18414
|
-
"null"
|
|
18415
|
-
]
|
|
19250
|
+
"additionalProperties": {
|
|
19251
|
+
"type": "string"
|
|
19252
|
+
}
|
|
18416
19253
|
}
|
|
18417
19254
|
},
|
|
18418
19255
|
"required": [
|
|
18419
|
-
"
|
|
19256
|
+
"values"
|
|
18420
19257
|
],
|
|
18421
19258
|
"additionalProperties": false
|
|
18422
19259
|
}
|
|
@@ -18425,7 +19262,7 @@ export const API_OPERATIONS = [
|
|
|
18425
19262
|
},
|
|
18426
19263
|
"responses": {
|
|
18427
19264
|
"200": {
|
|
18428
|
-
"description": "
|
|
19265
|
+
"description": "Change several settings at once",
|
|
18429
19266
|
"content": {
|
|
18430
19267
|
"application/json": {
|
|
18431
19268
|
"schema": {
|
|
@@ -18435,8 +19272,12 @@ export const API_OPERATIONS = [
|
|
|
18435
19272
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
18436
19273
|
"type": "object",
|
|
18437
19274
|
"properties": {
|
|
18438
|
-
"
|
|
18439
|
-
"type": "
|
|
19275
|
+
"updated": {
|
|
19276
|
+
"type": "array",
|
|
19277
|
+
"items": {
|
|
19278
|
+
"type": "string"
|
|
19279
|
+
},
|
|
19280
|
+
"description": "The addresses whose value changed."
|
|
18440
19281
|
},
|
|
18441
19282
|
"revision": {
|
|
18442
19283
|
"type": "string",
|
|
@@ -18446,10 +19287,166 @@ export const API_OPERATIONS = [
|
|
|
18446
19287
|
},
|
|
18447
19288
|
"changed": {
|
|
18448
19289
|
"type": "boolean"
|
|
19290
|
+
},
|
|
19291
|
+
"build": {
|
|
19292
|
+
"anyOf": [
|
|
19293
|
+
{
|
|
19294
|
+
"type": "object",
|
|
19295
|
+
"properties": {
|
|
19296
|
+
"id": {
|
|
19297
|
+
"type": "string"
|
|
19298
|
+
},
|
|
19299
|
+
"site_id": {
|
|
19300
|
+
"type": "string"
|
|
19301
|
+
},
|
|
19302
|
+
"revision": {
|
|
19303
|
+
"type": "string",
|
|
19304
|
+
"minLength": 40,
|
|
19305
|
+
"maxLength": 40,
|
|
19306
|
+
"description": "A Git commit id (40 hex characters) of the site's repository."
|
|
19307
|
+
},
|
|
19308
|
+
"state": {
|
|
19309
|
+
"type": "string",
|
|
19310
|
+
"enum": [
|
|
19311
|
+
"queued",
|
|
19312
|
+
"building",
|
|
19313
|
+
"collecting",
|
|
19314
|
+
"ready",
|
|
19315
|
+
"failed",
|
|
19316
|
+
"cancelled"
|
|
19317
|
+
]
|
|
19318
|
+
},
|
|
19319
|
+
"target_origin": {
|
|
19320
|
+
"type": "string"
|
|
19321
|
+
},
|
|
19322
|
+
"profile": {
|
|
19323
|
+
"type": "string",
|
|
19324
|
+
"enum": [
|
|
19325
|
+
"standard",
|
|
19326
|
+
"guest-demo"
|
|
19327
|
+
]
|
|
19328
|
+
},
|
|
19329
|
+
"file_count": {
|
|
19330
|
+
"anyOf": [
|
|
19331
|
+
{
|
|
19332
|
+
"type": "integer",
|
|
19333
|
+
"minimum": -9007199254740991,
|
|
19334
|
+
"maximum": 9007199254740991
|
|
19335
|
+
},
|
|
19336
|
+
{
|
|
19337
|
+
"type": "null"
|
|
19338
|
+
}
|
|
19339
|
+
]
|
|
19340
|
+
},
|
|
19341
|
+
"total_bytes": {
|
|
19342
|
+
"anyOf": [
|
|
19343
|
+
{
|
|
19344
|
+
"type": "integer",
|
|
19345
|
+
"minimum": -9007199254740991,
|
|
19346
|
+
"maximum": 9007199254740991
|
|
19347
|
+
},
|
|
19348
|
+
{
|
|
19349
|
+
"type": "null"
|
|
19350
|
+
}
|
|
19351
|
+
]
|
|
19352
|
+
},
|
|
19353
|
+
"duration_ms": {
|
|
19354
|
+
"anyOf": [
|
|
19355
|
+
{
|
|
19356
|
+
"type": "integer",
|
|
19357
|
+
"minimum": -9007199254740991,
|
|
19358
|
+
"maximum": 9007199254740991
|
|
19359
|
+
},
|
|
19360
|
+
{
|
|
19361
|
+
"type": "null"
|
|
19362
|
+
}
|
|
19363
|
+
]
|
|
19364
|
+
},
|
|
19365
|
+
"error": {
|
|
19366
|
+
"anyOf": [
|
|
19367
|
+
{
|
|
19368
|
+
"type": "object",
|
|
19369
|
+
"properties": {
|
|
19370
|
+
"code": {
|
|
19371
|
+
"type": "string"
|
|
19372
|
+
},
|
|
19373
|
+
"message": {
|
|
19374
|
+
"type": [
|
|
19375
|
+
"string",
|
|
19376
|
+
"null"
|
|
19377
|
+
]
|
|
19378
|
+
}
|
|
19379
|
+
},
|
|
19380
|
+
"required": [
|
|
19381
|
+
"code",
|
|
19382
|
+
"message"
|
|
19383
|
+
],
|
|
19384
|
+
"additionalProperties": false
|
|
19385
|
+
},
|
|
19386
|
+
{
|
|
19387
|
+
"type": "null"
|
|
19388
|
+
}
|
|
19389
|
+
]
|
|
19390
|
+
},
|
|
19391
|
+
"warnings": {
|
|
19392
|
+
"type": "array",
|
|
19393
|
+
"items": {
|
|
19394
|
+
"type": "string"
|
|
19395
|
+
}
|
|
19396
|
+
},
|
|
19397
|
+
"created_at": {
|
|
19398
|
+
"type": "string",
|
|
19399
|
+
"description": "ISO 8601, UTC."
|
|
19400
|
+
},
|
|
19401
|
+
"started_at": {
|
|
19402
|
+
"anyOf": [
|
|
19403
|
+
{
|
|
19404
|
+
"type": "string",
|
|
19405
|
+
"description": "ISO 8601, UTC."
|
|
19406
|
+
},
|
|
19407
|
+
{
|
|
19408
|
+
"type": "null"
|
|
19409
|
+
}
|
|
19410
|
+
]
|
|
19411
|
+
},
|
|
19412
|
+
"finished_at": {
|
|
19413
|
+
"anyOf": [
|
|
19414
|
+
{
|
|
19415
|
+
"type": "string",
|
|
19416
|
+
"description": "ISO 8601, UTC."
|
|
19417
|
+
},
|
|
19418
|
+
{
|
|
19419
|
+
"type": "null"
|
|
19420
|
+
}
|
|
19421
|
+
]
|
|
19422
|
+
}
|
|
19423
|
+
},
|
|
19424
|
+
"required": [
|
|
19425
|
+
"id",
|
|
19426
|
+
"site_id",
|
|
19427
|
+
"revision",
|
|
19428
|
+
"state",
|
|
19429
|
+
"target_origin",
|
|
19430
|
+
"profile",
|
|
19431
|
+
"file_count",
|
|
19432
|
+
"total_bytes",
|
|
19433
|
+
"duration_ms",
|
|
19434
|
+
"error",
|
|
19435
|
+
"warnings",
|
|
19436
|
+
"created_at",
|
|
19437
|
+
"started_at",
|
|
19438
|
+
"finished_at"
|
|
19439
|
+
],
|
|
19440
|
+
"additionalProperties": false
|
|
19441
|
+
},
|
|
19442
|
+
{
|
|
19443
|
+
"type": "null"
|
|
19444
|
+
}
|
|
19445
|
+
]
|
|
18449
19446
|
}
|
|
18450
19447
|
},
|
|
18451
19448
|
"required": [
|
|
18452
|
-
"
|
|
19449
|
+
"updated",
|
|
18453
19450
|
"revision",
|
|
18454
19451
|
"changed"
|
|
18455
19452
|
],
|
|
@@ -18750,7 +19747,7 @@ export const API_OPERATIONS = [
|
|
|
18750
19747
|
"method": "POST",
|
|
18751
19748
|
"path": "/v1/sites/{site_id}/fields",
|
|
18752
19749
|
"summary": "Change one field",
|
|
18753
|
-
"description": "Sets one existing field of a singleton, addressed as on the page (`business:/hours/2/close`). Validated, one history entry.",
|
|
19750
|
+
"description": "Sets one existing field of a singleton, addressed as on the page (`business:/hours/2/close`), or of an entry (`menu/sourdough:/price`): the rest stays as it is. Validated, one history entry.",
|
|
18754
19751
|
"authentication_required": true,
|
|
18755
19752
|
"scope": "sites:write",
|
|
18756
19753
|
"surfaces": {
|
|
@@ -18780,7 +19777,7 @@ export const API_OPERATIONS = [
|
|
|
18780
19777
|
"type": "string",
|
|
18781
19778
|
"minLength": 3,
|
|
18782
19779
|
"maxLength": 200,
|
|
18783
|
-
"description": "<singleton>:<JSON pointer>, as the page's data-atelier201-field attribute says, e.g. business:/hours/2/close."
|
|
19780
|
+
"description": "<singleton>:<JSON pointer>, as the page's data-atelier201-field attribute says, e.g. business:/hours/2/close; or <list>/<slug>:<JSON pointer> for one field of an entry, e.g. menu/sourdough:/price."
|
|
18784
19781
|
},
|
|
18785
19782
|
"value": {
|
|
18786
19783
|
"anyOf": [
|
|
@@ -18825,6 +19822,15 @@ export const API_OPERATIONS = [
|
|
|
18825
19822
|
"type": "object",
|
|
18826
19823
|
"properties": {
|
|
18827
19824
|
"singleton": {
|
|
19825
|
+
"description": "The singleton changed, for a singleton's field.",
|
|
19826
|
+
"type": "string"
|
|
19827
|
+
},
|
|
19828
|
+
"collection": {
|
|
19829
|
+
"description": "The list, for an entry's field.",
|
|
19830
|
+
"type": "string"
|
|
19831
|
+
},
|
|
19832
|
+
"slug": {
|
|
19833
|
+
"description": "The entry, for an entry's field.",
|
|
18828
19834
|
"type": "string"
|
|
18829
19835
|
},
|
|
18830
19836
|
"revision": {
|
|
@@ -18838,7 +19844,6 @@ export const API_OPERATIONS = [
|
|
|
18838
19844
|
}
|
|
18839
19845
|
},
|
|
18840
19846
|
"required": [
|
|
18841
|
-
"singleton",
|
|
18842
19847
|
"revision",
|
|
18843
19848
|
"changed"
|
|
18844
19849
|
],
|