@atelier201/cli 0.6.0 → 0.8.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 +17 -6
- package/dist/api-types.generated.js.map +1 -1
- package/dist/commands/analytics.js +36 -0
- package/dist/commands/analytics.js.map +1 -0
- package/dist/commands/builds.js +47 -30
- package/dist/commands/builds.js.map +1 -1
- package/dist/commands/consent.js +85 -0
- package/dist/commands/consent.js.map +1 -0
- package/dist/commands/domains.js +17 -0
- package/dist/commands/domains.js.map +1 -1
- package/dist/commands/history.js +52 -8
- package/dist/commands/history.js.map +1 -1
- package/dist/commands/previews.js +41 -3
- package/dist/commands/previews.js.map +1 -1
- package/dist/commands/publish.js +5 -1
- package/dist/commands/publish.js.map +1 -1
- package/dist/commands/site-guest.js +28 -9
- package/dist/commands/site-guest.js.map +1 -1
- package/dist/commands/site.js +9 -4
- package/dist/commands/site.js.map +1 -1
- package/dist/index.js +4 -0
- package/dist/index.js.map +1 -1
- package/dist/operations.generated.js +2591 -126
- package/dist/operations.generated.js.map +1 -1
- package/dist/output.js +2 -0
- package/dist/output.js.map +1 -1
- package/package.json +1 -1
|
@@ -1370,7 +1370,7 @@ export const API_OPERATIONS = [
|
|
|
1370
1370
|
"method": "PATCH",
|
|
1371
1371
|
"path": "/v1/sites/{site_id}",
|
|
1372
1372
|
"summary": "Rename a site",
|
|
1373
|
-
"description": "Changes the name shown in Atelier201.
|
|
1373
|
+
"description": "Changes the name shown in Atelier201. A random first address, never published, follows the name; any other address does not change (see setSiteAddress).",
|
|
1374
1374
|
"authentication_required": true,
|
|
1375
1375
|
"scope": "sites:write",
|
|
1376
1376
|
"surfaces": {
|
|
@@ -3866,6 +3866,26 @@ export const API_OPERATIONS = [
|
|
|
3866
3866
|
}
|
|
3867
3867
|
]
|
|
3868
3868
|
},
|
|
3869
|
+
"number": {
|
|
3870
|
+
"anyOf": [
|
|
3871
|
+
{
|
|
3872
|
+
"type": "integer",
|
|
3873
|
+
"minimum": -9007199254740991,
|
|
3874
|
+
"maximum": 9007199254740991
|
|
3875
|
+
},
|
|
3876
|
+
{
|
|
3877
|
+
"type": "null"
|
|
3878
|
+
}
|
|
3879
|
+
],
|
|
3880
|
+
"description": "The version's number on its site, 1 for the first save: what people call it (version 12). Null only for a version saved before numbering, never in practice."
|
|
3881
|
+
},
|
|
3882
|
+
"name": {
|
|
3883
|
+
"description": "The name the owner gave this version, or null.",
|
|
3884
|
+
"type": [
|
|
3885
|
+
"string",
|
|
3886
|
+
"null"
|
|
3887
|
+
]
|
|
3888
|
+
},
|
|
3869
3889
|
"summary": {
|
|
3870
3890
|
"type": "string"
|
|
3871
3891
|
},
|
|
@@ -3907,6 +3927,8 @@ export const API_OPERATIONS = [
|
|
|
3907
3927
|
"required": [
|
|
3908
3928
|
"revision",
|
|
3909
3929
|
"parent",
|
|
3930
|
+
"number",
|
|
3931
|
+
"name",
|
|
3910
3932
|
"summary",
|
|
3911
3933
|
"origin",
|
|
3912
3934
|
"author",
|
|
@@ -3930,6 +3952,20 @@ export const API_OPERATIONS = [
|
|
|
3930
3952
|
}
|
|
3931
3953
|
]
|
|
3932
3954
|
},
|
|
3955
|
+
"live_revision": {
|
|
3956
|
+
"anyOf": [
|
|
3957
|
+
{
|
|
3958
|
+
"type": "string",
|
|
3959
|
+
"minLength": 40,
|
|
3960
|
+
"maxLength": 40,
|
|
3961
|
+
"description": "A Git commit id (40 hex characters) of the site's repository."
|
|
3962
|
+
},
|
|
3963
|
+
{
|
|
3964
|
+
"type": "null"
|
|
3965
|
+
}
|
|
3966
|
+
],
|
|
3967
|
+
"description": "The version visitors see, or null when the site is not published."
|
|
3968
|
+
},
|
|
3933
3969
|
"next_before": {
|
|
3934
3970
|
"anyOf": [
|
|
3935
3971
|
{
|
|
@@ -3945,6 +3981,7 @@ export const API_OPERATIONS = [
|
|
|
3945
3981
|
"required": [
|
|
3946
3982
|
"revisions",
|
|
3947
3983
|
"draft_revision",
|
|
3984
|
+
"live_revision",
|
|
3948
3985
|
"next_before"
|
|
3949
3986
|
],
|
|
3950
3987
|
"additionalProperties": false
|
|
@@ -4003,8 +4040,8 @@ export const API_OPERATIONS = [
|
|
|
4003
4040
|
"operation_id": "compareSiteRevisions",
|
|
4004
4041
|
"method": "GET",
|
|
4005
4042
|
"path": "/v1/sites/{site_id}/compare",
|
|
4006
|
-
"summary": "Compare two
|
|
4007
|
-
"description": "
|
|
4043
|
+
"summary": "Compare two versions",
|
|
4044
|
+
"description": "What changed between two versions (numbers or revisions): the files added, modified and deleted, the versions saved in between with their summaries, and with patch=true the changed lines of each text file.",
|
|
4008
4045
|
"authentication_required": true,
|
|
4009
4046
|
"scope": "sites:read",
|
|
4010
4047
|
"surfaces": {
|
|
@@ -4026,10 +4063,9 @@ export const API_OPERATIONS = [
|
|
|
4026
4063
|
"in": "query",
|
|
4027
4064
|
"required": false,
|
|
4028
4065
|
"schema": {
|
|
4066
|
+
"description": "The earlier version. Leave it out to compare `to` with the version before it: what `to` changed.",
|
|
4029
4067
|
"type": "string",
|
|
4030
|
-
"
|
|
4031
|
-
"maxLength": 40,
|
|
4032
|
-
"description": "A Git commit id (40 hex characters) of the site's repository."
|
|
4068
|
+
"pattern": "^(v?\\d{1,7}|[0-9a-f]{40})$"
|
|
4033
4069
|
}
|
|
4034
4070
|
},
|
|
4035
4071
|
{
|
|
@@ -4038,16 +4074,46 @@ export const API_OPERATIONS = [
|
|
|
4038
4074
|
"required": true,
|
|
4039
4075
|
"schema": {
|
|
4040
4076
|
"type": "string",
|
|
4041
|
-
"
|
|
4042
|
-
"
|
|
4043
|
-
|
|
4077
|
+
"pattern": "^(v?\\d{1,7}|[0-9a-f]{40})$",
|
|
4078
|
+
"description": "The later version: its number (12) or its revision."
|
|
4079
|
+
}
|
|
4080
|
+
},
|
|
4081
|
+
{
|
|
4082
|
+
"name": "patch",
|
|
4083
|
+
"in": "query",
|
|
4084
|
+
"required": false,
|
|
4085
|
+
"schema": {
|
|
4086
|
+
"description": "Also return, for each text file, the changed lines and a few around them (a unified diff without its header). Git takes it from the two versions directly: the versions in between are summed up in `between`, not walked.",
|
|
4087
|
+
"type": "boolean"
|
|
4088
|
+
}
|
|
4089
|
+
},
|
|
4090
|
+
{
|
|
4091
|
+
"name": "max_chars",
|
|
4092
|
+
"in": "query",
|
|
4093
|
+
"required": false,
|
|
4094
|
+
"schema": {
|
|
4095
|
+
"description": "With patch: the most characters of patches returned, 60,000 by default. Files past it say patch_skipped \"budget\".",
|
|
4096
|
+
"type": "integer",
|
|
4097
|
+
"minimum": 1000,
|
|
4098
|
+
"maximum": 200000
|
|
4099
|
+
}
|
|
4100
|
+
},
|
|
4101
|
+
{
|
|
4102
|
+
"name": "context",
|
|
4103
|
+
"in": "query",
|
|
4104
|
+
"required": false,
|
|
4105
|
+
"schema": {
|
|
4106
|
+
"description": "With patch: unchanged lines around each change, 3 by default.",
|
|
4107
|
+
"type": "integer",
|
|
4108
|
+
"minimum": 0,
|
|
4109
|
+
"maximum": 10
|
|
4044
4110
|
}
|
|
4045
4111
|
}
|
|
4046
4112
|
],
|
|
4047
4113
|
"request_body": null,
|
|
4048
4114
|
"responses": {
|
|
4049
4115
|
"200": {
|
|
4050
|
-
"description": "Compare two
|
|
4116
|
+
"description": "Compare two versions",
|
|
4051
4117
|
"content": {
|
|
4052
4118
|
"application/json": {
|
|
4053
4119
|
"schema": {
|
|
@@ -4076,6 +4142,87 @@ export const API_OPERATIONS = [
|
|
|
4076
4142
|
"maxLength": 40,
|
|
4077
4143
|
"description": "A Git commit id (40 hex characters) of the site's repository."
|
|
4078
4144
|
},
|
|
4145
|
+
"from_version": {
|
|
4146
|
+
"anyOf": [
|
|
4147
|
+
{
|
|
4148
|
+
"type": "integer",
|
|
4149
|
+
"minimum": -9007199254740991,
|
|
4150
|
+
"maximum": 9007199254740991
|
|
4151
|
+
},
|
|
4152
|
+
{
|
|
4153
|
+
"type": "null"
|
|
4154
|
+
}
|
|
4155
|
+
],
|
|
4156
|
+
"description": "The number of `from`, or null."
|
|
4157
|
+
},
|
|
4158
|
+
"to_version": {
|
|
4159
|
+
"anyOf": [
|
|
4160
|
+
{
|
|
4161
|
+
"type": "integer",
|
|
4162
|
+
"minimum": -9007199254740991,
|
|
4163
|
+
"maximum": 9007199254740991
|
|
4164
|
+
},
|
|
4165
|
+
{
|
|
4166
|
+
"type": "null"
|
|
4167
|
+
}
|
|
4168
|
+
],
|
|
4169
|
+
"description": "The number of `to`."
|
|
4170
|
+
},
|
|
4171
|
+
"between": {
|
|
4172
|
+
"type": "array",
|
|
4173
|
+
"items": {
|
|
4174
|
+
"type": "object",
|
|
4175
|
+
"properties": {
|
|
4176
|
+
"number": {
|
|
4177
|
+
"anyOf": [
|
|
4178
|
+
{
|
|
4179
|
+
"type": "integer",
|
|
4180
|
+
"minimum": -9007199254740991,
|
|
4181
|
+
"maximum": 9007199254740991
|
|
4182
|
+
},
|
|
4183
|
+
{
|
|
4184
|
+
"type": "null"
|
|
4185
|
+
}
|
|
4186
|
+
]
|
|
4187
|
+
},
|
|
4188
|
+
"name": {
|
|
4189
|
+
"type": [
|
|
4190
|
+
"string",
|
|
4191
|
+
"null"
|
|
4192
|
+
]
|
|
4193
|
+
},
|
|
4194
|
+
"summary": {
|
|
4195
|
+
"type": "string"
|
|
4196
|
+
},
|
|
4197
|
+
"author": {
|
|
4198
|
+
"type": "string"
|
|
4199
|
+
},
|
|
4200
|
+
"origin": {
|
|
4201
|
+
"type": "string"
|
|
4202
|
+
},
|
|
4203
|
+
"files_changed": {
|
|
4204
|
+
"type": "integer",
|
|
4205
|
+
"minimum": -9007199254740991,
|
|
4206
|
+
"maximum": 9007199254740991
|
|
4207
|
+
},
|
|
4208
|
+
"created_at": {
|
|
4209
|
+
"type": "string",
|
|
4210
|
+
"description": "ISO 8601, UTC."
|
|
4211
|
+
}
|
|
4212
|
+
},
|
|
4213
|
+
"required": [
|
|
4214
|
+
"number",
|
|
4215
|
+
"name",
|
|
4216
|
+
"summary",
|
|
4217
|
+
"author",
|
|
4218
|
+
"origin",
|
|
4219
|
+
"files_changed",
|
|
4220
|
+
"created_at"
|
|
4221
|
+
],
|
|
4222
|
+
"additionalProperties": false
|
|
4223
|
+
},
|
|
4224
|
+
"description": "Every version saved after `from` up to and including `to`, oldest first (100 at most): the story of the change."
|
|
4225
|
+
},
|
|
4079
4226
|
"changes": {
|
|
4080
4227
|
"type": "array",
|
|
4081
4228
|
"items": {
|
|
@@ -4098,6 +4245,40 @@ export const API_OPERATIONS = [
|
|
|
4098
4245
|
"string",
|
|
4099
4246
|
"null"
|
|
4100
4247
|
]
|
|
4248
|
+
},
|
|
4249
|
+
"patch": {
|
|
4250
|
+
"description": "With patch: the changed lines, or null when patch_skipped says why.",
|
|
4251
|
+
"type": [
|
|
4252
|
+
"string",
|
|
4253
|
+
"null"
|
|
4254
|
+
]
|
|
4255
|
+
},
|
|
4256
|
+
"patch_skipped": {
|
|
4257
|
+
"description": "binary (an image, a font), too_large (over 512 KB), generated (a lockfile) or budget (max_chars spent; the budget goes to content, then pages, then components and styles, then the rest).",
|
|
4258
|
+
"anyOf": [
|
|
4259
|
+
{
|
|
4260
|
+
"type": "string",
|
|
4261
|
+
"enum": [
|
|
4262
|
+
"binary",
|
|
4263
|
+
"too_large",
|
|
4264
|
+
"generated",
|
|
4265
|
+
"budget"
|
|
4266
|
+
]
|
|
4267
|
+
},
|
|
4268
|
+
{
|
|
4269
|
+
"type": "null"
|
|
4270
|
+
}
|
|
4271
|
+
]
|
|
4272
|
+
},
|
|
4273
|
+
"lines_added": {
|
|
4274
|
+
"type": "integer",
|
|
4275
|
+
"minimum": -9007199254740991,
|
|
4276
|
+
"maximum": 9007199254740991
|
|
4277
|
+
},
|
|
4278
|
+
"lines_removed": {
|
|
4279
|
+
"type": "integer",
|
|
4280
|
+
"minimum": -9007199254740991,
|
|
4281
|
+
"maximum": 9007199254740991
|
|
4101
4282
|
}
|
|
4102
4283
|
},
|
|
4103
4284
|
"required": [
|
|
@@ -4108,11 +4289,18 @@ export const API_OPERATIONS = [
|
|
|
4108
4289
|
],
|
|
4109
4290
|
"additionalProperties": false
|
|
4110
4291
|
}
|
|
4292
|
+
},
|
|
4293
|
+
"truncated": {
|
|
4294
|
+
"description": "With patch: true when some files were left out for max_chars.",
|
|
4295
|
+
"type": "boolean"
|
|
4111
4296
|
}
|
|
4112
4297
|
},
|
|
4113
4298
|
"required": [
|
|
4114
4299
|
"from",
|
|
4115
4300
|
"to",
|
|
4301
|
+
"from_version",
|
|
4302
|
+
"to_version",
|
|
4303
|
+
"between",
|
|
4116
4304
|
"changes"
|
|
4117
4305
|
],
|
|
4118
4306
|
"additionalProperties": false
|
|
@@ -4168,16 +4356,16 @@ export const API_OPERATIONS = [
|
|
|
4168
4356
|
}
|
|
4169
4357
|
},
|
|
4170
4358
|
{
|
|
4171
|
-
"operation_id": "
|
|
4172
|
-
"method": "
|
|
4173
|
-
"path": "/v1/sites/{site_id}/revisions/{revision}
|
|
4174
|
-
"summary": "
|
|
4175
|
-
"description": "
|
|
4359
|
+
"operation_id": "updateSiteRevision",
|
|
4360
|
+
"method": "PATCH",
|
|
4361
|
+
"path": "/v1/sites/{site_id}/revisions/{revision}",
|
|
4362
|
+
"summary": "Name a version",
|
|
4363
|
+
"description": "Gives a version a name (\"Before the redesign\") or takes it away with null. Its number and its files never change. No credits, nothing published.",
|
|
4176
4364
|
"authentication_required": true,
|
|
4177
4365
|
"scope": "sites:write",
|
|
4178
4366
|
"surfaces": {
|
|
4179
|
-
"cli": "atelier201 history
|
|
4180
|
-
"mcp": "
|
|
4367
|
+
"cli": "atelier201 history rename",
|
|
4368
|
+
"mcp": "rename_revision"
|
|
4181
4369
|
},
|
|
4182
4370
|
"parameters": [
|
|
4183
4371
|
{
|
|
@@ -4198,10 +4386,39 @@ export const API_OPERATIONS = [
|
|
|
4198
4386
|
}
|
|
4199
4387
|
}
|
|
4200
4388
|
],
|
|
4201
|
-
"request_body":
|
|
4389
|
+
"request_body": {
|
|
4390
|
+
"required": true,
|
|
4391
|
+
"content": {
|
|
4392
|
+
"application/json": {
|
|
4393
|
+
"schema": {
|
|
4394
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
4395
|
+
"type": "object",
|
|
4396
|
+
"properties": {
|
|
4397
|
+
"name": {
|
|
4398
|
+
"anyOf": [
|
|
4399
|
+
{
|
|
4400
|
+
"type": "string",
|
|
4401
|
+
"minLength": 1,
|
|
4402
|
+
"maxLength": 80
|
|
4403
|
+
},
|
|
4404
|
+
{
|
|
4405
|
+
"type": "null"
|
|
4406
|
+
}
|
|
4407
|
+
],
|
|
4408
|
+
"description": "A name for this version (\"Before the redesign\"), up to 80 characters; null takes it away. The number stays."
|
|
4409
|
+
}
|
|
4410
|
+
},
|
|
4411
|
+
"required": [
|
|
4412
|
+
"name"
|
|
4413
|
+
],
|
|
4414
|
+
"additionalProperties": false
|
|
4415
|
+
}
|
|
4416
|
+
}
|
|
4417
|
+
}
|
|
4418
|
+
},
|
|
4202
4419
|
"responses": {
|
|
4203
4420
|
"200": {
|
|
4204
|
-
"description": "
|
|
4421
|
+
"description": "Name a version",
|
|
4205
4422
|
"content": {
|
|
4206
4423
|
"application/json": {
|
|
4207
4424
|
"schema": {
|
|
@@ -4212,58 +4429,243 @@ export const API_OPERATIONS = [
|
|
|
4212
4429
|
"type": "object",
|
|
4213
4430
|
"properties": {
|
|
4214
4431
|
"revision": {
|
|
4215
|
-
"type": "string"
|
|
4432
|
+
"type": "string",
|
|
4433
|
+
"minLength": 40,
|
|
4434
|
+
"maxLength": 40,
|
|
4435
|
+
"description": "A Git commit id (40 hex characters) of the site's repository."
|
|
4216
4436
|
},
|
|
4217
|
-
"
|
|
4218
|
-
"
|
|
4437
|
+
"parent": {
|
|
4438
|
+
"anyOf": [
|
|
4439
|
+
{
|
|
4440
|
+
"type": "string",
|
|
4441
|
+
"minLength": 40,
|
|
4442
|
+
"maxLength": 40,
|
|
4443
|
+
"description": "A Git commit id (40 hex characters) of the site's repository."
|
|
4444
|
+
},
|
|
4445
|
+
{
|
|
4446
|
+
"type": "null"
|
|
4447
|
+
}
|
|
4448
|
+
]
|
|
4219
4449
|
},
|
|
4220
|
-
"
|
|
4450
|
+
"number": {
|
|
4221
4451
|
"anyOf": [
|
|
4222
4452
|
{
|
|
4223
|
-
"type": "
|
|
4224
|
-
"
|
|
4225
|
-
|
|
4226
|
-
"type": "string"
|
|
4227
|
-
},
|
|
4228
|
-
"state": {
|
|
4229
|
-
"type": "string"
|
|
4230
|
-
},
|
|
4231
|
-
"next_action": {
|
|
4232
|
-
"type": "string"
|
|
4233
|
-
}
|
|
4234
|
-
},
|
|
4235
|
-
"required": [
|
|
4236
|
-
"id",
|
|
4237
|
-
"state",
|
|
4238
|
-
"next_action"
|
|
4239
|
-
],
|
|
4240
|
-
"additionalProperties": false
|
|
4453
|
+
"type": "integer",
|
|
4454
|
+
"minimum": -9007199254740991,
|
|
4455
|
+
"maximum": 9007199254740991
|
|
4241
4456
|
},
|
|
4242
4457
|
{
|
|
4243
4458
|
"type": "null"
|
|
4244
4459
|
}
|
|
4245
4460
|
],
|
|
4246
|
-
"description": "The
|
|
4247
|
-
}
|
|
4248
|
-
|
|
4249
|
-
|
|
4250
|
-
|
|
4251
|
-
|
|
4252
|
-
|
|
4253
|
-
|
|
4254
|
-
|
|
4255
|
-
|
|
4256
|
-
|
|
4257
|
-
|
|
4258
|
-
|
|
4259
|
-
|
|
4260
|
-
|
|
4261
|
-
|
|
4262
|
-
|
|
4263
|
-
|
|
4264
|
-
|
|
4265
|
-
|
|
4266
|
-
|
|
4461
|
+
"description": "The version's number on its site, 1 for the first save: what people call it (version 12). Null only for a version saved before numbering, never in practice."
|
|
4462
|
+
},
|
|
4463
|
+
"name": {
|
|
4464
|
+
"description": "The name the owner gave this version, or null.",
|
|
4465
|
+
"type": [
|
|
4466
|
+
"string",
|
|
4467
|
+
"null"
|
|
4468
|
+
]
|
|
4469
|
+
},
|
|
4470
|
+
"summary": {
|
|
4471
|
+
"type": "string"
|
|
4472
|
+
},
|
|
4473
|
+
"origin": {
|
|
4474
|
+
"type": "string"
|
|
4475
|
+
},
|
|
4476
|
+
"author": {
|
|
4477
|
+
"type": "string"
|
|
4478
|
+
},
|
|
4479
|
+
"files_changed": {
|
|
4480
|
+
"type": "integer",
|
|
4481
|
+
"minimum": -9007199254740991,
|
|
4482
|
+
"maximum": 9007199254740991
|
|
4483
|
+
},
|
|
4484
|
+
"changes": {
|
|
4485
|
+
"type": "array",
|
|
4486
|
+
"items": {
|
|
4487
|
+
"type": "object",
|
|
4488
|
+
"properties": {
|
|
4489
|
+
"path": {
|
|
4490
|
+
"type": "string"
|
|
4491
|
+
},
|
|
4492
|
+
"action": {
|
|
4493
|
+
"type": "string"
|
|
4494
|
+
}
|
|
4495
|
+
},
|
|
4496
|
+
"required": [
|
|
4497
|
+
"path",
|
|
4498
|
+
"action"
|
|
4499
|
+
],
|
|
4500
|
+
"additionalProperties": false
|
|
4501
|
+
}
|
|
4502
|
+
},
|
|
4503
|
+
"created_at": {
|
|
4504
|
+
"type": "string",
|
|
4505
|
+
"description": "ISO 8601, UTC."
|
|
4506
|
+
}
|
|
4507
|
+
},
|
|
4508
|
+
"required": [
|
|
4509
|
+
"revision",
|
|
4510
|
+
"parent",
|
|
4511
|
+
"number",
|
|
4512
|
+
"name",
|
|
4513
|
+
"summary",
|
|
4514
|
+
"origin",
|
|
4515
|
+
"author",
|
|
4516
|
+
"files_changed",
|
|
4517
|
+
"changes",
|
|
4518
|
+
"created_at"
|
|
4519
|
+
],
|
|
4520
|
+
"additionalProperties": false
|
|
4521
|
+
},
|
|
4522
|
+
"request_id": {
|
|
4523
|
+
"type": "string"
|
|
4524
|
+
}
|
|
4525
|
+
},
|
|
4526
|
+
"required": [
|
|
4527
|
+
"data",
|
|
4528
|
+
"request_id"
|
|
4529
|
+
]
|
|
4530
|
+
}
|
|
4531
|
+
}
|
|
4532
|
+
}
|
|
4533
|
+
},
|
|
4534
|
+
"400": {
|
|
4535
|
+
"$ref": "#/components/responses/Error400"
|
|
4536
|
+
},
|
|
4537
|
+
"401": {
|
|
4538
|
+
"$ref": "#/components/responses/Error401"
|
|
4539
|
+
},
|
|
4540
|
+
"402": {
|
|
4541
|
+
"$ref": "#/components/responses/Error402"
|
|
4542
|
+
},
|
|
4543
|
+
"403": {
|
|
4544
|
+
"$ref": "#/components/responses/Error403"
|
|
4545
|
+
},
|
|
4546
|
+
"404": {
|
|
4547
|
+
"$ref": "#/components/responses/Error404"
|
|
4548
|
+
},
|
|
4549
|
+
"409": {
|
|
4550
|
+
"$ref": "#/components/responses/Error409"
|
|
4551
|
+
},
|
|
4552
|
+
"410": {
|
|
4553
|
+
"$ref": "#/components/responses/Error410"
|
|
4554
|
+
},
|
|
4555
|
+
"413": {
|
|
4556
|
+
"$ref": "#/components/responses/Error413"
|
|
4557
|
+
},
|
|
4558
|
+
"422": {
|
|
4559
|
+
"$ref": "#/components/responses/Error422"
|
|
4560
|
+
},
|
|
4561
|
+
"429": {
|
|
4562
|
+
"$ref": "#/components/responses/Error429"
|
|
4563
|
+
},
|
|
4564
|
+
"500": {
|
|
4565
|
+
"$ref": "#/components/responses/Error500"
|
|
4566
|
+
},
|
|
4567
|
+
"503": {
|
|
4568
|
+
"$ref": "#/components/responses/Error503"
|
|
4569
|
+
}
|
|
4570
|
+
}
|
|
4571
|
+
},
|
|
4572
|
+
{
|
|
4573
|
+
"operation_id": "restoreSiteRevision",
|
|
4574
|
+
"method": "POST",
|
|
4575
|
+
"path": "/v1/sites/{site_id}/revisions/{revision}/restore",
|
|
4576
|
+
"summary": "Restore a revision",
|
|
4577
|
+
"description": "Makes the draft's files exactly those of an earlier revision, as a NEW history entry (nothing is erased), and starts its build. Does not publish.",
|
|
4578
|
+
"authentication_required": true,
|
|
4579
|
+
"scope": "sites:write",
|
|
4580
|
+
"surfaces": {
|
|
4581
|
+
"cli": "atelier201 history restore",
|
|
4582
|
+
"mcp": "restore_revision"
|
|
4583
|
+
},
|
|
4584
|
+
"parameters": [
|
|
4585
|
+
{
|
|
4586
|
+
"name": "site_id",
|
|
4587
|
+
"in": "path",
|
|
4588
|
+
"required": true,
|
|
4589
|
+
"schema": {
|
|
4590
|
+
"type": "string"
|
|
4591
|
+
},
|
|
4592
|
+
"description": "The site's id, or its slug (the address before .atelier201.page)."
|
|
4593
|
+
},
|
|
4594
|
+
{
|
|
4595
|
+
"name": "revision",
|
|
4596
|
+
"in": "path",
|
|
4597
|
+
"required": true,
|
|
4598
|
+
"schema": {
|
|
4599
|
+
"type": "string"
|
|
4600
|
+
}
|
|
4601
|
+
}
|
|
4602
|
+
],
|
|
4603
|
+
"request_body": null,
|
|
4604
|
+
"responses": {
|
|
4605
|
+
"200": {
|
|
4606
|
+
"description": "Restore a revision",
|
|
4607
|
+
"content": {
|
|
4608
|
+
"application/json": {
|
|
4609
|
+
"schema": {
|
|
4610
|
+
"type": "object",
|
|
4611
|
+
"properties": {
|
|
4612
|
+
"data": {
|
|
4613
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
4614
|
+
"type": "object",
|
|
4615
|
+
"properties": {
|
|
4616
|
+
"revision": {
|
|
4617
|
+
"type": "string"
|
|
4618
|
+
},
|
|
4619
|
+
"changed": {
|
|
4620
|
+
"type": "boolean"
|
|
4621
|
+
},
|
|
4622
|
+
"build": {
|
|
4623
|
+
"anyOf": [
|
|
4624
|
+
{
|
|
4625
|
+
"type": "object",
|
|
4626
|
+
"properties": {
|
|
4627
|
+
"id": {
|
|
4628
|
+
"type": "string"
|
|
4629
|
+
},
|
|
4630
|
+
"state": {
|
|
4631
|
+
"type": "string"
|
|
4632
|
+
},
|
|
4633
|
+
"next_action": {
|
|
4634
|
+
"type": "string"
|
|
4635
|
+
}
|
|
4636
|
+
},
|
|
4637
|
+
"required": [
|
|
4638
|
+
"id",
|
|
4639
|
+
"state",
|
|
4640
|
+
"next_action"
|
|
4641
|
+
],
|
|
4642
|
+
"additionalProperties": false
|
|
4643
|
+
},
|
|
4644
|
+
{
|
|
4645
|
+
"type": "null"
|
|
4646
|
+
}
|
|
4647
|
+
],
|
|
4648
|
+
"description": "The build this change started (or joined): the preview follows it. No build_site call needed."
|
|
4649
|
+
}
|
|
4650
|
+
},
|
|
4651
|
+
"required": [
|
|
4652
|
+
"revision",
|
|
4653
|
+
"changed",
|
|
4654
|
+
"build"
|
|
4655
|
+
],
|
|
4656
|
+
"additionalProperties": false
|
|
4657
|
+
},
|
|
4658
|
+
"request_id": {
|
|
4659
|
+
"type": "string"
|
|
4660
|
+
}
|
|
4661
|
+
},
|
|
4662
|
+
"required": [
|
|
4663
|
+
"data",
|
|
4664
|
+
"request_id"
|
|
4665
|
+
]
|
|
4666
|
+
}
|
|
4667
|
+
}
|
|
4668
|
+
}
|
|
4267
4669
|
},
|
|
4268
4670
|
"400": {
|
|
4269
4671
|
"$ref": "#/components/responses/Error400"
|
|
@@ -5036,7 +5438,7 @@ export const API_OPERATIONS = [
|
|
|
5036
5438
|
"method": "POST",
|
|
5037
5439
|
"path": "/v1/sites/{site_id}/builds",
|
|
5038
5440
|
"summary": "Build a site",
|
|
5039
|
-
"description": "Compiles the draft (or `revision`) into a static site, in an isolated container with no network. Returns at once with `build` (its `id`, state `queued`) and `
|
|
5441
|
+
"description": "Compiles the draft (or `revision`) into a static site, in an isolated container with no network. Returns at once with `build` (its `id`, state `queued`), `reused` and `is_requested_revision`; then getSiteBuild with `wait=50` answers when it is `ready` or `failed` (usually under a minute). A ready build of the same revision is reused instead of building twice. One build runs at a time per site: when an earlier version is running, the answer is that build with `is_requested_revision: false`; wait for it, then call again.",
|
|
5040
5442
|
"authentication_required": true,
|
|
5041
5443
|
"scope": "sites:write",
|
|
5042
5444
|
"surfaces": {
|
|
@@ -5237,11 +5639,20 @@ export const API_OPERATIONS = [
|
|
|
5237
5639
|
},
|
|
5238
5640
|
"reused": {
|
|
5239
5641
|
"type": "boolean"
|
|
5642
|
+
},
|
|
5643
|
+
"is_requested_revision": {
|
|
5644
|
+
"type": "boolean",
|
|
5645
|
+
"description": "False when `build` is an earlier version already running (one build at a time per site): wait for it to finish, whatever its outcome, then start again to get the build of the revision you asked for."
|
|
5646
|
+
},
|
|
5647
|
+
"note": {
|
|
5648
|
+
"description": "What to do next, present when is_requested_revision is false.",
|
|
5649
|
+
"type": "string"
|
|
5240
5650
|
}
|
|
5241
5651
|
},
|
|
5242
5652
|
"required": [
|
|
5243
5653
|
"build",
|
|
5244
|
-
"reused"
|
|
5654
|
+
"reused",
|
|
5655
|
+
"is_requested_revision"
|
|
5245
5656
|
],
|
|
5246
5657
|
"additionalProperties": false
|
|
5247
5658
|
},
|
|
@@ -6171,7 +6582,7 @@ export const API_OPERATIONS = [
|
|
|
6171
6582
|
"method": "POST",
|
|
6172
6583
|
"path": "/v1/sites/{site_id}/previews",
|
|
6173
6584
|
"summary": "Share a preview",
|
|
6174
|
-
"description": "A private link that shows one build (default: the newest ready build of the draft) for 7 days (1 to 30). Anyone with the link can see it; it grants nothing else and is never indexed.",
|
|
6585
|
+
"description": "A private link that shows one build (default: the newest ready build of the draft) for 7 days (1 to 30), with an optional name saying who it is for. Anyone with the link can see it; it grants nothing else and is never indexed. The link runs sandboxed with origin `null`: Workers, browser storage and third-party APIs that refuse that origin fail there and work once published.",
|
|
6175
6586
|
"authentication_required": true,
|
|
6176
6587
|
"scope": "sites:write",
|
|
6177
6588
|
"surfaces": {
|
|
@@ -6206,6 +6617,11 @@ export const API_OPERATIONS = [
|
|
|
6206
6617
|
"type": "integer",
|
|
6207
6618
|
"minimum": 1,
|
|
6208
6619
|
"maximum": 30
|
|
6620
|
+
},
|
|
6621
|
+
"name": {
|
|
6622
|
+
"type": "string",
|
|
6623
|
+
"maxLength": 60,
|
|
6624
|
+
"description": "Who the link is for, so it can be told apart later (\"Marie\", \"the client\"). Empty or null: no name."
|
|
6209
6625
|
}
|
|
6210
6626
|
},
|
|
6211
6627
|
"additionalProperties": false
|
|
@@ -6228,12 +6644,31 @@ export const API_OPERATIONS = [
|
|
|
6228
6644
|
"id": {
|
|
6229
6645
|
"type": "string"
|
|
6230
6646
|
},
|
|
6647
|
+
"name": {
|
|
6648
|
+
"type": [
|
|
6649
|
+
"string",
|
|
6650
|
+
"null"
|
|
6651
|
+
]
|
|
6652
|
+
},
|
|
6231
6653
|
"url": {
|
|
6232
6654
|
"type": "string"
|
|
6233
6655
|
},
|
|
6234
6656
|
"build_id": {
|
|
6235
6657
|
"type": "string"
|
|
6236
6658
|
},
|
|
6659
|
+
"version": {
|
|
6660
|
+
"anyOf": [
|
|
6661
|
+
{
|
|
6662
|
+
"type": "integer",
|
|
6663
|
+
"minimum": -9007199254740991,
|
|
6664
|
+
"maximum": 9007199254740991
|
|
6665
|
+
},
|
|
6666
|
+
{
|
|
6667
|
+
"type": "null"
|
|
6668
|
+
}
|
|
6669
|
+
],
|
|
6670
|
+
"description": "The number of the version it shows (version 12), as in listSiteRevisions. Null when unknown."
|
|
6671
|
+
},
|
|
6237
6672
|
"expires_at": {
|
|
6238
6673
|
"type": "string",
|
|
6239
6674
|
"description": "ISO 8601, UTC."
|
|
@@ -6241,8 +6676,10 @@ export const API_OPERATIONS = [
|
|
|
6241
6676
|
},
|
|
6242
6677
|
"required": [
|
|
6243
6678
|
"id",
|
|
6679
|
+
"name",
|
|
6244
6680
|
"url",
|
|
6245
6681
|
"build_id",
|
|
6682
|
+
"version",
|
|
6246
6683
|
"expires_at"
|
|
6247
6684
|
],
|
|
6248
6685
|
"additionalProperties": false
|
|
@@ -6302,7 +6739,7 @@ export const API_OPERATIONS = [
|
|
|
6302
6739
|
"method": "GET",
|
|
6303
6740
|
"path": "/v1/sites/{site_id}/previews",
|
|
6304
6741
|
"summary": "List preview links",
|
|
6305
|
-
"description": "Preview links with their state: active, expired or revoked.",
|
|
6742
|
+
"description": "Preview links with their name and state: active, expired or revoked. A link whose build_id is not the newest ready build shows an older version: update it with build_id \"latest\".",
|
|
6306
6743
|
"authentication_required": true,
|
|
6307
6744
|
"scope": "sites:read",
|
|
6308
6745
|
"surfaces": {
|
|
@@ -6341,47 +6778,1610 @@ export const API_OPERATIONS = [
|
|
|
6341
6778
|
"id": {
|
|
6342
6779
|
"type": "string"
|
|
6343
6780
|
},
|
|
6781
|
+
"name": {
|
|
6782
|
+
"type": [
|
|
6783
|
+
"string",
|
|
6784
|
+
"null"
|
|
6785
|
+
]
|
|
6786
|
+
},
|
|
6344
6787
|
"build_id": {
|
|
6345
6788
|
"type": "string"
|
|
6346
6789
|
},
|
|
6790
|
+
"version": {
|
|
6791
|
+
"anyOf": [
|
|
6792
|
+
{
|
|
6793
|
+
"type": "integer",
|
|
6794
|
+
"minimum": -9007199254740991,
|
|
6795
|
+
"maximum": 9007199254740991
|
|
6796
|
+
},
|
|
6797
|
+
{
|
|
6798
|
+
"type": "null"
|
|
6799
|
+
}
|
|
6800
|
+
],
|
|
6801
|
+
"description": "The number of the version it shows (version 12), as in listSiteRevisions. Null when unknown."
|
|
6802
|
+
},
|
|
6347
6803
|
"url": {
|
|
6348
6804
|
"type": "string"
|
|
6349
6805
|
},
|
|
6350
6806
|
"purpose": {
|
|
6351
6807
|
"type": "string"
|
|
6352
6808
|
},
|
|
6353
|
-
"state": {
|
|
6809
|
+
"state": {
|
|
6810
|
+
"type": "string",
|
|
6811
|
+
"enum": [
|
|
6812
|
+
"active",
|
|
6813
|
+
"expired",
|
|
6814
|
+
"revoked"
|
|
6815
|
+
]
|
|
6816
|
+
},
|
|
6817
|
+
"expires_at": {
|
|
6818
|
+
"type": "string",
|
|
6819
|
+
"description": "ISO 8601, UTC."
|
|
6820
|
+
},
|
|
6821
|
+
"created_at": {
|
|
6822
|
+
"type": "string",
|
|
6823
|
+
"description": "ISO 8601, UTC."
|
|
6824
|
+
}
|
|
6825
|
+
},
|
|
6826
|
+
"required": [
|
|
6827
|
+
"id",
|
|
6828
|
+
"name",
|
|
6829
|
+
"build_id",
|
|
6830
|
+
"version",
|
|
6831
|
+
"url",
|
|
6832
|
+
"purpose",
|
|
6833
|
+
"state",
|
|
6834
|
+
"expires_at",
|
|
6835
|
+
"created_at"
|
|
6836
|
+
],
|
|
6837
|
+
"additionalProperties": false
|
|
6838
|
+
}
|
|
6839
|
+
}
|
|
6840
|
+
},
|
|
6841
|
+
"required": [
|
|
6842
|
+
"previews"
|
|
6843
|
+
],
|
|
6844
|
+
"additionalProperties": false
|
|
6845
|
+
},
|
|
6846
|
+
"request_id": {
|
|
6847
|
+
"type": "string"
|
|
6848
|
+
}
|
|
6849
|
+
},
|
|
6850
|
+
"required": [
|
|
6851
|
+
"data",
|
|
6852
|
+
"request_id"
|
|
6853
|
+
]
|
|
6854
|
+
}
|
|
6855
|
+
}
|
|
6856
|
+
}
|
|
6857
|
+
},
|
|
6858
|
+
"400": {
|
|
6859
|
+
"$ref": "#/components/responses/Error400"
|
|
6860
|
+
},
|
|
6861
|
+
"401": {
|
|
6862
|
+
"$ref": "#/components/responses/Error401"
|
|
6863
|
+
},
|
|
6864
|
+
"402": {
|
|
6865
|
+
"$ref": "#/components/responses/Error402"
|
|
6866
|
+
},
|
|
6867
|
+
"403": {
|
|
6868
|
+
"$ref": "#/components/responses/Error403"
|
|
6869
|
+
},
|
|
6870
|
+
"404": {
|
|
6871
|
+
"$ref": "#/components/responses/Error404"
|
|
6872
|
+
},
|
|
6873
|
+
"409": {
|
|
6874
|
+
"$ref": "#/components/responses/Error409"
|
|
6875
|
+
},
|
|
6876
|
+
"410": {
|
|
6877
|
+
"$ref": "#/components/responses/Error410"
|
|
6878
|
+
},
|
|
6879
|
+
"413": {
|
|
6880
|
+
"$ref": "#/components/responses/Error413"
|
|
6881
|
+
},
|
|
6882
|
+
"422": {
|
|
6883
|
+
"$ref": "#/components/responses/Error422"
|
|
6884
|
+
},
|
|
6885
|
+
"429": {
|
|
6886
|
+
"$ref": "#/components/responses/Error429"
|
|
6887
|
+
},
|
|
6888
|
+
"500": {
|
|
6889
|
+
"$ref": "#/components/responses/Error500"
|
|
6890
|
+
},
|
|
6891
|
+
"503": {
|
|
6892
|
+
"$ref": "#/components/responses/Error503"
|
|
6893
|
+
}
|
|
6894
|
+
}
|
|
6895
|
+
},
|
|
6896
|
+
{
|
|
6897
|
+
"operation_id": "updateSitePreview",
|
|
6898
|
+
"method": "PATCH",
|
|
6899
|
+
"path": "/v1/sites/{site_id}/previews/{preview_id}",
|
|
6900
|
+
"summary": "Change a preview link",
|
|
6901
|
+
"description": "Rename a shared link, make it work more days from now, or show another build at the same address (`build_id: \"latest\"`: the newest ready build of the draft). The person who has the link keeps it. A revoked link cannot be changed.",
|
|
6902
|
+
"authentication_required": true,
|
|
6903
|
+
"scope": "sites:write",
|
|
6904
|
+
"surfaces": {
|
|
6905
|
+
"cli": "atelier201 previews update",
|
|
6906
|
+
"mcp": "update_preview"
|
|
6907
|
+
},
|
|
6908
|
+
"parameters": [
|
|
6909
|
+
{
|
|
6910
|
+
"name": "site_id",
|
|
6911
|
+
"in": "path",
|
|
6912
|
+
"required": true,
|
|
6913
|
+
"schema": {
|
|
6914
|
+
"type": "string"
|
|
6915
|
+
},
|
|
6916
|
+
"description": "The site's id, or its slug (the address before .atelier201.page)."
|
|
6917
|
+
},
|
|
6918
|
+
{
|
|
6919
|
+
"name": "preview_id",
|
|
6920
|
+
"in": "path",
|
|
6921
|
+
"required": true,
|
|
6922
|
+
"schema": {
|
|
6923
|
+
"type": "string"
|
|
6924
|
+
}
|
|
6925
|
+
}
|
|
6926
|
+
],
|
|
6927
|
+
"request_body": {
|
|
6928
|
+
"required": true,
|
|
6929
|
+
"content": {
|
|
6930
|
+
"application/json": {
|
|
6931
|
+
"schema": {
|
|
6932
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
6933
|
+
"type": "object",
|
|
6934
|
+
"properties": {
|
|
6935
|
+
"name": {
|
|
6936
|
+
"anyOf": [
|
|
6937
|
+
{
|
|
6938
|
+
"type": "string",
|
|
6939
|
+
"maxLength": 60,
|
|
6940
|
+
"description": "Who the link is for, so it can be told apart later (\"Marie\", \"the client\"). Empty or null: no name."
|
|
6941
|
+
},
|
|
6942
|
+
{
|
|
6943
|
+
"type": "null"
|
|
6944
|
+
}
|
|
6945
|
+
]
|
|
6946
|
+
},
|
|
6947
|
+
"days": {
|
|
6948
|
+
"description": "The link works this many more days, counted from now (1 to 30). Also brings back an expired link.",
|
|
6949
|
+
"type": "integer",
|
|
6950
|
+
"minimum": 1,
|
|
6951
|
+
"maximum": 30
|
|
6952
|
+
},
|
|
6953
|
+
"build_id": {
|
|
6954
|
+
"description": "Show this build at the same address. \"latest\": the newest ready build of the draft, so the person sees the latest changes without a new link.",
|
|
6955
|
+
"anyOf": [
|
|
6956
|
+
{
|
|
6957
|
+
"type": "string",
|
|
6958
|
+
"const": "latest"
|
|
6959
|
+
},
|
|
6960
|
+
{
|
|
6961
|
+
"type": "string",
|
|
6962
|
+
"format": "uuid",
|
|
6963
|
+
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
|
|
6964
|
+
}
|
|
6965
|
+
]
|
|
6966
|
+
}
|
|
6967
|
+
},
|
|
6968
|
+
"additionalProperties": false
|
|
6969
|
+
}
|
|
6970
|
+
}
|
|
6971
|
+
}
|
|
6972
|
+
},
|
|
6973
|
+
"responses": {
|
|
6974
|
+
"200": {
|
|
6975
|
+
"description": "Change a preview link",
|
|
6976
|
+
"content": {
|
|
6977
|
+
"application/json": {
|
|
6978
|
+
"schema": {
|
|
6979
|
+
"type": "object",
|
|
6980
|
+
"properties": {
|
|
6981
|
+
"data": {
|
|
6982
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
6983
|
+
"type": "object",
|
|
6984
|
+
"properties": {
|
|
6985
|
+
"id": {
|
|
6986
|
+
"type": "string"
|
|
6987
|
+
},
|
|
6988
|
+
"name": {
|
|
6989
|
+
"type": [
|
|
6990
|
+
"string",
|
|
6991
|
+
"null"
|
|
6992
|
+
]
|
|
6993
|
+
},
|
|
6994
|
+
"build_id": {
|
|
6995
|
+
"type": "string"
|
|
6996
|
+
},
|
|
6997
|
+
"version": {
|
|
6998
|
+
"anyOf": [
|
|
6999
|
+
{
|
|
7000
|
+
"type": "integer",
|
|
7001
|
+
"minimum": -9007199254740991,
|
|
7002
|
+
"maximum": 9007199254740991
|
|
7003
|
+
},
|
|
7004
|
+
{
|
|
7005
|
+
"type": "null"
|
|
7006
|
+
}
|
|
7007
|
+
],
|
|
7008
|
+
"description": "The number of the version it shows (version 12), as in listSiteRevisions. Null when unknown."
|
|
7009
|
+
},
|
|
7010
|
+
"url": {
|
|
7011
|
+
"type": "string"
|
|
7012
|
+
},
|
|
7013
|
+
"purpose": {
|
|
7014
|
+
"type": "string"
|
|
7015
|
+
},
|
|
7016
|
+
"state": {
|
|
7017
|
+
"type": "string",
|
|
7018
|
+
"enum": [
|
|
7019
|
+
"active",
|
|
7020
|
+
"expired",
|
|
7021
|
+
"revoked"
|
|
7022
|
+
]
|
|
7023
|
+
},
|
|
7024
|
+
"expires_at": {
|
|
7025
|
+
"type": "string",
|
|
7026
|
+
"description": "ISO 8601, UTC."
|
|
7027
|
+
},
|
|
7028
|
+
"created_at": {
|
|
7029
|
+
"type": "string",
|
|
7030
|
+
"description": "ISO 8601, UTC."
|
|
7031
|
+
}
|
|
7032
|
+
},
|
|
7033
|
+
"required": [
|
|
7034
|
+
"id",
|
|
7035
|
+
"name",
|
|
7036
|
+
"build_id",
|
|
7037
|
+
"version",
|
|
7038
|
+
"url",
|
|
7039
|
+
"purpose",
|
|
7040
|
+
"state",
|
|
7041
|
+
"expires_at",
|
|
7042
|
+
"created_at"
|
|
7043
|
+
],
|
|
7044
|
+
"additionalProperties": false
|
|
7045
|
+
},
|
|
7046
|
+
"request_id": {
|
|
7047
|
+
"type": "string"
|
|
7048
|
+
}
|
|
7049
|
+
},
|
|
7050
|
+
"required": [
|
|
7051
|
+
"data",
|
|
7052
|
+
"request_id"
|
|
7053
|
+
]
|
|
7054
|
+
}
|
|
7055
|
+
}
|
|
7056
|
+
}
|
|
7057
|
+
},
|
|
7058
|
+
"400": {
|
|
7059
|
+
"$ref": "#/components/responses/Error400"
|
|
7060
|
+
},
|
|
7061
|
+
"401": {
|
|
7062
|
+
"$ref": "#/components/responses/Error401"
|
|
7063
|
+
},
|
|
7064
|
+
"402": {
|
|
7065
|
+
"$ref": "#/components/responses/Error402"
|
|
7066
|
+
},
|
|
7067
|
+
"403": {
|
|
7068
|
+
"$ref": "#/components/responses/Error403"
|
|
7069
|
+
},
|
|
7070
|
+
"404": {
|
|
7071
|
+
"$ref": "#/components/responses/Error404"
|
|
7072
|
+
},
|
|
7073
|
+
"409": {
|
|
7074
|
+
"$ref": "#/components/responses/Error409"
|
|
7075
|
+
},
|
|
7076
|
+
"410": {
|
|
7077
|
+
"$ref": "#/components/responses/Error410"
|
|
7078
|
+
},
|
|
7079
|
+
"413": {
|
|
7080
|
+
"$ref": "#/components/responses/Error413"
|
|
7081
|
+
},
|
|
7082
|
+
"422": {
|
|
7083
|
+
"$ref": "#/components/responses/Error422"
|
|
7084
|
+
},
|
|
7085
|
+
"429": {
|
|
7086
|
+
"$ref": "#/components/responses/Error429"
|
|
7087
|
+
},
|
|
7088
|
+
"500": {
|
|
7089
|
+
"$ref": "#/components/responses/Error500"
|
|
7090
|
+
},
|
|
7091
|
+
"503": {
|
|
7092
|
+
"$ref": "#/components/responses/Error503"
|
|
7093
|
+
}
|
|
7094
|
+
}
|
|
7095
|
+
},
|
|
7096
|
+
{
|
|
7097
|
+
"operation_id": "revokeSitePreview",
|
|
7098
|
+
"method": "DELETE",
|
|
7099
|
+
"path": "/v1/sites/{site_id}/previews/{preview_id}",
|
|
7100
|
+
"summary": "Revoke a preview link",
|
|
7101
|
+
"description": "The link stops working within about a minute.",
|
|
7102
|
+
"authentication_required": true,
|
|
7103
|
+
"scope": "sites:write",
|
|
7104
|
+
"surfaces": {
|
|
7105
|
+
"cli": "atelier201 previews revoke",
|
|
7106
|
+
"mcp": "revoke_preview"
|
|
7107
|
+
},
|
|
7108
|
+
"parameters": [
|
|
7109
|
+
{
|
|
7110
|
+
"name": "site_id",
|
|
7111
|
+
"in": "path",
|
|
7112
|
+
"required": true,
|
|
7113
|
+
"schema": {
|
|
7114
|
+
"type": "string"
|
|
7115
|
+
},
|
|
7116
|
+
"description": "The site's id, or its slug (the address before .atelier201.page)."
|
|
7117
|
+
},
|
|
7118
|
+
{
|
|
7119
|
+
"name": "preview_id",
|
|
7120
|
+
"in": "path",
|
|
7121
|
+
"required": true,
|
|
7122
|
+
"schema": {
|
|
7123
|
+
"type": "string"
|
|
7124
|
+
}
|
|
7125
|
+
}
|
|
7126
|
+
],
|
|
7127
|
+
"request_body": null,
|
|
7128
|
+
"responses": {
|
|
7129
|
+
"200": {
|
|
7130
|
+
"description": "Revoke a preview link",
|
|
7131
|
+
"content": {
|
|
7132
|
+
"application/json": {
|
|
7133
|
+
"schema": {
|
|
7134
|
+
"type": "object",
|
|
7135
|
+
"properties": {
|
|
7136
|
+
"data": {
|
|
7137
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
7138
|
+
"type": "object",
|
|
7139
|
+
"properties": {
|
|
7140
|
+
"id": {
|
|
7141
|
+
"type": "string"
|
|
7142
|
+
},
|
|
7143
|
+
"revoked": {
|
|
7144
|
+
"type": "boolean"
|
|
7145
|
+
}
|
|
7146
|
+
},
|
|
7147
|
+
"required": [
|
|
7148
|
+
"id",
|
|
7149
|
+
"revoked"
|
|
7150
|
+
],
|
|
7151
|
+
"additionalProperties": false
|
|
7152
|
+
},
|
|
7153
|
+
"request_id": {
|
|
7154
|
+
"type": "string"
|
|
7155
|
+
}
|
|
7156
|
+
},
|
|
7157
|
+
"required": [
|
|
7158
|
+
"data",
|
|
7159
|
+
"request_id"
|
|
7160
|
+
]
|
|
7161
|
+
}
|
|
7162
|
+
}
|
|
7163
|
+
}
|
|
7164
|
+
},
|
|
7165
|
+
"400": {
|
|
7166
|
+
"$ref": "#/components/responses/Error400"
|
|
7167
|
+
},
|
|
7168
|
+
"401": {
|
|
7169
|
+
"$ref": "#/components/responses/Error401"
|
|
7170
|
+
},
|
|
7171
|
+
"402": {
|
|
7172
|
+
"$ref": "#/components/responses/Error402"
|
|
7173
|
+
},
|
|
7174
|
+
"403": {
|
|
7175
|
+
"$ref": "#/components/responses/Error403"
|
|
7176
|
+
},
|
|
7177
|
+
"404": {
|
|
7178
|
+
"$ref": "#/components/responses/Error404"
|
|
7179
|
+
},
|
|
7180
|
+
"409": {
|
|
7181
|
+
"$ref": "#/components/responses/Error409"
|
|
7182
|
+
},
|
|
7183
|
+
"410": {
|
|
7184
|
+
"$ref": "#/components/responses/Error410"
|
|
7185
|
+
},
|
|
7186
|
+
"413": {
|
|
7187
|
+
"$ref": "#/components/responses/Error413"
|
|
7188
|
+
},
|
|
7189
|
+
"422": {
|
|
7190
|
+
"$ref": "#/components/responses/Error422"
|
|
7191
|
+
},
|
|
7192
|
+
"429": {
|
|
7193
|
+
"$ref": "#/components/responses/Error429"
|
|
7194
|
+
},
|
|
7195
|
+
"500": {
|
|
7196
|
+
"$ref": "#/components/responses/Error500"
|
|
7197
|
+
},
|
|
7198
|
+
"503": {
|
|
7199
|
+
"$ref": "#/components/responses/Error503"
|
|
7200
|
+
}
|
|
7201
|
+
}
|
|
7202
|
+
},
|
|
7203
|
+
{
|
|
7204
|
+
"operation_id": "getSiteAnalytics",
|
|
7205
|
+
"method": "GET",
|
|
7206
|
+
"path": "/v1/sites/{site_id}/analytics",
|
|
7207
|
+
"summary": "Read a site's visitor numbers",
|
|
7208
|
+
"description": "Page views of the live site by people, with pages, sources, countries and devices, over a period. No credits. Visitor figures are null when the owner turned visitor counting off, which only the owner can change, in the dashboard.",
|
|
7209
|
+
"authentication_required": true,
|
|
7210
|
+
"scope": "sites:read",
|
|
7211
|
+
"surfaces": {
|
|
7212
|
+
"cli": "atelier201 analytics",
|
|
7213
|
+
"mcp": "get_site_analytics"
|
|
7214
|
+
},
|
|
7215
|
+
"parameters": [
|
|
7216
|
+
{
|
|
7217
|
+
"name": "site_id",
|
|
7218
|
+
"in": "path",
|
|
7219
|
+
"required": true,
|
|
7220
|
+
"schema": {
|
|
7221
|
+
"type": "string"
|
|
7222
|
+
},
|
|
7223
|
+
"description": "The site's id, or its slug (the address before .atelier201.page)."
|
|
7224
|
+
},
|
|
7225
|
+
{
|
|
7226
|
+
"name": "period",
|
|
7227
|
+
"in": "query",
|
|
7228
|
+
"required": false,
|
|
7229
|
+
"schema": {
|
|
7230
|
+
"description": "today, 7d, 30d, 90d or 12m. Default 30d.",
|
|
7231
|
+
"type": "string",
|
|
7232
|
+
"enum": [
|
|
7233
|
+
"today",
|
|
7234
|
+
"7d",
|
|
7235
|
+
"30d",
|
|
7236
|
+
"90d",
|
|
7237
|
+
"12m"
|
|
7238
|
+
]
|
|
7239
|
+
}
|
|
7240
|
+
}
|
|
7241
|
+
],
|
|
7242
|
+
"request_body": null,
|
|
7243
|
+
"responses": {
|
|
7244
|
+
"200": {
|
|
7245
|
+
"description": "Read a site's visitor numbers",
|
|
7246
|
+
"content": {
|
|
7247
|
+
"application/json": {
|
|
7248
|
+
"schema": {
|
|
7249
|
+
"type": "object",
|
|
7250
|
+
"properties": {
|
|
7251
|
+
"data": {
|
|
7252
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
7253
|
+
"type": "object",
|
|
7254
|
+
"properties": {
|
|
7255
|
+
"period": {
|
|
7256
|
+
"type": "string",
|
|
7257
|
+
"enum": [
|
|
7258
|
+
"today",
|
|
7259
|
+
"7d",
|
|
7260
|
+
"30d",
|
|
7261
|
+
"90d",
|
|
7262
|
+
"12m"
|
|
7263
|
+
]
|
|
7264
|
+
},
|
|
7265
|
+
"from": {
|
|
7266
|
+
"type": "string",
|
|
7267
|
+
"description": "First UTC day covered."
|
|
7268
|
+
},
|
|
7269
|
+
"to": {
|
|
7270
|
+
"type": "string",
|
|
7271
|
+
"description": "Last UTC day covered: yesterday when today's live read was not available."
|
|
7272
|
+
},
|
|
7273
|
+
"visitor_counting": {
|
|
7274
|
+
"type": "boolean",
|
|
7275
|
+
"description": "False when the owner turned visitor counting off: the visitor figures are then null."
|
|
7276
|
+
},
|
|
7277
|
+
"totals": {
|
|
7278
|
+
"type": "object",
|
|
7279
|
+
"properties": {
|
|
7280
|
+
"views": {
|
|
7281
|
+
"type": "number"
|
|
7282
|
+
},
|
|
7283
|
+
"visitors": {
|
|
7284
|
+
"type": [
|
|
7285
|
+
"number",
|
|
7286
|
+
"null"
|
|
7287
|
+
]
|
|
7288
|
+
},
|
|
7289
|
+
"visits": {
|
|
7290
|
+
"type": [
|
|
7291
|
+
"number",
|
|
7292
|
+
"null"
|
|
7293
|
+
]
|
|
7294
|
+
},
|
|
7295
|
+
"bounce_rate": {
|
|
7296
|
+
"description": "Share of visits with a single page view, 0 to 1.",
|
|
7297
|
+
"type": [
|
|
7298
|
+
"number",
|
|
7299
|
+
"null"
|
|
7300
|
+
]
|
|
7301
|
+
},
|
|
7302
|
+
"visit_seconds": {
|
|
7303
|
+
"type": [
|
|
7304
|
+
"number",
|
|
7305
|
+
"null"
|
|
7306
|
+
]
|
|
7307
|
+
},
|
|
7308
|
+
"views_per_visit": {
|
|
7309
|
+
"type": [
|
|
7310
|
+
"number",
|
|
7311
|
+
"null"
|
|
7312
|
+
]
|
|
7313
|
+
}
|
|
7314
|
+
},
|
|
7315
|
+
"required": [
|
|
7316
|
+
"views",
|
|
7317
|
+
"visitors",
|
|
7318
|
+
"visits",
|
|
7319
|
+
"bounce_rate",
|
|
7320
|
+
"visit_seconds",
|
|
7321
|
+
"views_per_visit"
|
|
7322
|
+
],
|
|
7323
|
+
"additionalProperties": false
|
|
7324
|
+
},
|
|
7325
|
+
"previous": {
|
|
7326
|
+
"anyOf": [
|
|
7327
|
+
{
|
|
7328
|
+
"type": "object",
|
|
7329
|
+
"properties": {
|
|
7330
|
+
"views": {
|
|
7331
|
+
"type": "number"
|
|
7332
|
+
},
|
|
7333
|
+
"visitors": {
|
|
7334
|
+
"type": [
|
|
7335
|
+
"number",
|
|
7336
|
+
"null"
|
|
7337
|
+
]
|
|
7338
|
+
},
|
|
7339
|
+
"visits": {
|
|
7340
|
+
"type": [
|
|
7341
|
+
"number",
|
|
7342
|
+
"null"
|
|
7343
|
+
]
|
|
7344
|
+
},
|
|
7345
|
+
"bounce_rate": {
|
|
7346
|
+
"description": "Share of visits with a single page view, 0 to 1.",
|
|
7347
|
+
"type": [
|
|
7348
|
+
"number",
|
|
7349
|
+
"null"
|
|
7350
|
+
]
|
|
7351
|
+
},
|
|
7352
|
+
"visit_seconds": {
|
|
7353
|
+
"type": [
|
|
7354
|
+
"number",
|
|
7355
|
+
"null"
|
|
7356
|
+
]
|
|
7357
|
+
},
|
|
7358
|
+
"views_per_visit": {
|
|
7359
|
+
"type": [
|
|
7360
|
+
"number",
|
|
7361
|
+
"null"
|
|
7362
|
+
]
|
|
7363
|
+
}
|
|
7364
|
+
},
|
|
7365
|
+
"required": [
|
|
7366
|
+
"views",
|
|
7367
|
+
"visitors",
|
|
7368
|
+
"visits",
|
|
7369
|
+
"bounce_rate",
|
|
7370
|
+
"visit_seconds",
|
|
7371
|
+
"views_per_visit"
|
|
7372
|
+
],
|
|
7373
|
+
"additionalProperties": false
|
|
7374
|
+
},
|
|
7375
|
+
{
|
|
7376
|
+
"type": "null"
|
|
7377
|
+
}
|
|
7378
|
+
],
|
|
7379
|
+
"description": "The same number of days just before. Null when there is no data then, and for today."
|
|
7380
|
+
},
|
|
7381
|
+
"series": {
|
|
7382
|
+
"type": "array",
|
|
7383
|
+
"items": {
|
|
7384
|
+
"type": "object",
|
|
7385
|
+
"properties": {
|
|
7386
|
+
"at": {
|
|
7387
|
+
"type": "string"
|
|
7388
|
+
},
|
|
7389
|
+
"views": {
|
|
7390
|
+
"type": "number"
|
|
7391
|
+
},
|
|
7392
|
+
"visitors": {
|
|
7393
|
+
"type": [
|
|
7394
|
+
"number",
|
|
7395
|
+
"null"
|
|
7396
|
+
]
|
|
7397
|
+
}
|
|
7398
|
+
},
|
|
7399
|
+
"required": [
|
|
7400
|
+
"at",
|
|
7401
|
+
"views",
|
|
7402
|
+
"visitors"
|
|
7403
|
+
],
|
|
7404
|
+
"additionalProperties": false
|
|
7405
|
+
}
|
|
7406
|
+
},
|
|
7407
|
+
"pages": {
|
|
7408
|
+
"type": "array",
|
|
7409
|
+
"items": {
|
|
7410
|
+
"type": "object",
|
|
7411
|
+
"properties": {
|
|
7412
|
+
"key": {
|
|
7413
|
+
"type": "string"
|
|
7414
|
+
},
|
|
7415
|
+
"views": {
|
|
7416
|
+
"type": "number"
|
|
7417
|
+
},
|
|
7418
|
+
"visitors": {
|
|
7419
|
+
"type": [
|
|
7420
|
+
"number",
|
|
7421
|
+
"null"
|
|
7422
|
+
]
|
|
7423
|
+
}
|
|
7424
|
+
},
|
|
7425
|
+
"required": [
|
|
7426
|
+
"key",
|
|
7427
|
+
"views",
|
|
7428
|
+
"visitors"
|
|
7429
|
+
],
|
|
7430
|
+
"additionalProperties": false
|
|
7431
|
+
}
|
|
7432
|
+
},
|
|
7433
|
+
"sources": {
|
|
7434
|
+
"type": "array",
|
|
7435
|
+
"items": {
|
|
7436
|
+
"type": "object",
|
|
7437
|
+
"properties": {
|
|
7438
|
+
"key": {
|
|
7439
|
+
"type": "string"
|
|
7440
|
+
},
|
|
7441
|
+
"views": {
|
|
7442
|
+
"type": "number"
|
|
7443
|
+
},
|
|
7444
|
+
"visitors": {
|
|
7445
|
+
"type": [
|
|
7446
|
+
"number",
|
|
7447
|
+
"null"
|
|
7448
|
+
]
|
|
7449
|
+
}
|
|
7450
|
+
},
|
|
7451
|
+
"required": [
|
|
7452
|
+
"key",
|
|
7453
|
+
"views",
|
|
7454
|
+
"visitors"
|
|
7455
|
+
],
|
|
7456
|
+
"additionalProperties": false
|
|
7457
|
+
},
|
|
7458
|
+
"description": "Where views arrived from. Clicks inside the site are not arrivals, so these add up to fewer than the total."
|
|
7459
|
+
},
|
|
7460
|
+
"countries": {
|
|
7461
|
+
"type": "array",
|
|
7462
|
+
"items": {
|
|
7463
|
+
"type": "object",
|
|
7464
|
+
"properties": {
|
|
7465
|
+
"key": {
|
|
7466
|
+
"type": "string"
|
|
7467
|
+
},
|
|
7468
|
+
"views": {
|
|
7469
|
+
"type": "number"
|
|
7470
|
+
},
|
|
7471
|
+
"visitors": {
|
|
7472
|
+
"type": [
|
|
7473
|
+
"number",
|
|
7474
|
+
"null"
|
|
7475
|
+
]
|
|
7476
|
+
}
|
|
7477
|
+
},
|
|
7478
|
+
"required": [
|
|
7479
|
+
"key",
|
|
7480
|
+
"views",
|
|
7481
|
+
"visitors"
|
|
7482
|
+
],
|
|
7483
|
+
"additionalProperties": false
|
|
7484
|
+
}
|
|
7485
|
+
},
|
|
7486
|
+
"devices": {
|
|
7487
|
+
"type": "array",
|
|
7488
|
+
"items": {
|
|
7489
|
+
"type": "object",
|
|
7490
|
+
"properties": {
|
|
7491
|
+
"key": {
|
|
7492
|
+
"type": "string"
|
|
7493
|
+
},
|
|
7494
|
+
"views": {
|
|
7495
|
+
"type": "number"
|
|
7496
|
+
},
|
|
7497
|
+
"visitors": {
|
|
7498
|
+
"type": [
|
|
7499
|
+
"number",
|
|
7500
|
+
"null"
|
|
7501
|
+
]
|
|
7502
|
+
}
|
|
7503
|
+
},
|
|
7504
|
+
"required": [
|
|
7505
|
+
"key",
|
|
7506
|
+
"views",
|
|
7507
|
+
"visitors"
|
|
7508
|
+
],
|
|
7509
|
+
"additionalProperties": false
|
|
7510
|
+
}
|
|
7511
|
+
},
|
|
7512
|
+
"browsers": {
|
|
7513
|
+
"type": "array",
|
|
7514
|
+
"items": {
|
|
7515
|
+
"type": "object",
|
|
7516
|
+
"properties": {
|
|
7517
|
+
"key": {
|
|
7518
|
+
"type": "string"
|
|
7519
|
+
},
|
|
7520
|
+
"views": {
|
|
7521
|
+
"type": "number"
|
|
7522
|
+
},
|
|
7523
|
+
"visitors": {
|
|
7524
|
+
"type": [
|
|
7525
|
+
"number",
|
|
7526
|
+
"null"
|
|
7527
|
+
]
|
|
7528
|
+
}
|
|
7529
|
+
},
|
|
7530
|
+
"required": [
|
|
7531
|
+
"key",
|
|
7532
|
+
"views",
|
|
7533
|
+
"visitors"
|
|
7534
|
+
],
|
|
7535
|
+
"additionalProperties": false
|
|
7536
|
+
}
|
|
7537
|
+
},
|
|
7538
|
+
"os": {
|
|
7539
|
+
"type": "array",
|
|
7540
|
+
"items": {
|
|
7541
|
+
"type": "object",
|
|
7542
|
+
"properties": {
|
|
7543
|
+
"key": {
|
|
7544
|
+
"type": "string"
|
|
7545
|
+
},
|
|
7546
|
+
"views": {
|
|
7547
|
+
"type": "number"
|
|
7548
|
+
},
|
|
7549
|
+
"visitors": {
|
|
7550
|
+
"type": [
|
|
7551
|
+
"number",
|
|
7552
|
+
"null"
|
|
7553
|
+
]
|
|
7554
|
+
}
|
|
7555
|
+
},
|
|
7556
|
+
"required": [
|
|
7557
|
+
"key",
|
|
7558
|
+
"views",
|
|
7559
|
+
"visitors"
|
|
7560
|
+
],
|
|
7561
|
+
"additionalProperties": false
|
|
7562
|
+
}
|
|
7563
|
+
},
|
|
7564
|
+
"bot_views": {
|
|
7565
|
+
"type": "number",
|
|
7566
|
+
"description": "Views by bots, kept apart from every figure above."
|
|
7567
|
+
},
|
|
7568
|
+
"updated_at": {
|
|
7569
|
+
"description": "When the last full day was rolled up. Null before the first night.",
|
|
7570
|
+
"type": [
|
|
7571
|
+
"string",
|
|
7572
|
+
"null"
|
|
7573
|
+
]
|
|
7574
|
+
}
|
|
7575
|
+
},
|
|
7576
|
+
"required": [
|
|
7577
|
+
"period",
|
|
7578
|
+
"from",
|
|
7579
|
+
"to",
|
|
7580
|
+
"visitor_counting",
|
|
7581
|
+
"totals",
|
|
7582
|
+
"previous",
|
|
7583
|
+
"series",
|
|
7584
|
+
"pages",
|
|
7585
|
+
"sources",
|
|
7586
|
+
"countries",
|
|
7587
|
+
"devices",
|
|
7588
|
+
"browsers",
|
|
7589
|
+
"os",
|
|
7590
|
+
"bot_views",
|
|
7591
|
+
"updated_at"
|
|
7592
|
+
],
|
|
7593
|
+
"additionalProperties": false
|
|
7594
|
+
},
|
|
7595
|
+
"request_id": {
|
|
7596
|
+
"type": "string"
|
|
7597
|
+
}
|
|
7598
|
+
},
|
|
7599
|
+
"required": [
|
|
7600
|
+
"data",
|
|
7601
|
+
"request_id"
|
|
7602
|
+
]
|
|
7603
|
+
}
|
|
7604
|
+
}
|
|
7605
|
+
}
|
|
7606
|
+
},
|
|
7607
|
+
"400": {
|
|
7608
|
+
"$ref": "#/components/responses/Error400"
|
|
7609
|
+
},
|
|
7610
|
+
"401": {
|
|
7611
|
+
"$ref": "#/components/responses/Error401"
|
|
7612
|
+
},
|
|
7613
|
+
"402": {
|
|
7614
|
+
"$ref": "#/components/responses/Error402"
|
|
7615
|
+
},
|
|
7616
|
+
"403": {
|
|
7617
|
+
"$ref": "#/components/responses/Error403"
|
|
7618
|
+
},
|
|
7619
|
+
"404": {
|
|
7620
|
+
"$ref": "#/components/responses/Error404"
|
|
7621
|
+
},
|
|
7622
|
+
"409": {
|
|
7623
|
+
"$ref": "#/components/responses/Error409"
|
|
7624
|
+
},
|
|
7625
|
+
"410": {
|
|
7626
|
+
"$ref": "#/components/responses/Error410"
|
|
7627
|
+
},
|
|
7628
|
+
"413": {
|
|
7629
|
+
"$ref": "#/components/responses/Error413"
|
|
7630
|
+
},
|
|
7631
|
+
"422": {
|
|
7632
|
+
"$ref": "#/components/responses/Error422"
|
|
7633
|
+
},
|
|
7634
|
+
"429": {
|
|
7635
|
+
"$ref": "#/components/responses/Error429"
|
|
7636
|
+
},
|
|
7637
|
+
"500": {
|
|
7638
|
+
"$ref": "#/components/responses/Error500"
|
|
7639
|
+
},
|
|
7640
|
+
"503": {
|
|
7641
|
+
"$ref": "#/components/responses/Error503"
|
|
7642
|
+
}
|
|
7643
|
+
}
|
|
7644
|
+
},
|
|
7645
|
+
{
|
|
7646
|
+
"operation_id": "getSiteConsent",
|
|
7647
|
+
"method": "GET",
|
|
7648
|
+
"path": "/v1/sites/{site_id}/consent",
|
|
7649
|
+
"summary": "Read a site's cookie consent",
|
|
7650
|
+
"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.",
|
|
7651
|
+
"authentication_required": true,
|
|
7652
|
+
"scope": "sites:read",
|
|
7653
|
+
"surfaces": {
|
|
7654
|
+
"cli": "atelier201 consent status",
|
|
7655
|
+
"mcp": "get_site_consent"
|
|
7656
|
+
},
|
|
7657
|
+
"parameters": [
|
|
7658
|
+
{
|
|
7659
|
+
"name": "site_id",
|
|
7660
|
+
"in": "path",
|
|
7661
|
+
"required": true,
|
|
7662
|
+
"schema": {
|
|
7663
|
+
"type": "string"
|
|
7664
|
+
},
|
|
7665
|
+
"description": "The site's id, or its slug (the address before .atelier201.page)."
|
|
7666
|
+
}
|
|
7667
|
+
],
|
|
7668
|
+
"request_body": null,
|
|
7669
|
+
"responses": {
|
|
7670
|
+
"200": {
|
|
7671
|
+
"description": "Read a site's cookie consent",
|
|
7672
|
+
"content": {
|
|
7673
|
+
"application/json": {
|
|
7674
|
+
"schema": {
|
|
7675
|
+
"type": "object",
|
|
7676
|
+
"properties": {
|
|
7677
|
+
"data": {
|
|
7678
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
7679
|
+
"type": "object",
|
|
7680
|
+
"properties": {
|
|
7681
|
+
"enabled": {
|
|
7682
|
+
"type": "boolean",
|
|
7683
|
+
"description": "The owner's choice. Off until someone turns it on."
|
|
7684
|
+
},
|
|
7685
|
+
"applies_at_next_publication": {
|
|
7686
|
+
"type": "boolean",
|
|
7687
|
+
"description": "The choice differs from what the live site does. It reaches visitors with the next publication."
|
|
7688
|
+
},
|
|
7689
|
+
"state": {
|
|
7690
|
+
"type": "string",
|
|
7691
|
+
"enum": [
|
|
7692
|
+
"not_published",
|
|
7693
|
+
"off",
|
|
7694
|
+
"nothing_to_ask",
|
|
7695
|
+
"asking",
|
|
7696
|
+
"own_tool"
|
|
7697
|
+
],
|
|
7698
|
+
"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."
|
|
7699
|
+
},
|
|
7700
|
+
"own_tool": {
|
|
7701
|
+
"description": "The owner's consent tool found in the latest build. Atelier201 then keeps no proof.",
|
|
7702
|
+
"type": [
|
|
7703
|
+
"string",
|
|
7704
|
+
"null"
|
|
7705
|
+
]
|
|
7706
|
+
},
|
|
7707
|
+
"banner": {
|
|
7708
|
+
"anyOf": [
|
|
7709
|
+
{
|
|
7710
|
+
"type": "string",
|
|
7711
|
+
"enum": [
|
|
7712
|
+
"standard",
|
|
7713
|
+
"custom"
|
|
7714
|
+
]
|
|
7715
|
+
},
|
|
7716
|
+
{
|
|
7717
|
+
"type": "null"
|
|
7718
|
+
}
|
|
7719
|
+
],
|
|
7720
|
+
"description": "Which banner the live site shows. Null when it shows none."
|
|
7721
|
+
},
|
|
7722
|
+
"third_parties": {
|
|
7723
|
+
"type": "array",
|
|
7724
|
+
"items": {
|
|
7725
|
+
"type": "object",
|
|
7726
|
+
"properties": {
|
|
7727
|
+
"name": {
|
|
7728
|
+
"type": "string"
|
|
7729
|
+
},
|
|
7730
|
+
"category": {
|
|
7731
|
+
"type": "string",
|
|
7732
|
+
"enum": [
|
|
7733
|
+
"analytics",
|
|
7734
|
+
"marketing",
|
|
7735
|
+
"media",
|
|
7736
|
+
"none"
|
|
7737
|
+
],
|
|
7738
|
+
"description": "What it waits for. none: it stores nothing on the device, so it asks for nothing."
|
|
7739
|
+
}
|
|
7740
|
+
},
|
|
7741
|
+
"required": [
|
|
7742
|
+
"name",
|
|
7743
|
+
"category"
|
|
7744
|
+
],
|
|
7745
|
+
"additionalProperties": false
|
|
7746
|
+
},
|
|
7747
|
+
"description": "The known services in the latest build of the site, whether consent is on or off."
|
|
7748
|
+
},
|
|
7749
|
+
"unknown_hosts": {
|
|
7750
|
+
"type": "array",
|
|
7751
|
+
"items": {
|
|
7752
|
+
"type": "string"
|
|
7753
|
+
},
|
|
7754
|
+
"description": "Services nobody classified, in the latest build: they load for everyone until a tag says otherwise."
|
|
7755
|
+
},
|
|
7756
|
+
"categories": {
|
|
7757
|
+
"type": "array",
|
|
7758
|
+
"items": {
|
|
7759
|
+
"type": "string",
|
|
7760
|
+
"enum": [
|
|
7761
|
+
"analytics",
|
|
7762
|
+
"marketing",
|
|
7763
|
+
"media"
|
|
7764
|
+
]
|
|
7765
|
+
},
|
|
7766
|
+
"description": "What visitors of the live site are asked about."
|
|
7767
|
+
},
|
|
7768
|
+
"addon": {
|
|
7769
|
+
"type": "object",
|
|
7770
|
+
"properties": {
|
|
7771
|
+
"active": {
|
|
7772
|
+
"type": "boolean"
|
|
7773
|
+
},
|
|
7774
|
+
"ends_at_period_end": {
|
|
7775
|
+
"type": "boolean"
|
|
7776
|
+
},
|
|
7777
|
+
"current_period_end": {
|
|
7778
|
+
"anyOf": [
|
|
7779
|
+
{
|
|
7780
|
+
"type": "string",
|
|
7781
|
+
"description": "ISO 8601, UTC."
|
|
7782
|
+
},
|
|
7783
|
+
{
|
|
7784
|
+
"type": "null"
|
|
7785
|
+
}
|
|
7786
|
+
]
|
|
7787
|
+
},
|
|
7788
|
+
"price_eur": {
|
|
7789
|
+
"type": "number"
|
|
7790
|
+
}
|
|
7791
|
+
},
|
|
7792
|
+
"required": [
|
|
7793
|
+
"active",
|
|
7794
|
+
"ends_at_period_end",
|
|
7795
|
+
"current_period_end",
|
|
7796
|
+
"price_eur"
|
|
7797
|
+
],
|
|
7798
|
+
"additionalProperties": false,
|
|
7799
|
+
"description": "The custom banner add-on. Bought in the dashboard."
|
|
7800
|
+
},
|
|
7801
|
+
"proofs": {
|
|
7802
|
+
"type": "object",
|
|
7803
|
+
"properties": {
|
|
7804
|
+
"total": {
|
|
7805
|
+
"type": "number",
|
|
7806
|
+
"description": "Decisions kept."
|
|
7807
|
+
},
|
|
7808
|
+
"first_at": {
|
|
7809
|
+
"anyOf": [
|
|
7810
|
+
{
|
|
7811
|
+
"type": "string",
|
|
7812
|
+
"description": "ISO 8601, UTC."
|
|
7813
|
+
},
|
|
7814
|
+
{
|
|
7815
|
+
"type": "null"
|
|
7816
|
+
}
|
|
7817
|
+
]
|
|
7818
|
+
},
|
|
7819
|
+
"last_at": {
|
|
7820
|
+
"anyOf": [
|
|
7821
|
+
{
|
|
7822
|
+
"type": "string",
|
|
7823
|
+
"description": "ISO 8601, UTC."
|
|
7824
|
+
},
|
|
7825
|
+
{
|
|
7826
|
+
"type": "null"
|
|
7827
|
+
}
|
|
7828
|
+
]
|
|
7829
|
+
},
|
|
7830
|
+
"last_30_days": {
|
|
7831
|
+
"type": "object",
|
|
7832
|
+
"properties": {
|
|
7833
|
+
"accept": {
|
|
7834
|
+
"type": "number"
|
|
7835
|
+
},
|
|
7836
|
+
"reject": {
|
|
7837
|
+
"type": "number"
|
|
7838
|
+
},
|
|
7839
|
+
"custom": {
|
|
7840
|
+
"type": "number"
|
|
7841
|
+
},
|
|
7842
|
+
"withdraw": {
|
|
7843
|
+
"type": "number"
|
|
7844
|
+
}
|
|
7845
|
+
},
|
|
7846
|
+
"required": [
|
|
7847
|
+
"accept",
|
|
7848
|
+
"reject",
|
|
7849
|
+
"custom",
|
|
7850
|
+
"withdraw"
|
|
7851
|
+
],
|
|
7852
|
+
"additionalProperties": false
|
|
7853
|
+
},
|
|
7854
|
+
"versions": {
|
|
7855
|
+
"type": "number",
|
|
7856
|
+
"description": "Distinct versions of the banner and its third parties kept."
|
|
7857
|
+
},
|
|
7858
|
+
"retention_days": {
|
|
7859
|
+
"type": "number",
|
|
7860
|
+
"description": "How long a proof is kept before it is erased."
|
|
7861
|
+
}
|
|
7862
|
+
},
|
|
7863
|
+
"required": [
|
|
7864
|
+
"total",
|
|
7865
|
+
"first_at",
|
|
7866
|
+
"last_at",
|
|
7867
|
+
"last_30_days",
|
|
7868
|
+
"versions",
|
|
7869
|
+
"retention_days"
|
|
7870
|
+
],
|
|
7871
|
+
"additionalProperties": false
|
|
7872
|
+
}
|
|
7873
|
+
},
|
|
7874
|
+
"required": [
|
|
7875
|
+
"enabled",
|
|
7876
|
+
"applies_at_next_publication",
|
|
7877
|
+
"state",
|
|
7878
|
+
"own_tool",
|
|
7879
|
+
"banner",
|
|
7880
|
+
"third_parties",
|
|
7881
|
+
"unknown_hosts",
|
|
7882
|
+
"categories",
|
|
7883
|
+
"addon",
|
|
7884
|
+
"proofs"
|
|
7885
|
+
],
|
|
7886
|
+
"additionalProperties": false
|
|
7887
|
+
},
|
|
7888
|
+
"request_id": {
|
|
7889
|
+
"type": "string"
|
|
7890
|
+
}
|
|
7891
|
+
},
|
|
7892
|
+
"required": [
|
|
7893
|
+
"data",
|
|
7894
|
+
"request_id"
|
|
7895
|
+
]
|
|
7896
|
+
}
|
|
7897
|
+
}
|
|
7898
|
+
}
|
|
7899
|
+
},
|
|
7900
|
+
"400": {
|
|
7901
|
+
"$ref": "#/components/responses/Error400"
|
|
7902
|
+
},
|
|
7903
|
+
"401": {
|
|
7904
|
+
"$ref": "#/components/responses/Error401"
|
|
7905
|
+
},
|
|
7906
|
+
"402": {
|
|
7907
|
+
"$ref": "#/components/responses/Error402"
|
|
7908
|
+
},
|
|
7909
|
+
"403": {
|
|
7910
|
+
"$ref": "#/components/responses/Error403"
|
|
7911
|
+
},
|
|
7912
|
+
"404": {
|
|
7913
|
+
"$ref": "#/components/responses/Error404"
|
|
7914
|
+
},
|
|
7915
|
+
"409": {
|
|
7916
|
+
"$ref": "#/components/responses/Error409"
|
|
7917
|
+
},
|
|
7918
|
+
"410": {
|
|
7919
|
+
"$ref": "#/components/responses/Error410"
|
|
7920
|
+
},
|
|
7921
|
+
"413": {
|
|
7922
|
+
"$ref": "#/components/responses/Error413"
|
|
7923
|
+
},
|
|
7924
|
+
"422": {
|
|
7925
|
+
"$ref": "#/components/responses/Error422"
|
|
7926
|
+
},
|
|
7927
|
+
"429": {
|
|
7928
|
+
"$ref": "#/components/responses/Error429"
|
|
7929
|
+
},
|
|
7930
|
+
"500": {
|
|
7931
|
+
"$ref": "#/components/responses/Error500"
|
|
7932
|
+
},
|
|
7933
|
+
"503": {
|
|
7934
|
+
"$ref": "#/components/responses/Error503"
|
|
7935
|
+
}
|
|
7936
|
+
}
|
|
7937
|
+
},
|
|
7938
|
+
{
|
|
7939
|
+
"operation_id": "setSiteConsent",
|
|
7940
|
+
"method": "PUT",
|
|
7941
|
+
"path": "/v1/sites/{site_id}/consent",
|
|
7942
|
+
"summary": "Turn a site's cookie consent on or off",
|
|
7943
|
+
"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.",
|
|
7944
|
+
"authentication_required": true,
|
|
7945
|
+
"scope": "sites:write",
|
|
7946
|
+
"surfaces": {
|
|
7947
|
+
"cli": "atelier201 consent enable",
|
|
7948
|
+
"mcp": "set_site_consent"
|
|
7949
|
+
},
|
|
7950
|
+
"parameters": [
|
|
7951
|
+
{
|
|
7952
|
+
"name": "site_id",
|
|
7953
|
+
"in": "path",
|
|
7954
|
+
"required": true,
|
|
7955
|
+
"schema": {
|
|
7956
|
+
"type": "string"
|
|
7957
|
+
},
|
|
7958
|
+
"description": "The site's id, or its slug (the address before .atelier201.page)."
|
|
7959
|
+
}
|
|
7960
|
+
],
|
|
7961
|
+
"request_body": {
|
|
7962
|
+
"required": true,
|
|
7963
|
+
"content": {
|
|
7964
|
+
"application/json": {
|
|
7965
|
+
"schema": {
|
|
7966
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
7967
|
+
"type": "object",
|
|
7968
|
+
"properties": {
|
|
7969
|
+
"enabled": {
|
|
7970
|
+
"type": "boolean",
|
|
7971
|
+
"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."
|
|
7972
|
+
}
|
|
7973
|
+
},
|
|
7974
|
+
"required": [
|
|
7975
|
+
"enabled"
|
|
7976
|
+
]
|
|
7977
|
+
}
|
|
7978
|
+
}
|
|
7979
|
+
}
|
|
7980
|
+
},
|
|
7981
|
+
"responses": {
|
|
7982
|
+
"200": {
|
|
7983
|
+
"description": "Turn a site's cookie consent on or off",
|
|
7984
|
+
"content": {
|
|
7985
|
+
"application/json": {
|
|
7986
|
+
"schema": {
|
|
7987
|
+
"type": "object",
|
|
7988
|
+
"properties": {
|
|
7989
|
+
"data": {
|
|
7990
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
7991
|
+
"type": "object",
|
|
7992
|
+
"properties": {
|
|
7993
|
+
"enabled": {
|
|
7994
|
+
"type": "boolean",
|
|
7995
|
+
"description": "The owner's choice. Off until someone turns it on."
|
|
7996
|
+
},
|
|
7997
|
+
"applies_at_next_publication": {
|
|
7998
|
+
"type": "boolean",
|
|
7999
|
+
"description": "The choice differs from what the live site does. It reaches visitors with the next publication."
|
|
8000
|
+
},
|
|
8001
|
+
"state": {
|
|
8002
|
+
"type": "string",
|
|
8003
|
+
"enum": [
|
|
8004
|
+
"not_published",
|
|
8005
|
+
"off",
|
|
8006
|
+
"nothing_to_ask",
|
|
8007
|
+
"asking",
|
|
8008
|
+
"own_tool"
|
|
8009
|
+
],
|
|
8010
|
+
"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."
|
|
8011
|
+
},
|
|
8012
|
+
"own_tool": {
|
|
8013
|
+
"description": "The owner's consent tool found in the latest build. Atelier201 then keeps no proof.",
|
|
8014
|
+
"type": [
|
|
8015
|
+
"string",
|
|
8016
|
+
"null"
|
|
8017
|
+
]
|
|
8018
|
+
},
|
|
8019
|
+
"banner": {
|
|
8020
|
+
"anyOf": [
|
|
8021
|
+
{
|
|
8022
|
+
"type": "string",
|
|
8023
|
+
"enum": [
|
|
8024
|
+
"standard",
|
|
8025
|
+
"custom"
|
|
8026
|
+
]
|
|
8027
|
+
},
|
|
8028
|
+
{
|
|
8029
|
+
"type": "null"
|
|
8030
|
+
}
|
|
8031
|
+
],
|
|
8032
|
+
"description": "Which banner the live site shows. Null when it shows none."
|
|
8033
|
+
},
|
|
8034
|
+
"third_parties": {
|
|
8035
|
+
"type": "array",
|
|
8036
|
+
"items": {
|
|
8037
|
+
"type": "object",
|
|
8038
|
+
"properties": {
|
|
8039
|
+
"name": {
|
|
8040
|
+
"type": "string"
|
|
8041
|
+
},
|
|
8042
|
+
"category": {
|
|
8043
|
+
"type": "string",
|
|
8044
|
+
"enum": [
|
|
8045
|
+
"analytics",
|
|
8046
|
+
"marketing",
|
|
8047
|
+
"media",
|
|
8048
|
+
"none"
|
|
8049
|
+
],
|
|
8050
|
+
"description": "What it waits for. none: it stores nothing on the device, so it asks for nothing."
|
|
8051
|
+
}
|
|
8052
|
+
},
|
|
8053
|
+
"required": [
|
|
8054
|
+
"name",
|
|
8055
|
+
"category"
|
|
8056
|
+
],
|
|
8057
|
+
"additionalProperties": false
|
|
8058
|
+
},
|
|
8059
|
+
"description": "The known services in the latest build of the site, whether consent is on or off."
|
|
8060
|
+
},
|
|
8061
|
+
"unknown_hosts": {
|
|
8062
|
+
"type": "array",
|
|
8063
|
+
"items": {
|
|
8064
|
+
"type": "string"
|
|
8065
|
+
},
|
|
8066
|
+
"description": "Services nobody classified, in the latest build: they load for everyone until a tag says otherwise."
|
|
8067
|
+
},
|
|
8068
|
+
"categories": {
|
|
8069
|
+
"type": "array",
|
|
8070
|
+
"items": {
|
|
8071
|
+
"type": "string",
|
|
8072
|
+
"enum": [
|
|
8073
|
+
"analytics",
|
|
8074
|
+
"marketing",
|
|
8075
|
+
"media"
|
|
8076
|
+
]
|
|
8077
|
+
},
|
|
8078
|
+
"description": "What visitors of the live site are asked about."
|
|
8079
|
+
},
|
|
8080
|
+
"addon": {
|
|
8081
|
+
"type": "object",
|
|
8082
|
+
"properties": {
|
|
8083
|
+
"active": {
|
|
8084
|
+
"type": "boolean"
|
|
8085
|
+
},
|
|
8086
|
+
"ends_at_period_end": {
|
|
8087
|
+
"type": "boolean"
|
|
8088
|
+
},
|
|
8089
|
+
"current_period_end": {
|
|
8090
|
+
"anyOf": [
|
|
8091
|
+
{
|
|
8092
|
+
"type": "string",
|
|
8093
|
+
"description": "ISO 8601, UTC."
|
|
8094
|
+
},
|
|
8095
|
+
{
|
|
8096
|
+
"type": "null"
|
|
8097
|
+
}
|
|
8098
|
+
]
|
|
8099
|
+
},
|
|
8100
|
+
"price_eur": {
|
|
8101
|
+
"type": "number"
|
|
8102
|
+
}
|
|
8103
|
+
},
|
|
8104
|
+
"required": [
|
|
8105
|
+
"active",
|
|
8106
|
+
"ends_at_period_end",
|
|
8107
|
+
"current_period_end",
|
|
8108
|
+
"price_eur"
|
|
8109
|
+
],
|
|
8110
|
+
"additionalProperties": false,
|
|
8111
|
+
"description": "The custom banner add-on. Bought in the dashboard."
|
|
8112
|
+
},
|
|
8113
|
+
"proofs": {
|
|
8114
|
+
"type": "object",
|
|
8115
|
+
"properties": {
|
|
8116
|
+
"total": {
|
|
8117
|
+
"type": "number",
|
|
8118
|
+
"description": "Decisions kept."
|
|
8119
|
+
},
|
|
8120
|
+
"first_at": {
|
|
8121
|
+
"anyOf": [
|
|
8122
|
+
{
|
|
8123
|
+
"type": "string",
|
|
8124
|
+
"description": "ISO 8601, UTC."
|
|
8125
|
+
},
|
|
8126
|
+
{
|
|
8127
|
+
"type": "null"
|
|
8128
|
+
}
|
|
8129
|
+
]
|
|
8130
|
+
},
|
|
8131
|
+
"last_at": {
|
|
8132
|
+
"anyOf": [
|
|
8133
|
+
{
|
|
8134
|
+
"type": "string",
|
|
8135
|
+
"description": "ISO 8601, UTC."
|
|
8136
|
+
},
|
|
8137
|
+
{
|
|
8138
|
+
"type": "null"
|
|
8139
|
+
}
|
|
8140
|
+
]
|
|
8141
|
+
},
|
|
8142
|
+
"last_30_days": {
|
|
8143
|
+
"type": "object",
|
|
8144
|
+
"properties": {
|
|
8145
|
+
"accept": {
|
|
8146
|
+
"type": "number"
|
|
8147
|
+
},
|
|
8148
|
+
"reject": {
|
|
8149
|
+
"type": "number"
|
|
8150
|
+
},
|
|
8151
|
+
"custom": {
|
|
8152
|
+
"type": "number"
|
|
8153
|
+
},
|
|
8154
|
+
"withdraw": {
|
|
8155
|
+
"type": "number"
|
|
8156
|
+
}
|
|
8157
|
+
},
|
|
8158
|
+
"required": [
|
|
8159
|
+
"accept",
|
|
8160
|
+
"reject",
|
|
8161
|
+
"custom",
|
|
8162
|
+
"withdraw"
|
|
8163
|
+
],
|
|
8164
|
+
"additionalProperties": false
|
|
8165
|
+
},
|
|
8166
|
+
"versions": {
|
|
8167
|
+
"type": "number",
|
|
8168
|
+
"description": "Distinct versions of the banner and its third parties kept."
|
|
8169
|
+
},
|
|
8170
|
+
"retention_days": {
|
|
8171
|
+
"type": "number",
|
|
8172
|
+
"description": "How long a proof is kept before it is erased."
|
|
8173
|
+
}
|
|
8174
|
+
},
|
|
8175
|
+
"required": [
|
|
8176
|
+
"total",
|
|
8177
|
+
"first_at",
|
|
8178
|
+
"last_at",
|
|
8179
|
+
"last_30_days",
|
|
8180
|
+
"versions",
|
|
8181
|
+
"retention_days"
|
|
8182
|
+
],
|
|
8183
|
+
"additionalProperties": false
|
|
8184
|
+
}
|
|
8185
|
+
},
|
|
8186
|
+
"required": [
|
|
8187
|
+
"enabled",
|
|
8188
|
+
"applies_at_next_publication",
|
|
8189
|
+
"state",
|
|
8190
|
+
"own_tool",
|
|
8191
|
+
"banner",
|
|
8192
|
+
"third_parties",
|
|
8193
|
+
"unknown_hosts",
|
|
8194
|
+
"categories",
|
|
8195
|
+
"addon",
|
|
8196
|
+
"proofs"
|
|
8197
|
+
],
|
|
8198
|
+
"additionalProperties": false
|
|
8199
|
+
},
|
|
8200
|
+
"request_id": {
|
|
8201
|
+
"type": "string"
|
|
8202
|
+
}
|
|
8203
|
+
},
|
|
8204
|
+
"required": [
|
|
8205
|
+
"data",
|
|
8206
|
+
"request_id"
|
|
8207
|
+
]
|
|
8208
|
+
}
|
|
8209
|
+
}
|
|
8210
|
+
}
|
|
8211
|
+
},
|
|
8212
|
+
"400": {
|
|
8213
|
+
"$ref": "#/components/responses/Error400"
|
|
8214
|
+
},
|
|
8215
|
+
"401": {
|
|
8216
|
+
"$ref": "#/components/responses/Error401"
|
|
8217
|
+
},
|
|
8218
|
+
"402": {
|
|
8219
|
+
"$ref": "#/components/responses/Error402"
|
|
8220
|
+
},
|
|
8221
|
+
"403": {
|
|
8222
|
+
"$ref": "#/components/responses/Error403"
|
|
8223
|
+
},
|
|
8224
|
+
"404": {
|
|
8225
|
+
"$ref": "#/components/responses/Error404"
|
|
8226
|
+
},
|
|
8227
|
+
"409": {
|
|
8228
|
+
"$ref": "#/components/responses/Error409"
|
|
8229
|
+
},
|
|
8230
|
+
"410": {
|
|
8231
|
+
"$ref": "#/components/responses/Error410"
|
|
8232
|
+
},
|
|
8233
|
+
"413": {
|
|
8234
|
+
"$ref": "#/components/responses/Error413"
|
|
8235
|
+
},
|
|
8236
|
+
"422": {
|
|
8237
|
+
"$ref": "#/components/responses/Error422"
|
|
8238
|
+
},
|
|
8239
|
+
"429": {
|
|
8240
|
+
"$ref": "#/components/responses/Error429"
|
|
8241
|
+
},
|
|
8242
|
+
"500": {
|
|
8243
|
+
"$ref": "#/components/responses/Error500"
|
|
8244
|
+
},
|
|
8245
|
+
"503": {
|
|
8246
|
+
"$ref": "#/components/responses/Error503"
|
|
8247
|
+
}
|
|
8248
|
+
}
|
|
8249
|
+
},
|
|
8250
|
+
{
|
|
8251
|
+
"operation_id": "listSiteConsentDecisions",
|
|
8252
|
+
"method": "GET",
|
|
8253
|
+
"path": "/v1/sites/{site_id}/consent/decisions",
|
|
8254
|
+
"summary": "List the consent decisions kept",
|
|
8255
|
+
"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.",
|
|
8256
|
+
"authentication_required": true,
|
|
8257
|
+
"scope": "sites:read",
|
|
8258
|
+
"surfaces": {
|
|
8259
|
+
"cli": "atelier201 consent decisions",
|
|
8260
|
+
"mcp": "list_consent_decisions"
|
|
8261
|
+
},
|
|
8262
|
+
"parameters": [
|
|
8263
|
+
{
|
|
8264
|
+
"name": "site_id",
|
|
8265
|
+
"in": "path",
|
|
8266
|
+
"required": true,
|
|
8267
|
+
"schema": {
|
|
8268
|
+
"type": "string"
|
|
8269
|
+
},
|
|
8270
|
+
"description": "The site's id, or its slug (the address before .atelier201.page)."
|
|
8271
|
+
},
|
|
8272
|
+
{
|
|
8273
|
+
"name": "reference",
|
|
8274
|
+
"in": "query",
|
|
8275
|
+
"required": false,
|
|
8276
|
+
"schema": {
|
|
8277
|
+
"description": "The reference a visitor quotes: finds that one decision.",
|
|
8278
|
+
"type": "string",
|
|
8279
|
+
"minLength": 16,
|
|
8280
|
+
"maxLength": 64
|
|
8281
|
+
}
|
|
8282
|
+
},
|
|
8283
|
+
{
|
|
8284
|
+
"name": "cursor",
|
|
8285
|
+
"in": "query",
|
|
8286
|
+
"required": false,
|
|
8287
|
+
"schema": {
|
|
8288
|
+
"description": "next_cursor of the previous page.",
|
|
8289
|
+
"type": "string",
|
|
8290
|
+
"maxLength": 128
|
|
8291
|
+
}
|
|
8292
|
+
},
|
|
8293
|
+
{
|
|
8294
|
+
"name": "limit",
|
|
8295
|
+
"in": "query",
|
|
8296
|
+
"required": false,
|
|
8297
|
+
"schema": {
|
|
8298
|
+
"description": "Decisions per page. Default 50.",
|
|
8299
|
+
"type": "integer",
|
|
8300
|
+
"minimum": 1,
|
|
8301
|
+
"maximum": 500
|
|
8302
|
+
}
|
|
8303
|
+
}
|
|
8304
|
+
],
|
|
8305
|
+
"request_body": null,
|
|
8306
|
+
"responses": {
|
|
8307
|
+
"200": {
|
|
8308
|
+
"description": "List the consent decisions kept",
|
|
8309
|
+
"content": {
|
|
8310
|
+
"application/json": {
|
|
8311
|
+
"schema": {
|
|
8312
|
+
"type": "object",
|
|
8313
|
+
"properties": {
|
|
8314
|
+
"data": {
|
|
8315
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
8316
|
+
"type": "object",
|
|
8317
|
+
"properties": {
|
|
8318
|
+
"decisions": {
|
|
8319
|
+
"type": "array",
|
|
8320
|
+
"items": {
|
|
8321
|
+
"type": "object",
|
|
8322
|
+
"properties": {
|
|
8323
|
+
"reference": {
|
|
8324
|
+
"type": "string"
|
|
8325
|
+
},
|
|
8326
|
+
"at": {
|
|
8327
|
+
"type": "string",
|
|
8328
|
+
"description": "The server's date of the decision."
|
|
8329
|
+
},
|
|
8330
|
+
"action": {
|
|
6354
8331
|
"type": "string",
|
|
6355
8332
|
"enum": [
|
|
6356
|
-
"
|
|
6357
|
-
"
|
|
6358
|
-
"
|
|
8333
|
+
"accept",
|
|
8334
|
+
"reject",
|
|
8335
|
+
"custom",
|
|
8336
|
+
"withdraw"
|
|
6359
8337
|
]
|
|
6360
8338
|
},
|
|
6361
|
-
"
|
|
8339
|
+
"granted": {
|
|
8340
|
+
"type": "array",
|
|
8341
|
+
"items": {
|
|
8342
|
+
"type": "string",
|
|
8343
|
+
"enum": [
|
|
8344
|
+
"analytics",
|
|
8345
|
+
"marketing",
|
|
8346
|
+
"media"
|
|
8347
|
+
]
|
|
8348
|
+
},
|
|
8349
|
+
"description": "What the visitor said yes to. Empty for a refusal."
|
|
8350
|
+
},
|
|
8351
|
+
"build_id": {
|
|
6362
8352
|
"type": "string",
|
|
6363
|
-
"description": "
|
|
8353
|
+
"description": "The build that showed the banner: list_consent_versions says what it showed."
|
|
6364
8354
|
},
|
|
6365
|
-
"
|
|
8355
|
+
"locale": {
|
|
8356
|
+
"type": "string"
|
|
8357
|
+
},
|
|
8358
|
+
"country": {
|
|
6366
8359
|
"type": "string",
|
|
6367
|
-
"description": "
|
|
8360
|
+
"description": "Two letters, XX when unknown. No address is ever kept."
|
|
6368
8361
|
}
|
|
6369
8362
|
},
|
|
6370
8363
|
"required": [
|
|
6371
|
-
"
|
|
8364
|
+
"reference",
|
|
8365
|
+
"at",
|
|
8366
|
+
"action",
|
|
8367
|
+
"granted",
|
|
6372
8368
|
"build_id",
|
|
6373
|
-
"
|
|
6374
|
-
"
|
|
6375
|
-
"state",
|
|
6376
|
-
"expires_at",
|
|
6377
|
-
"created_at"
|
|
8369
|
+
"locale",
|
|
8370
|
+
"country"
|
|
6378
8371
|
],
|
|
6379
8372
|
"additionalProperties": false
|
|
6380
8373
|
}
|
|
8374
|
+
},
|
|
8375
|
+
"next_cursor": {
|
|
8376
|
+
"type": [
|
|
8377
|
+
"string",
|
|
8378
|
+
"null"
|
|
8379
|
+
]
|
|
6381
8380
|
}
|
|
6382
8381
|
},
|
|
6383
8382
|
"required": [
|
|
6384
|
-
"
|
|
8383
|
+
"decisions",
|
|
8384
|
+
"next_cursor"
|
|
6385
8385
|
],
|
|
6386
8386
|
"additionalProperties": false
|
|
6387
8387
|
},
|
|
@@ -6436,16 +8436,16 @@ export const API_OPERATIONS = [
|
|
|
6436
8436
|
}
|
|
6437
8437
|
},
|
|
6438
8438
|
{
|
|
6439
|
-
"operation_id": "
|
|
6440
|
-
"method": "
|
|
6441
|
-
"path": "/v1/sites/{site_id}/
|
|
6442
|
-
"summary": "
|
|
6443
|
-
"description": "The
|
|
8439
|
+
"operation_id": "listSiteConsentVersions",
|
|
8440
|
+
"method": "GET",
|
|
8441
|
+
"path": "/v1/sites/{site_id}/consent/versions",
|
|
8442
|
+
"summary": "List what each publication showed",
|
|
8443
|
+
"description": "Costs no credits. The banner, its texts and the third parties of each publication, with its commit: what a decision was made in front of.",
|
|
6444
8444
|
"authentication_required": true,
|
|
6445
|
-
"scope": "sites:
|
|
8445
|
+
"scope": "sites:read",
|
|
6446
8446
|
"surfaces": {
|
|
6447
|
-
"cli": "atelier201
|
|
6448
|
-
"mcp": "
|
|
8447
|
+
"cli": "atelier201 consent versions",
|
|
8448
|
+
"mcp": "list_consent_versions"
|
|
6449
8449
|
},
|
|
6450
8450
|
"parameters": [
|
|
6451
8451
|
{
|
|
@@ -6458,18 +8458,20 @@ export const API_OPERATIONS = [
|
|
|
6458
8458
|
"description": "The site's id, or its slug (the address before .atelier201.page)."
|
|
6459
8459
|
},
|
|
6460
8460
|
{
|
|
6461
|
-
"name": "
|
|
6462
|
-
"in": "
|
|
6463
|
-
"required":
|
|
8461
|
+
"name": "build_id",
|
|
8462
|
+
"in": "query",
|
|
8463
|
+
"required": false,
|
|
6464
8464
|
"schema": {
|
|
6465
|
-
"
|
|
8465
|
+
"description": "The build a decision points at. Default: the latest publications.",
|
|
8466
|
+
"type": "string",
|
|
8467
|
+
"maxLength": 64
|
|
6466
8468
|
}
|
|
6467
8469
|
}
|
|
6468
8470
|
],
|
|
6469
8471
|
"request_body": null,
|
|
6470
8472
|
"responses": {
|
|
6471
8473
|
"200": {
|
|
6472
|
-
"description": "
|
|
8474
|
+
"description": "List what each publication showed",
|
|
6473
8475
|
"content": {
|
|
6474
8476
|
"application/json": {
|
|
6475
8477
|
"schema": {
|
|
@@ -6479,16 +8481,112 @@ export const API_OPERATIONS = [
|
|
|
6479
8481
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
6480
8482
|
"type": "object",
|
|
6481
8483
|
"properties": {
|
|
6482
|
-
"
|
|
6483
|
-
"type": "
|
|
6484
|
-
|
|
6485
|
-
|
|
6486
|
-
|
|
8484
|
+
"versions": {
|
|
8485
|
+
"type": "array",
|
|
8486
|
+
"items": {
|
|
8487
|
+
"type": "object",
|
|
8488
|
+
"properties": {
|
|
8489
|
+
"build_id": {
|
|
8490
|
+
"type": "string"
|
|
8491
|
+
},
|
|
8492
|
+
"hash": {
|
|
8493
|
+
"type": "string",
|
|
8494
|
+
"description": "Fingerprint of what follows: two publications showing the same thing share it."
|
|
8495
|
+
},
|
|
8496
|
+
"commit": {
|
|
8497
|
+
"type": "string",
|
|
8498
|
+
"description": "The Git commit published."
|
|
8499
|
+
},
|
|
8500
|
+
"published_at": {
|
|
8501
|
+
"type": "string",
|
|
8502
|
+
"description": "ISO 8601, UTC."
|
|
8503
|
+
},
|
|
8504
|
+
"revision": {
|
|
8505
|
+
"type": "string",
|
|
8506
|
+
"description": "The version of Atelier201's banner and script."
|
|
8507
|
+
},
|
|
8508
|
+
"third_parties": {
|
|
8509
|
+
"type": "array",
|
|
8510
|
+
"items": {
|
|
8511
|
+
"type": "object",
|
|
8512
|
+
"properties": {
|
|
8513
|
+
"name": {
|
|
8514
|
+
"type": "string"
|
|
8515
|
+
},
|
|
8516
|
+
"category": {
|
|
8517
|
+
"type": "string",
|
|
8518
|
+
"enum": [
|
|
8519
|
+
"analytics",
|
|
8520
|
+
"marketing",
|
|
8521
|
+
"media",
|
|
8522
|
+
"none"
|
|
8523
|
+
],
|
|
8524
|
+
"description": "What it waits for. none: it stores nothing on the device, so it asks for nothing."
|
|
8525
|
+
}
|
|
8526
|
+
},
|
|
8527
|
+
"required": [
|
|
8528
|
+
"name",
|
|
8529
|
+
"category"
|
|
8530
|
+
],
|
|
8531
|
+
"additionalProperties": false
|
|
8532
|
+
}
|
|
8533
|
+
},
|
|
8534
|
+
"unknown_hosts": {
|
|
8535
|
+
"type": "array",
|
|
8536
|
+
"items": {
|
|
8537
|
+
"type": "string"
|
|
8538
|
+
}
|
|
8539
|
+
},
|
|
8540
|
+
"categories": {
|
|
8541
|
+
"type": "array",
|
|
8542
|
+
"items": {
|
|
8543
|
+
"type": "string",
|
|
8544
|
+
"enum": [
|
|
8545
|
+
"analytics",
|
|
8546
|
+
"marketing",
|
|
8547
|
+
"media"
|
|
8548
|
+
]
|
|
8549
|
+
}
|
|
8550
|
+
},
|
|
8551
|
+
"own_tool": {
|
|
8552
|
+
"type": [
|
|
8553
|
+
"string",
|
|
8554
|
+
"null"
|
|
8555
|
+
]
|
|
8556
|
+
},
|
|
8557
|
+
"custom_banner": {
|
|
8558
|
+
"type": "boolean"
|
|
8559
|
+
},
|
|
8560
|
+
"banners": {
|
|
8561
|
+
"type": "object",
|
|
8562
|
+
"propertyNames": {
|
|
8563
|
+
"type": "string"
|
|
8564
|
+
},
|
|
8565
|
+
"additionalProperties": {
|
|
8566
|
+
"type": "string"
|
|
8567
|
+
},
|
|
8568
|
+
"description": "The banner's markup, by language and categories."
|
|
8569
|
+
}
|
|
8570
|
+
},
|
|
8571
|
+
"required": [
|
|
8572
|
+
"build_id",
|
|
8573
|
+
"hash",
|
|
8574
|
+
"commit",
|
|
8575
|
+
"published_at",
|
|
8576
|
+
"revision",
|
|
8577
|
+
"third_parties",
|
|
8578
|
+
"unknown_hosts",
|
|
8579
|
+
"categories",
|
|
8580
|
+
"own_tool",
|
|
8581
|
+
"custom_banner",
|
|
8582
|
+
"banners"
|
|
8583
|
+
],
|
|
8584
|
+
"additionalProperties": false
|
|
8585
|
+
}
|
|
6487
8586
|
}
|
|
6488
8587
|
},
|
|
6489
8588
|
"required": [
|
|
6490
|
-
"
|
|
6491
|
-
"revoked"
|
|
8589
|
+
"versions"
|
|
6492
8590
|
],
|
|
6493
8591
|
"additionalProperties": false
|
|
6494
8592
|
},
|
|
@@ -6603,6 +8701,27 @@ export const API_OPERATIONS = [
|
|
|
6603
8701
|
"url": {
|
|
6604
8702
|
"type": "string"
|
|
6605
8703
|
},
|
|
8704
|
+
"platform_address": {
|
|
8705
|
+
"type": "object",
|
|
8706
|
+
"properties": {
|
|
8707
|
+
"slug": {
|
|
8708
|
+
"type": "string"
|
|
8709
|
+
},
|
|
8710
|
+
"domain": {
|
|
8711
|
+
"type": "string"
|
|
8712
|
+
},
|
|
8713
|
+
"is_main": {
|
|
8714
|
+
"type": "boolean"
|
|
8715
|
+
}
|
|
8716
|
+
},
|
|
8717
|
+
"required": [
|
|
8718
|
+
"slug",
|
|
8719
|
+
"domain",
|
|
8720
|
+
"is_main"
|
|
8721
|
+
],
|
|
8722
|
+
"additionalProperties": false,
|
|
8723
|
+
"description": "The address included with the site, which set_site_address changes. is_main: visitors land on it, no custom domain has taken over."
|
|
8724
|
+
},
|
|
6606
8725
|
"build": {
|
|
6607
8726
|
"anyOf": [
|
|
6608
8727
|
{
|
|
@@ -6845,6 +8964,7 @@ export const API_OPERATIONS = [
|
|
|
6845
8964
|
"required": [
|
|
6846
8965
|
"site_id",
|
|
6847
8966
|
"url",
|
|
8967
|
+
"platform_address",
|
|
6848
8968
|
"build",
|
|
6849
8969
|
"revision",
|
|
6850
8970
|
"draft_revision",
|
|
@@ -6993,6 +9113,26 @@ export const API_OPERATIONS = [
|
|
|
6993
9113
|
"minimum": -9007199254740991,
|
|
6994
9114
|
"maximum": 9007199254740991
|
|
6995
9115
|
},
|
|
9116
|
+
"warnings": {
|
|
9117
|
+
"type": "array",
|
|
9118
|
+
"items": {
|
|
9119
|
+
"type": "object",
|
|
9120
|
+
"properties": {
|
|
9121
|
+
"code": {
|
|
9122
|
+
"type": "string"
|
|
9123
|
+
},
|
|
9124
|
+
"message": {
|
|
9125
|
+
"type": "string"
|
|
9126
|
+
}
|
|
9127
|
+
},
|
|
9128
|
+
"required": [
|
|
9129
|
+
"code",
|
|
9130
|
+
"message"
|
|
9131
|
+
],
|
|
9132
|
+
"additionalProperties": false
|
|
9133
|
+
},
|
|
9134
|
+
"description": "What went live with something left out: an ignored `_redirects` line loses a moved page. Fix it and publish again."
|
|
9135
|
+
},
|
|
6996
9136
|
"built": {
|
|
6997
9137
|
"description": "True when the draft had to be built first.",
|
|
6998
9138
|
"type": "boolean"
|
|
@@ -7003,7 +9143,8 @@ export const API_OPERATIONS = [
|
|
|
7003
9143
|
"build_id",
|
|
7004
9144
|
"generation",
|
|
7005
9145
|
"url",
|
|
7006
|
-
"visible_within_seconds"
|
|
9146
|
+
"visible_within_seconds",
|
|
9147
|
+
"warnings"
|
|
7007
9148
|
],
|
|
7008
9149
|
"additionalProperties": false
|
|
7009
9150
|
},
|
|
@@ -7382,6 +9523,19 @@ export const API_OPERATIONS = [
|
|
|
7382
9523
|
"null"
|
|
7383
9524
|
]
|
|
7384
9525
|
},
|
|
9526
|
+
"version": {
|
|
9527
|
+
"anyOf": [
|
|
9528
|
+
{
|
|
9529
|
+
"type": "integer",
|
|
9530
|
+
"minimum": -9007199254740991,
|
|
9531
|
+
"maximum": 9007199254740991
|
|
9532
|
+
},
|
|
9533
|
+
{
|
|
9534
|
+
"type": "null"
|
|
9535
|
+
}
|
|
9536
|
+
],
|
|
9537
|
+
"description": "The number of the version this publication put online. Null when it took the site offline."
|
|
9538
|
+
},
|
|
7385
9539
|
"previous_build_id": {
|
|
7386
9540
|
"type": [
|
|
7387
9541
|
"string",
|
|
@@ -7401,6 +9555,7 @@ export const API_OPERATIONS = [
|
|
|
7401
9555
|
"generation",
|
|
7402
9556
|
"kind",
|
|
7403
9557
|
"build_id",
|
|
9558
|
+
"version",
|
|
7404
9559
|
"previous_build_id",
|
|
7405
9560
|
"author",
|
|
7406
9561
|
"created_at"
|
|
@@ -8000,7 +10155,114 @@ export const API_OPERATIONS = [
|
|
|
8000
10155
|
},
|
|
8001
10156
|
"required": [
|
|
8002
10157
|
"id",
|
|
8003
|
-
"message"
|
|
10158
|
+
"message"
|
|
10159
|
+
],
|
|
10160
|
+
"additionalProperties": false
|
|
10161
|
+
},
|
|
10162
|
+
"request_id": {
|
|
10163
|
+
"type": "string"
|
|
10164
|
+
}
|
|
10165
|
+
},
|
|
10166
|
+
"required": [
|
|
10167
|
+
"data",
|
|
10168
|
+
"request_id"
|
|
10169
|
+
]
|
|
10170
|
+
}
|
|
10171
|
+
}
|
|
10172
|
+
}
|
|
10173
|
+
},
|
|
10174
|
+
"400": {
|
|
10175
|
+
"$ref": "#/components/responses/Error400"
|
|
10176
|
+
},
|
|
10177
|
+
"401": {
|
|
10178
|
+
"$ref": "#/components/responses/Error401"
|
|
10179
|
+
},
|
|
10180
|
+
"402": {
|
|
10181
|
+
"$ref": "#/components/responses/Error402"
|
|
10182
|
+
},
|
|
10183
|
+
"403": {
|
|
10184
|
+
"$ref": "#/components/responses/Error403"
|
|
10185
|
+
},
|
|
10186
|
+
"404": {
|
|
10187
|
+
"$ref": "#/components/responses/Error404"
|
|
10188
|
+
},
|
|
10189
|
+
"409": {
|
|
10190
|
+
"$ref": "#/components/responses/Error409"
|
|
10191
|
+
},
|
|
10192
|
+
"410": {
|
|
10193
|
+
"$ref": "#/components/responses/Error410"
|
|
10194
|
+
},
|
|
10195
|
+
"413": {
|
|
10196
|
+
"$ref": "#/components/responses/Error413"
|
|
10197
|
+
},
|
|
10198
|
+
"422": {
|
|
10199
|
+
"$ref": "#/components/responses/Error422"
|
|
10200
|
+
},
|
|
10201
|
+
"429": {
|
|
10202
|
+
"$ref": "#/components/responses/Error429"
|
|
10203
|
+
},
|
|
10204
|
+
"500": {
|
|
10205
|
+
"$ref": "#/components/responses/Error500"
|
|
10206
|
+
},
|
|
10207
|
+
"503": {
|
|
10208
|
+
"$ref": "#/components/responses/Error503"
|
|
10209
|
+
}
|
|
10210
|
+
}
|
|
10211
|
+
},
|
|
10212
|
+
{
|
|
10213
|
+
"operation_id": "removeSiteDomain",
|
|
10214
|
+
"method": "DELETE",
|
|
10215
|
+
"path": "/v1/sites/{site_id}/domains/{domain_id}",
|
|
10216
|
+
"summary": "Remove a domain",
|
|
10217
|
+
"description": "The site stops answering on this domain within about a minute. Its atelier201.page address keeps working.",
|
|
10218
|
+
"authentication_required": true,
|
|
10219
|
+
"scope": "domains:write",
|
|
10220
|
+
"surfaces": {
|
|
10221
|
+
"cli": "atelier201 domains remove",
|
|
10222
|
+
"mcp": "remove_domain"
|
|
10223
|
+
},
|
|
10224
|
+
"parameters": [
|
|
10225
|
+
{
|
|
10226
|
+
"name": "site_id",
|
|
10227
|
+
"in": "path",
|
|
10228
|
+
"required": true,
|
|
10229
|
+
"schema": {
|
|
10230
|
+
"type": "string"
|
|
10231
|
+
},
|
|
10232
|
+
"description": "The site's id, or its slug (the address before .atelier201.page)."
|
|
10233
|
+
},
|
|
10234
|
+
{
|
|
10235
|
+
"name": "domain_id",
|
|
10236
|
+
"in": "path",
|
|
10237
|
+
"required": true,
|
|
10238
|
+
"schema": {
|
|
10239
|
+
"type": "string"
|
|
10240
|
+
}
|
|
10241
|
+
}
|
|
10242
|
+
],
|
|
10243
|
+
"request_body": null,
|
|
10244
|
+
"responses": {
|
|
10245
|
+
"200": {
|
|
10246
|
+
"description": "Remove a domain",
|
|
10247
|
+
"content": {
|
|
10248
|
+
"application/json": {
|
|
10249
|
+
"schema": {
|
|
10250
|
+
"type": "object",
|
|
10251
|
+
"properties": {
|
|
10252
|
+
"data": {
|
|
10253
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
10254
|
+
"type": "object",
|
|
10255
|
+
"properties": {
|
|
10256
|
+
"id": {
|
|
10257
|
+
"type": "string"
|
|
10258
|
+
},
|
|
10259
|
+
"removed": {
|
|
10260
|
+
"type": "boolean"
|
|
10261
|
+
}
|
|
10262
|
+
},
|
|
10263
|
+
"required": [
|
|
10264
|
+
"id",
|
|
10265
|
+
"removed"
|
|
8004
10266
|
],
|
|
8005
10267
|
"additionalProperties": false
|
|
8006
10268
|
},
|
|
@@ -8055,16 +10317,16 @@ export const API_OPERATIONS = [
|
|
|
8055
10317
|
}
|
|
8056
10318
|
},
|
|
8057
10319
|
{
|
|
8058
|
-
"operation_id": "
|
|
8059
|
-
"method": "
|
|
8060
|
-
"path": "/v1/sites/{site_id}/
|
|
8061
|
-
"summary": "
|
|
8062
|
-
"description": "
|
|
10320
|
+
"operation_id": "setSiteAddress",
|
|
10321
|
+
"method": "POST",
|
|
10322
|
+
"path": "/v1/sites/{site_id}/address",
|
|
10323
|
+
"summary": "Change the site's atelier201.page address",
|
|
10324
|
+
"description": "Moves the site to <slug>.atelier201.page. The address must be free. The previous one redirects here for 30 days (visitors keep their links) and only this site can take it back meanwhile. Existing preview links keep working. A live site whose main address this is gets a rebuild; publish it to finish. No credits.",
|
|
8063
10325
|
"authentication_required": true,
|
|
8064
10326
|
"scope": "domains:write",
|
|
8065
10327
|
"surfaces": {
|
|
8066
|
-
"cli": "atelier201 domains
|
|
8067
|
-
"mcp": "
|
|
10328
|
+
"cli": "atelier201 domains address",
|
|
10329
|
+
"mcp": "set_site_address"
|
|
8068
10330
|
},
|
|
8069
10331
|
"parameters": [
|
|
8070
10332
|
{
|
|
@@ -8075,20 +10337,34 @@ export const API_OPERATIONS = [
|
|
|
8075
10337
|
"type": "string"
|
|
8076
10338
|
},
|
|
8077
10339
|
"description": "The site's id, or its slug (the address before .atelier201.page)."
|
|
8078
|
-
},
|
|
8079
|
-
{
|
|
8080
|
-
"name": "domain_id",
|
|
8081
|
-
"in": "path",
|
|
8082
|
-
"required": true,
|
|
8083
|
-
"schema": {
|
|
8084
|
-
"type": "string"
|
|
8085
|
-
}
|
|
8086
10340
|
}
|
|
8087
10341
|
],
|
|
8088
|
-
"request_body":
|
|
10342
|
+
"request_body": {
|
|
10343
|
+
"required": true,
|
|
10344
|
+
"content": {
|
|
10345
|
+
"application/json": {
|
|
10346
|
+
"schema": {
|
|
10347
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
10348
|
+
"type": "object",
|
|
10349
|
+
"properties": {
|
|
10350
|
+
"slug": {
|
|
10351
|
+
"type": "string",
|
|
10352
|
+
"minLength": 3,
|
|
10353
|
+
"maxLength": 40,
|
|
10354
|
+
"description": "The new address: <slug>.atelier201.page. 3 to 40 lowercase letters, digits or single hyphens."
|
|
10355
|
+
}
|
|
10356
|
+
},
|
|
10357
|
+
"required": [
|
|
10358
|
+
"slug"
|
|
10359
|
+
],
|
|
10360
|
+
"additionalProperties": false
|
|
10361
|
+
}
|
|
10362
|
+
}
|
|
10363
|
+
}
|
|
10364
|
+
},
|
|
8089
10365
|
"responses": {
|
|
8090
10366
|
"200": {
|
|
8091
|
-
"description": "
|
|
10367
|
+
"description": "Change the site's atelier201.page address",
|
|
8092
10368
|
"content": {
|
|
8093
10369
|
"application/json": {
|
|
8094
10370
|
"schema": {
|
|
@@ -8098,16 +10374,200 @@ export const API_OPERATIONS = [
|
|
|
8098
10374
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
8099
10375
|
"type": "object",
|
|
8100
10376
|
"properties": {
|
|
8101
|
-
"
|
|
10377
|
+
"slug": {
|
|
8102
10378
|
"type": "string"
|
|
8103
10379
|
},
|
|
8104
|
-
"
|
|
8105
|
-
"type": "
|
|
10380
|
+
"hostname": {
|
|
10381
|
+
"type": "string"
|
|
10382
|
+
},
|
|
10383
|
+
"url": {
|
|
10384
|
+
"type": "string"
|
|
10385
|
+
},
|
|
10386
|
+
"previous_hostname": {
|
|
10387
|
+
"description": "The address given up. Null when the site already had this address.",
|
|
10388
|
+
"type": [
|
|
10389
|
+
"string",
|
|
10390
|
+
"null"
|
|
10391
|
+
]
|
|
10392
|
+
},
|
|
10393
|
+
"redirects_until": {
|
|
10394
|
+
"description": "Until when the previous address redirects here. Null when the site was never published: it had no visitors to redirect.",
|
|
10395
|
+
"type": [
|
|
10396
|
+
"string",
|
|
10397
|
+
"null"
|
|
10398
|
+
]
|
|
10399
|
+
},
|
|
10400
|
+
"rebuild": {
|
|
10401
|
+
"anyOf": [
|
|
10402
|
+
{
|
|
10403
|
+
"type": "object",
|
|
10404
|
+
"properties": {
|
|
10405
|
+
"id": {
|
|
10406
|
+
"type": "string"
|
|
10407
|
+
},
|
|
10408
|
+
"site_id": {
|
|
10409
|
+
"type": "string"
|
|
10410
|
+
},
|
|
10411
|
+
"revision": {
|
|
10412
|
+
"type": "string",
|
|
10413
|
+
"minLength": 40,
|
|
10414
|
+
"maxLength": 40,
|
|
10415
|
+
"description": "A Git commit id (40 hex characters) of the site's repository."
|
|
10416
|
+
},
|
|
10417
|
+
"state": {
|
|
10418
|
+
"type": "string",
|
|
10419
|
+
"enum": [
|
|
10420
|
+
"queued",
|
|
10421
|
+
"building",
|
|
10422
|
+
"collecting",
|
|
10423
|
+
"ready",
|
|
10424
|
+
"failed",
|
|
10425
|
+
"cancelled"
|
|
10426
|
+
]
|
|
10427
|
+
},
|
|
10428
|
+
"target_origin": {
|
|
10429
|
+
"type": "string"
|
|
10430
|
+
},
|
|
10431
|
+
"profile": {
|
|
10432
|
+
"type": "string",
|
|
10433
|
+
"enum": [
|
|
10434
|
+
"standard",
|
|
10435
|
+
"guest-demo"
|
|
10436
|
+
]
|
|
10437
|
+
},
|
|
10438
|
+
"file_count": {
|
|
10439
|
+
"anyOf": [
|
|
10440
|
+
{
|
|
10441
|
+
"type": "integer",
|
|
10442
|
+
"minimum": -9007199254740991,
|
|
10443
|
+
"maximum": 9007199254740991
|
|
10444
|
+
},
|
|
10445
|
+
{
|
|
10446
|
+
"type": "null"
|
|
10447
|
+
}
|
|
10448
|
+
]
|
|
10449
|
+
},
|
|
10450
|
+
"total_bytes": {
|
|
10451
|
+
"anyOf": [
|
|
10452
|
+
{
|
|
10453
|
+
"type": "integer",
|
|
10454
|
+
"minimum": -9007199254740991,
|
|
10455
|
+
"maximum": 9007199254740991
|
|
10456
|
+
},
|
|
10457
|
+
{
|
|
10458
|
+
"type": "null"
|
|
10459
|
+
}
|
|
10460
|
+
]
|
|
10461
|
+
},
|
|
10462
|
+
"duration_ms": {
|
|
10463
|
+
"anyOf": [
|
|
10464
|
+
{
|
|
10465
|
+
"type": "integer",
|
|
10466
|
+
"minimum": -9007199254740991,
|
|
10467
|
+
"maximum": 9007199254740991
|
|
10468
|
+
},
|
|
10469
|
+
{
|
|
10470
|
+
"type": "null"
|
|
10471
|
+
}
|
|
10472
|
+
]
|
|
10473
|
+
},
|
|
10474
|
+
"error": {
|
|
10475
|
+
"anyOf": [
|
|
10476
|
+
{
|
|
10477
|
+
"type": "object",
|
|
10478
|
+
"properties": {
|
|
10479
|
+
"code": {
|
|
10480
|
+
"type": "string"
|
|
10481
|
+
},
|
|
10482
|
+
"message": {
|
|
10483
|
+
"type": [
|
|
10484
|
+
"string",
|
|
10485
|
+
"null"
|
|
10486
|
+
]
|
|
10487
|
+
}
|
|
10488
|
+
},
|
|
10489
|
+
"required": [
|
|
10490
|
+
"code",
|
|
10491
|
+
"message"
|
|
10492
|
+
],
|
|
10493
|
+
"additionalProperties": false
|
|
10494
|
+
},
|
|
10495
|
+
{
|
|
10496
|
+
"type": "null"
|
|
10497
|
+
}
|
|
10498
|
+
]
|
|
10499
|
+
},
|
|
10500
|
+
"warnings": {
|
|
10501
|
+
"type": "array",
|
|
10502
|
+
"items": {
|
|
10503
|
+
"type": "string"
|
|
10504
|
+
}
|
|
10505
|
+
},
|
|
10506
|
+
"created_at": {
|
|
10507
|
+
"type": "string",
|
|
10508
|
+
"description": "ISO 8601, UTC."
|
|
10509
|
+
},
|
|
10510
|
+
"started_at": {
|
|
10511
|
+
"anyOf": [
|
|
10512
|
+
{
|
|
10513
|
+
"type": "string",
|
|
10514
|
+
"description": "ISO 8601, UTC."
|
|
10515
|
+
},
|
|
10516
|
+
{
|
|
10517
|
+
"type": "null"
|
|
10518
|
+
}
|
|
10519
|
+
]
|
|
10520
|
+
},
|
|
10521
|
+
"finished_at": {
|
|
10522
|
+
"anyOf": [
|
|
10523
|
+
{
|
|
10524
|
+
"type": "string",
|
|
10525
|
+
"description": "ISO 8601, UTC."
|
|
10526
|
+
},
|
|
10527
|
+
{
|
|
10528
|
+
"type": "null"
|
|
10529
|
+
}
|
|
10530
|
+
]
|
|
10531
|
+
}
|
|
10532
|
+
},
|
|
10533
|
+
"required": [
|
|
10534
|
+
"id",
|
|
10535
|
+
"site_id",
|
|
10536
|
+
"revision",
|
|
10537
|
+
"state",
|
|
10538
|
+
"target_origin",
|
|
10539
|
+
"profile",
|
|
10540
|
+
"file_count",
|
|
10541
|
+
"total_bytes",
|
|
10542
|
+
"duration_ms",
|
|
10543
|
+
"error",
|
|
10544
|
+
"warnings",
|
|
10545
|
+
"created_at",
|
|
10546
|
+
"started_at",
|
|
10547
|
+
"finished_at"
|
|
10548
|
+
],
|
|
10549
|
+
"additionalProperties": false
|
|
10550
|
+
},
|
|
10551
|
+
{
|
|
10552
|
+
"type": "null"
|
|
10553
|
+
}
|
|
10554
|
+
]
|
|
10555
|
+
},
|
|
10556
|
+
"next_action": {
|
|
10557
|
+
"type": [
|
|
10558
|
+
"string",
|
|
10559
|
+
"null"
|
|
10560
|
+
]
|
|
8106
10561
|
}
|
|
8107
10562
|
},
|
|
8108
10563
|
"required": [
|
|
8109
|
-
"
|
|
8110
|
-
"
|
|
10564
|
+
"slug",
|
|
10565
|
+
"hostname",
|
|
10566
|
+
"url",
|
|
10567
|
+
"previous_hostname",
|
|
10568
|
+
"redirects_until",
|
|
10569
|
+
"rebuild",
|
|
10570
|
+
"next_action"
|
|
8111
10571
|
],
|
|
8112
10572
|
"additionalProperties": false
|
|
8113
10573
|
},
|
|
@@ -12593,7 +15053,7 @@ export const API_OPERATIONS = [
|
|
|
12593
15053
|
"method": "POST",
|
|
12594
15054
|
"path": "/v1/guest/sites/{site_id}/builds",
|
|
12595
15055
|
"summary": "Build a guest site",
|
|
12596
|
-
"description": "Authorization: Guest <write_token>. Builds the guest site (3 builds per guest site). Then poll its status for the demo URL.",
|
|
15056
|
+
"description": "Authorization: Guest <write_token>. Builds the guest site (3 builds per guest site). Then poll its status for the demo URL. One build runs at a time: `is_requested_revision` false means `build` is an earlier version, so wait for it to end and call this again.",
|
|
12597
15057
|
"authentication_required": false,
|
|
12598
15058
|
"scope": null,
|
|
12599
15059
|
"surfaces": {
|
|
@@ -12628,6 +15088,10 @@ export const API_OPERATIONS = [
|
|
|
12628
15088
|
"reused": {
|
|
12629
15089
|
"type": "boolean"
|
|
12630
15090
|
},
|
|
15091
|
+
"is_requested_revision": {
|
|
15092
|
+
"type": "boolean",
|
|
15093
|
+
"description": "False when `build` is an earlier version already running."
|
|
15094
|
+
},
|
|
12631
15095
|
"next_action": {
|
|
12632
15096
|
"type": "string"
|
|
12633
15097
|
}
|
|
@@ -12635,6 +15099,7 @@ export const API_OPERATIONS = [
|
|
|
12635
15099
|
"required": [
|
|
12636
15100
|
"build",
|
|
12637
15101
|
"reused",
|
|
15102
|
+
"is_requested_revision",
|
|
12638
15103
|
"next_action"
|
|
12639
15104
|
],
|
|
12640
15105
|
"additionalProperties": false
|