@andesine/sdk 0.9.0 → 0.11.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/CHANGELOG.md +6 -0
- package/README.md +17 -951
- package/dist/client-C_F2KykP.js.map +1 -1
- package/dist/{client-54DXm4mG.d.ts → client-D05pLeGK.d.ts} +4 -4
- package/dist/extensions.d.ts +1 -1
- package/dist/{index-DFu0YVlp.d.ts → index-B5TxEKQ8.d.ts} +3 -3
- package/dist/index.d.ts +3 -3
- package/dist/{schema-DBHoDzsT.d.ts → schema-D-r9v91o.d.ts} +3 -3
- package/dist/streaming.d.ts +1 -1
- package/dist/webhooks.d.ts +1 -1
- package/openapi.json +649 -82
- package/package.json +2 -2
package/openapi.json
CHANGED
|
@@ -4385,7 +4385,14 @@
|
|
|
4385
4385
|
}
|
|
4386
4386
|
}
|
|
4387
4387
|
},
|
|
4388
|
-
"x-sdk-example": { "query": "mountains", "limit": 10 }
|
|
4388
|
+
"x-sdk-example": { "query": "mountains", "limit": 10 },
|
|
4389
|
+
"x-codeSamples": [
|
|
4390
|
+
{
|
|
4391
|
+
"lang": "typescript",
|
|
4392
|
+
"label": "SDK",
|
|
4393
|
+
"source": "import { createClient } from \"@andesine/sdk\";\n\nconst client = createClient({ apiKey: process.env.ANDESINE_API_KEY });\n\nawait client.assets.search({\n query: \"mountains\",\n limit: 10\n});"
|
|
4394
|
+
}
|
|
4395
|
+
]
|
|
4389
4396
|
}
|
|
4390
4397
|
},
|
|
4391
4398
|
"/assets/imports": {
|
|
@@ -4748,7 +4755,14 @@
|
|
|
4748
4755
|
"entryID": "ent_example",
|
|
4749
4756
|
"url": "https://example.com/image.png",
|
|
4750
4757
|
"checkDuplicates": true
|
|
4751
|
-
}
|
|
4758
|
+
},
|
|
4759
|
+
"x-codeSamples": [
|
|
4760
|
+
{
|
|
4761
|
+
"lang": "typescript",
|
|
4762
|
+
"label": "SDK",
|
|
4763
|
+
"source": "import { createClient } from \"@andesine/sdk\";\n\nconst client = createClient({ apiKey: process.env.ANDESINE_API_KEY });\n\nawait client.assets.importURL({\n assetID: \"ast_example\",\n entryID: \"ent_example\",\n url: \"https://example.com/image.png\",\n checkDuplicates: true\n});"
|
|
4764
|
+
}
|
|
4765
|
+
]
|
|
4752
4766
|
}
|
|
4753
4767
|
},
|
|
4754
4768
|
"/assets/uploads": {
|
|
@@ -5102,7 +5116,14 @@
|
|
|
5102
5116
|
"filename": "image.png",
|
|
5103
5117
|
"byteSize": 1024,
|
|
5104
5118
|
"checksum": "0000000000000000000000000000000000000000000000000000000000000000"
|
|
5105
|
-
}
|
|
5119
|
+
},
|
|
5120
|
+
"x-codeSamples": [
|
|
5121
|
+
{
|
|
5122
|
+
"lang": "typescript",
|
|
5123
|
+
"label": "SDK",
|
|
5124
|
+
"source": "import { createClient } from \"@andesine/sdk\";\n\nconst client = createClient({ apiKey: process.env.ANDESINE_API_KEY });\n\nawait client.assets.register({\n assetID: \"ast_example\",\n entryID: \"ent_example\",\n filename: \"image.png\",\n byteSize: 1024,\n checksum: \"0000000000000000000000000000000000000000000000000000000000000000\"\n});"
|
|
5125
|
+
}
|
|
5126
|
+
]
|
|
5106
5127
|
}
|
|
5107
5128
|
},
|
|
5108
5129
|
"/assets/{assetID}/upload": {
|
|
@@ -5445,7 +5466,14 @@
|
|
|
5445
5466
|
}
|
|
5446
5467
|
}
|
|
5447
5468
|
},
|
|
5448
|
-
"x-sdk-example": { "assetID": "ast_example", "file": "<binary file>" }
|
|
5469
|
+
"x-sdk-example": { "assetID": "ast_example", "file": "<binary file>" },
|
|
5470
|
+
"x-codeSamples": [
|
|
5471
|
+
{
|
|
5472
|
+
"lang": "typescript",
|
|
5473
|
+
"label": "SDK",
|
|
5474
|
+
"source": "import { createClient } from \"@andesine/sdk\";\n\nconst client = createClient({ apiKey: process.env.ANDESINE_API_KEY });\n\nawait client.assets.upload({\n assetID: \"ast_example\",\n file: new Blob([imageBytes], { type: \"image/png\" })\n});"
|
|
5475
|
+
}
|
|
5476
|
+
]
|
|
5449
5477
|
}
|
|
5450
5478
|
},
|
|
5451
5479
|
"/assets/{assetID}": {
|
|
@@ -5753,7 +5781,14 @@
|
|
|
5753
5781
|
}
|
|
5754
5782
|
}
|
|
5755
5783
|
},
|
|
5756
|
-
"x-sdk-example": { "assetID": "ast_example", "entryID": "ent_example" }
|
|
5784
|
+
"x-sdk-example": { "assetID": "ast_example", "entryID": "ent_example" },
|
|
5785
|
+
"x-codeSamples": [
|
|
5786
|
+
{
|
|
5787
|
+
"lang": "typescript",
|
|
5788
|
+
"label": "SDK",
|
|
5789
|
+
"source": "import { createClient } from \"@andesine/sdk\";\n\nconst client = createClient({ apiKey: process.env.ANDESINE_API_KEY });\n\nawait client.assets.get({\n assetID: \"ast_example\",\n entryID: \"ent_example\"\n});"
|
|
5790
|
+
}
|
|
5791
|
+
]
|
|
5757
5792
|
}
|
|
5758
5793
|
},
|
|
5759
5794
|
"/identity": {
|
|
@@ -6323,7 +6358,14 @@
|
|
|
6323
6358
|
"description": "Required for OAuth: ID of the workspace to access. API keys use their own workspace."
|
|
6324
6359
|
}
|
|
6325
6360
|
],
|
|
6326
|
-
"x-sdk-example": {}
|
|
6361
|
+
"x-sdk-example": {},
|
|
6362
|
+
"x-codeSamples": [
|
|
6363
|
+
{
|
|
6364
|
+
"lang": "typescript",
|
|
6365
|
+
"label": "SDK",
|
|
6366
|
+
"source": "import { createClient } from \"@andesine/sdk\";\n\nconst client = createClient({ apiKey: process.env.ANDESINE_API_KEY });\n\nawait client.instance.get({});"
|
|
6367
|
+
}
|
|
6368
|
+
]
|
|
6327
6369
|
}
|
|
6328
6370
|
},
|
|
6329
6371
|
"/entries": {
|
|
@@ -6863,7 +6905,14 @@
|
|
|
6863
6905
|
"description": "Required for OAuth: ID of the workspace to access. API keys use their own workspace."
|
|
6864
6906
|
}
|
|
6865
6907
|
],
|
|
6866
|
-
"x-sdk-example": { "name": "Getting started", "collectionID": "coll_example" }
|
|
6908
|
+
"x-sdk-example": { "name": "Getting started", "collectionID": "coll_example" },
|
|
6909
|
+
"x-codeSamples": [
|
|
6910
|
+
{
|
|
6911
|
+
"lang": "typescript",
|
|
6912
|
+
"label": "SDK",
|
|
6913
|
+
"source": "import { createClient } from \"@andesine/sdk\";\n\nconst client = createClient({ apiKey: process.env.ANDESINE_API_KEY });\n\nawait client.entries.create({\n name: \"Getting started\",\n collectionID: \"coll_example\"\n});"
|
|
6914
|
+
}
|
|
6915
|
+
]
|
|
6867
6916
|
}
|
|
6868
6917
|
},
|
|
6869
6918
|
"/entries/bulk/delete": {
|
|
@@ -7197,7 +7246,14 @@
|
|
|
7197
7246
|
"description": "Required for OAuth: ID of the workspace to access. API keys use their own workspace."
|
|
7198
7247
|
}
|
|
7199
7248
|
],
|
|
7200
|
-
"x-sdk-example": { "ids": ["ent_example"] }
|
|
7249
|
+
"x-sdk-example": { "ids": ["ent_example"] },
|
|
7250
|
+
"x-codeSamples": [
|
|
7251
|
+
{
|
|
7252
|
+
"lang": "typescript",
|
|
7253
|
+
"label": "SDK",
|
|
7254
|
+
"source": "import { createClient } from \"@andesine/sdk\";\n\nconst client = createClient({ apiKey: process.env.ANDESINE_API_KEY });\n\nawait client.entries.bulkDelete({\n ids: [\n \"ent_example\"\n ]\n});"
|
|
7255
|
+
}
|
|
7256
|
+
]
|
|
7201
7257
|
}
|
|
7202
7258
|
},
|
|
7203
7259
|
"/entries/{id}": {
|
|
@@ -7519,7 +7575,14 @@
|
|
|
7519
7575
|
}
|
|
7520
7576
|
}
|
|
7521
7577
|
},
|
|
7522
|
-
"x-sdk-example": { "id": "ent_example" }
|
|
7578
|
+
"x-sdk-example": { "id": "ent_example" },
|
|
7579
|
+
"x-codeSamples": [
|
|
7580
|
+
{
|
|
7581
|
+
"lang": "typescript",
|
|
7582
|
+
"label": "SDK",
|
|
7583
|
+
"source": "import { createClient } from \"@andesine/sdk\";\n\nconst client = createClient({ apiKey: process.env.ANDESINE_API_KEY });\n\nawait client.entries.delete({\n id: \"ent_example\"\n});"
|
|
7584
|
+
}
|
|
7585
|
+
]
|
|
7523
7586
|
},
|
|
7524
7587
|
"put": {
|
|
7525
7588
|
"operationId": "entries.update",
|
|
@@ -8240,7 +8303,14 @@
|
|
|
8240
8303
|
}
|
|
8241
8304
|
},
|
|
8242
8305
|
"x-idempotent": true,
|
|
8243
|
-
"x-sdk-example": { "id": "ent_example", "name": "Installation" }
|
|
8306
|
+
"x-sdk-example": { "id": "ent_example", "name": "Installation" },
|
|
8307
|
+
"x-codeSamples": [
|
|
8308
|
+
{
|
|
8309
|
+
"lang": "typescript",
|
|
8310
|
+
"label": "SDK",
|
|
8311
|
+
"source": "import { createClient } from \"@andesine/sdk\";\n\nconst client = createClient({ apiKey: process.env.ANDESINE_API_KEY });\n\nawait client.entries.update({\n id: \"ent_example\",\n name: \"Installation\"\n});"
|
|
8312
|
+
}
|
|
8313
|
+
]
|
|
8244
8314
|
}
|
|
8245
8315
|
},
|
|
8246
8316
|
"/entries/bulk/update": {
|
|
@@ -8995,7 +9065,14 @@
|
|
|
8995
9065
|
"operations": [{ "type": "replaceText", "find": "v1", "replace": "v2" }]
|
|
8996
9066
|
}
|
|
8997
9067
|
]
|
|
8998
|
-
}
|
|
9068
|
+
},
|
|
9069
|
+
"x-codeSamples": [
|
|
9070
|
+
{
|
|
9071
|
+
"lang": "typescript",
|
|
9072
|
+
"label": "SDK",
|
|
9073
|
+
"source": "import { createClient } from \"@andesine/sdk\";\n\nconst client = createClient({ apiKey: process.env.ANDESINE_API_KEY });\n\nawait client.entries.bulkUpdate({\n items: [\n {\n id: \"ent_example\",\n operations: [\n {\n type: \"replaceText\",\n find: \"v1\",\n replace: \"v2\"\n }\n ]\n }\n ]\n});"
|
|
9074
|
+
}
|
|
9075
|
+
]
|
|
8999
9076
|
}
|
|
9000
9077
|
},
|
|
9001
9078
|
"/entries/{id}/move": {
|
|
@@ -9402,7 +9479,14 @@
|
|
|
9402
9479
|
}
|
|
9403
9480
|
}
|
|
9404
9481
|
},
|
|
9405
|
-
"x-sdk-example": { "id": "ent_example", "collectionID": "coll_example" }
|
|
9482
|
+
"x-sdk-example": { "id": "ent_example", "collectionID": "coll_example" },
|
|
9483
|
+
"x-codeSamples": [
|
|
9484
|
+
{
|
|
9485
|
+
"lang": "typescript",
|
|
9486
|
+
"label": "SDK",
|
|
9487
|
+
"source": "import { createClient } from \"@andesine/sdk\";\n\nconst client = createClient({ apiKey: process.env.ANDESINE_API_KEY });\n\nawait client.entries.move({\n id: \"ent_example\",\n collectionID: \"coll_example\"\n});"
|
|
9488
|
+
}
|
|
9489
|
+
]
|
|
9406
9490
|
}
|
|
9407
9491
|
},
|
|
9408
9492
|
"/entries/bulk/move": {
|
|
@@ -9825,7 +9909,14 @@
|
|
|
9825
9909
|
"description": "Required for OAuth: ID of the workspace to access. API keys use their own workspace."
|
|
9826
9910
|
}
|
|
9827
9911
|
],
|
|
9828
|
-
"x-sdk-example": { "items": [{ "id": "ent_example", "collectionPath": "/Guides" }] }
|
|
9912
|
+
"x-sdk-example": { "items": [{ "id": "ent_example", "collectionPath": "/Guides" }] },
|
|
9913
|
+
"x-codeSamples": [
|
|
9914
|
+
{
|
|
9915
|
+
"lang": "typescript",
|
|
9916
|
+
"label": "SDK",
|
|
9917
|
+
"source": "import { createClient } from \"@andesine/sdk\";\n\nconst client = createClient({ apiKey: process.env.ANDESINE_API_KEY });\n\nawait client.entries.bulkMove({\n items: [\n {\n id: \"ent_example\",\n collectionPath: \"/Guides\"\n }\n ]\n});"
|
|
9918
|
+
}
|
|
9919
|
+
]
|
|
9829
9920
|
}
|
|
9830
9921
|
},
|
|
9831
9922
|
"/entries/get": {
|
|
@@ -10306,7 +10397,14 @@
|
|
|
10306
10397
|
}
|
|
10307
10398
|
}
|
|
10308
10399
|
},
|
|
10309
|
-
"x-sdk-example": { "id": "ent_example" }
|
|
10400
|
+
"x-sdk-example": { "id": "ent_example" },
|
|
10401
|
+
"x-codeSamples": [
|
|
10402
|
+
{
|
|
10403
|
+
"lang": "typescript",
|
|
10404
|
+
"label": "SDK",
|
|
10405
|
+
"source": "import { createClient } from \"@andesine/sdk\";\n\nconst client = createClient({ apiKey: process.env.ANDESINE_API_KEY });\n\nawait client.entries.get({\n id: \"ent_example\"\n});"
|
|
10406
|
+
}
|
|
10407
|
+
]
|
|
10310
10408
|
}
|
|
10311
10409
|
},
|
|
10312
10410
|
"/entries/list": {
|
|
@@ -10651,7 +10749,14 @@
|
|
|
10651
10749
|
}
|
|
10652
10750
|
}
|
|
10653
10751
|
},
|
|
10654
|
-
"x-sdk-example": { "collectionID": "coll_example", "limit": 20 }
|
|
10752
|
+
"x-sdk-example": { "collectionID": "coll_example", "limit": 20 },
|
|
10753
|
+
"x-codeSamples": [
|
|
10754
|
+
{
|
|
10755
|
+
"lang": "typescript",
|
|
10756
|
+
"label": "SDK",
|
|
10757
|
+
"source": "import { createClient } from \"@andesine/sdk\";\n\nconst client = createClient({ apiKey: process.env.ANDESINE_API_KEY });\n\nawait client.entries.list({\n collectionID: \"coll_example\",\n limit: 20\n});"
|
|
10758
|
+
}
|
|
10759
|
+
]
|
|
10655
10760
|
}
|
|
10656
10761
|
},
|
|
10657
10762
|
"/extensions/self": {
|
|
@@ -18136,7 +18241,14 @@
|
|
|
18136
18241
|
"description": "Required for OAuth: ID of the workspace to access. API keys use their own workspace."
|
|
18137
18242
|
}
|
|
18138
18243
|
],
|
|
18139
|
-
"x-sdk-example": { "name": "Documentation", "parentID": "coll_example" }
|
|
18244
|
+
"x-sdk-example": { "name": "Documentation", "parentID": "coll_example" },
|
|
18245
|
+
"x-codeSamples": [
|
|
18246
|
+
{
|
|
18247
|
+
"lang": "typescript",
|
|
18248
|
+
"label": "SDK",
|
|
18249
|
+
"source": "import { createClient } from \"@andesine/sdk\";\n\nconst client = createClient({ apiKey: process.env.ANDESINE_API_KEY });\n\nawait client.collections.create({\n name: \"Documentation\",\n parentID: \"coll_example\"\n});"
|
|
18250
|
+
}
|
|
18251
|
+
]
|
|
18140
18252
|
}
|
|
18141
18253
|
},
|
|
18142
18254
|
"/collections/bulk/delete": {
|
|
@@ -18470,7 +18582,14 @@
|
|
|
18470
18582
|
"description": "Required for OAuth: ID of the workspace to access. API keys use their own workspace."
|
|
18471
18583
|
}
|
|
18472
18584
|
],
|
|
18473
|
-
"x-sdk-example": { "ids": ["coll_example"] }
|
|
18585
|
+
"x-sdk-example": { "ids": ["coll_example"] },
|
|
18586
|
+
"x-codeSamples": [
|
|
18587
|
+
{
|
|
18588
|
+
"lang": "typescript",
|
|
18589
|
+
"label": "SDK",
|
|
18590
|
+
"source": "import { createClient } from \"@andesine/sdk\";\n\nconst client = createClient({ apiKey: process.env.ANDESINE_API_KEY });\n\nawait client.collections.bulkDelete({\n ids: [\n \"coll_example\"\n ]\n});"
|
|
18591
|
+
}
|
|
18592
|
+
]
|
|
18474
18593
|
}
|
|
18475
18594
|
},
|
|
18476
18595
|
"/collections/{id}": {
|
|
@@ -18792,7 +18911,14 @@
|
|
|
18792
18911
|
}
|
|
18793
18912
|
}
|
|
18794
18913
|
},
|
|
18795
|
-
"x-sdk-example": { "id": "coll_example" }
|
|
18914
|
+
"x-sdk-example": { "id": "coll_example" },
|
|
18915
|
+
"x-codeSamples": [
|
|
18916
|
+
{
|
|
18917
|
+
"lang": "typescript",
|
|
18918
|
+
"label": "SDK",
|
|
18919
|
+
"source": "import { createClient } from \"@andesine/sdk\";\n\nconst client = createClient({ apiKey: process.env.ANDESINE_API_KEY });\n\nawait client.collections.delete({\n id: \"coll_example\"\n});"
|
|
18920
|
+
}
|
|
18921
|
+
]
|
|
18796
18922
|
},
|
|
18797
18923
|
"put": {
|
|
18798
18924
|
"operationId": "collections.update",
|
|
@@ -19170,7 +19296,14 @@
|
|
|
19170
19296
|
}
|
|
19171
19297
|
}
|
|
19172
19298
|
},
|
|
19173
|
-
"x-sdk-example": { "id": "coll_example", "name": "Guides" }
|
|
19299
|
+
"x-sdk-example": { "id": "coll_example", "name": "Guides" },
|
|
19300
|
+
"x-codeSamples": [
|
|
19301
|
+
{
|
|
19302
|
+
"lang": "typescript",
|
|
19303
|
+
"label": "SDK",
|
|
19304
|
+
"source": "import { createClient } from \"@andesine/sdk\";\n\nconst client = createClient({ apiKey: process.env.ANDESINE_API_KEY });\n\nawait client.collections.update({\n id: \"coll_example\",\n name: \"Guides\"\n});"
|
|
19305
|
+
}
|
|
19306
|
+
]
|
|
19174
19307
|
}
|
|
19175
19308
|
},
|
|
19176
19309
|
"/collections/{id}/move": {
|
|
@@ -19579,7 +19712,14 @@
|
|
|
19579
19712
|
}
|
|
19580
19713
|
}
|
|
19581
19714
|
},
|
|
19582
|
-
"x-sdk-example": { "id": "coll_example", "newParentID": "coll_parent" }
|
|
19715
|
+
"x-sdk-example": { "id": "coll_example", "newParentID": "coll_parent" },
|
|
19716
|
+
"x-codeSamples": [
|
|
19717
|
+
{
|
|
19718
|
+
"lang": "typescript",
|
|
19719
|
+
"label": "SDK",
|
|
19720
|
+
"source": "import { createClient } from \"@andesine/sdk\";\n\nconst client = createClient({ apiKey: process.env.ANDESINE_API_KEY });\n\nawait client.collections.move({\n id: \"coll_example\",\n newParentID: \"coll_parent\"\n});"
|
|
19721
|
+
}
|
|
19722
|
+
]
|
|
19583
19723
|
}
|
|
19584
19724
|
},
|
|
19585
19725
|
"/collections/get": {
|
|
@@ -19897,7 +20037,14 @@
|
|
|
19897
20037
|
}
|
|
19898
20038
|
}
|
|
19899
20039
|
},
|
|
19900
|
-
"x-sdk-example": { "collectionID": "coll_example" }
|
|
20040
|
+
"x-sdk-example": { "collectionID": "coll_example" },
|
|
20041
|
+
"x-codeSamples": [
|
|
20042
|
+
{
|
|
20043
|
+
"lang": "typescript",
|
|
20044
|
+
"label": "SDK",
|
|
20045
|
+
"source": "import { createClient } from \"@andesine/sdk\";\n\nconst client = createClient({ apiKey: process.env.ANDESINE_API_KEY });\n\nawait client.collections.get({\n collectionID: \"coll_example\"\n});"
|
|
20046
|
+
}
|
|
20047
|
+
]
|
|
19901
20048
|
}
|
|
19902
20049
|
},
|
|
19903
20050
|
"/collections/list": {
|
|
@@ -20242,7 +20389,14 @@
|
|
|
20242
20389
|
}
|
|
20243
20390
|
}
|
|
20244
20391
|
},
|
|
20245
|
-
"x-sdk-example": { "collectionID": "coll_example", "limit": 20 }
|
|
20392
|
+
"x-sdk-example": { "collectionID": "coll_example", "limit": 20 },
|
|
20393
|
+
"x-codeSamples": [
|
|
20394
|
+
{
|
|
20395
|
+
"lang": "typescript",
|
|
20396
|
+
"label": "SDK",
|
|
20397
|
+
"source": "import { createClient } from \"@andesine/sdk\";\n\nconst client = createClient({ apiKey: process.env.ANDESINE_API_KEY });\n\nawait client.collections.list({\n collectionID: \"coll_example\",\n limit: 20\n});"
|
|
20398
|
+
}
|
|
20399
|
+
]
|
|
20246
20400
|
}
|
|
20247
20401
|
},
|
|
20248
20402
|
"/content/collections": {
|
|
@@ -20614,7 +20768,14 @@
|
|
|
20614
20768
|
}
|
|
20615
20769
|
}
|
|
20616
20770
|
},
|
|
20617
|
-
"x-sdk-example": { "channel": "published", "limit": 20 }
|
|
20771
|
+
"x-sdk-example": { "channel": "published", "limit": 20 },
|
|
20772
|
+
"x-codeSamples": [
|
|
20773
|
+
{
|
|
20774
|
+
"lang": "typescript",
|
|
20775
|
+
"label": "SDK",
|
|
20776
|
+
"source": "import { createClient } from \"@andesine/sdk\";\n\nconst client = createClient({ apiKey: process.env.ANDESINE_API_KEY });\n\nawait client.content.listCollections({\n channel: \"published\",\n limit: 20\n});"
|
|
20777
|
+
}
|
|
20778
|
+
]
|
|
20618
20779
|
}
|
|
20619
20780
|
},
|
|
20620
20781
|
"/content/entries": {
|
|
@@ -21032,7 +21193,14 @@
|
|
|
21032
21193
|
}
|
|
21033
21194
|
}
|
|
21034
21195
|
},
|
|
21035
|
-
"x-sdk-example": { "channel": "published", "limit": 20 }
|
|
21196
|
+
"x-sdk-example": { "channel": "published", "limit": 20 },
|
|
21197
|
+
"x-codeSamples": [
|
|
21198
|
+
{
|
|
21199
|
+
"lang": "typescript",
|
|
21200
|
+
"label": "SDK",
|
|
21201
|
+
"source": "import { createClient } from \"@andesine/sdk\";\n\nconst client = createClient({ apiKey: process.env.ANDESINE_API_KEY });\n\nawait client.content.listEntries({\n channel: \"published\",\n limit: 20\n});"
|
|
21202
|
+
}
|
|
21203
|
+
]
|
|
21036
21204
|
}
|
|
21037
21205
|
},
|
|
21038
21206
|
"/content/entries/schema": {
|
|
@@ -21382,7 +21550,14 @@
|
|
|
21382
21550
|
}
|
|
21383
21551
|
}
|
|
21384
21552
|
},
|
|
21385
|
-
"x-sdk-example": { "entryID": "ent_example", "channel": "published" }
|
|
21553
|
+
"x-sdk-example": { "entryID": "ent_example", "channel": "published" },
|
|
21554
|
+
"x-codeSamples": [
|
|
21555
|
+
{
|
|
21556
|
+
"lang": "typescript",
|
|
21557
|
+
"label": "SDK",
|
|
21558
|
+
"source": "import { createClient } from \"@andesine/sdk\";\n\nconst client = createClient({ apiKey: process.env.ANDESINE_API_KEY });\n\nawait client.content.getSchema({\n entryID: \"ent_example\",\n channel: \"published\"\n});"
|
|
21559
|
+
}
|
|
21560
|
+
]
|
|
21386
21561
|
}
|
|
21387
21562
|
},
|
|
21388
21563
|
"/content/assets/{workspaceID}/{snapshotID}/{entryID}/{assetID}/{variant}": {
|
|
@@ -21710,6 +21885,13 @@
|
|
|
21710
21885
|
"assetID": "ast_example",
|
|
21711
21886
|
"variant": "display"
|
|
21712
21887
|
},
|
|
21888
|
+
"x-codeSamples": [
|
|
21889
|
+
{
|
|
21890
|
+
"lang": "typescript",
|
|
21891
|
+
"label": "SDK",
|
|
21892
|
+
"source": "import { createClient } from \"@andesine/sdk\";\n\nconst client = createClient({ apiKey: process.env.ANDESINE_API_KEY });\n\nawait client.content.getAsset({\n workspaceID: \"ws_example\",\n snapshotID: \"snp_example\",\n entryID: \"ent_example\",\n assetID: \"ast_example\",\n variant: \"display\"\n});"
|
|
21893
|
+
}
|
|
21894
|
+
],
|
|
21713
21895
|
"security": []
|
|
21714
21896
|
}
|
|
21715
21897
|
},
|
|
@@ -22106,7 +22288,14 @@
|
|
|
22106
22288
|
}
|
|
22107
22289
|
}
|
|
22108
22290
|
},
|
|
22109
|
-
"x-sdk-example": { "entryID": "ent_example", "channel": "published" }
|
|
22291
|
+
"x-sdk-example": { "entryID": "ent_example", "channel": "published" },
|
|
22292
|
+
"x-codeSamples": [
|
|
22293
|
+
{
|
|
22294
|
+
"lang": "typescript",
|
|
22295
|
+
"label": "SDK",
|
|
22296
|
+
"source": "import { createClient } from \"@andesine/sdk\";\n\nconst client = createClient({ apiKey: process.env.ANDESINE_API_KEY });\n\nawait client.content.get({\n entryID: \"ent_example\",\n channel: \"published\"\n});"
|
|
22297
|
+
}
|
|
22298
|
+
]
|
|
22110
22299
|
}
|
|
22111
22300
|
},
|
|
22112
22301
|
"/content/tree": {
|
|
@@ -22458,7 +22647,14 @@
|
|
|
22458
22647
|
}
|
|
22459
22648
|
}
|
|
22460
22649
|
},
|
|
22461
|
-
"x-sdk-example": { "collectionID": "coll_example", "channel": "published" }
|
|
22650
|
+
"x-sdk-example": { "collectionID": "coll_example", "channel": "published" },
|
|
22651
|
+
"x-codeSamples": [
|
|
22652
|
+
{
|
|
22653
|
+
"lang": "typescript",
|
|
22654
|
+
"label": "SDK",
|
|
22655
|
+
"source": "import { createClient } from \"@andesine/sdk\";\n\nconst client = createClient({ apiKey: process.env.ANDESINE_API_KEY });\n\nawait client.content.getTree({\n collectionID: \"coll_example\",\n channel: \"published\"\n});"
|
|
22656
|
+
}
|
|
22657
|
+
]
|
|
22462
22658
|
}
|
|
22463
22659
|
},
|
|
22464
22660
|
"/webhooks": {
|
|
@@ -27618,7 +27814,14 @@
|
|
|
27618
27814
|
"description": "Required for OAuth: ID of the workspace to access. API keys use their own workspace."
|
|
27619
27815
|
}
|
|
27620
27816
|
],
|
|
27621
|
-
"x-sdk-example": {}
|
|
27817
|
+
"x-sdk-example": {},
|
|
27818
|
+
"x-codeSamples": [
|
|
27819
|
+
{
|
|
27820
|
+
"lang": "typescript",
|
|
27821
|
+
"label": "SDK",
|
|
27822
|
+
"source": "import { createClient } from \"@andesine/sdk\";\n\nconst client = createClient({ apiKey: process.env.ANDESINE_API_KEY });\n\nawait client.roles.list({});"
|
|
27823
|
+
}
|
|
27824
|
+
]
|
|
27622
27825
|
},
|
|
27623
27826
|
"post": {
|
|
27624
27827
|
"operationId": "roles.create",
|
|
@@ -27946,7 +28149,14 @@
|
|
|
27946
28149
|
"description": "Required for OAuth: ID of the workspace to access. API keys use their own workspace."
|
|
27947
28150
|
}
|
|
27948
28151
|
],
|
|
27949
|
-
"x-sdk-example": { "name": "Editor", "permissions": ["content"] }
|
|
28152
|
+
"x-sdk-example": { "name": "Editor", "permissions": ["content"] },
|
|
28153
|
+
"x-codeSamples": [
|
|
28154
|
+
{
|
|
28155
|
+
"lang": "typescript",
|
|
28156
|
+
"label": "SDK",
|
|
28157
|
+
"source": "import { createClient } from \"@andesine/sdk\";\n\nconst client = createClient({ apiKey: process.env.ANDESINE_API_KEY });\n\nawait client.roles.create({\n name: \"Editor\",\n permissions: [\n \"content\"\n ]\n});"
|
|
28158
|
+
}
|
|
28159
|
+
]
|
|
27950
28160
|
}
|
|
27951
28161
|
},
|
|
27952
28162
|
"/roles/{id}": {
|
|
@@ -28284,7 +28494,14 @@
|
|
|
28284
28494
|
}
|
|
28285
28495
|
}
|
|
28286
28496
|
},
|
|
28287
|
-
"x-sdk-example": { "id": "rl_example", "name": "Content editor" }
|
|
28497
|
+
"x-sdk-example": { "id": "rl_example", "name": "Content editor" },
|
|
28498
|
+
"x-codeSamples": [
|
|
28499
|
+
{
|
|
28500
|
+
"lang": "typescript",
|
|
28501
|
+
"label": "SDK",
|
|
28502
|
+
"source": "import { createClient } from \"@andesine/sdk\";\n\nconst client = createClient({ apiKey: process.env.ANDESINE_API_KEY });\n\nawait client.roles.update({\n id: \"rl_example\",\n name: \"Content editor\"\n});"
|
|
28503
|
+
}
|
|
28504
|
+
]
|
|
28288
28505
|
},
|
|
28289
28506
|
"delete": {
|
|
28290
28507
|
"operationId": "roles.delete",
|
|
@@ -28579,7 +28796,14 @@
|
|
|
28579
28796
|
}
|
|
28580
28797
|
}
|
|
28581
28798
|
},
|
|
28582
|
-
"x-sdk-example": { "id": "rl_example" }
|
|
28799
|
+
"x-sdk-example": { "id": "rl_example" },
|
|
28800
|
+
"x-codeSamples": [
|
|
28801
|
+
{
|
|
28802
|
+
"lang": "typescript",
|
|
28803
|
+
"label": "SDK",
|
|
28804
|
+
"source": "import { createClient } from \"@andesine/sdk\";\n\nconst client = createClient({ apiKey: process.env.ANDESINE_API_KEY });\n\nawait client.roles.delete({\n id: \"rl_example\"\n});"
|
|
28805
|
+
}
|
|
28806
|
+
]
|
|
28583
28807
|
}
|
|
28584
28808
|
},
|
|
28585
28809
|
"/search/current": {
|
|
@@ -28904,7 +29128,14 @@
|
|
|
28904
29128
|
"description": "Required for OAuth: ID of the workspace to access. API keys use their own workspace."
|
|
28905
29129
|
}
|
|
28906
29130
|
],
|
|
28907
|
-
"x-sdk-example": { "query": "installation", "limit": 10 }
|
|
29131
|
+
"x-sdk-example": { "query": "installation", "limit": 10 },
|
|
29132
|
+
"x-codeSamples": [
|
|
29133
|
+
{
|
|
29134
|
+
"lang": "typescript",
|
|
29135
|
+
"label": "SDK",
|
|
29136
|
+
"source": "import { createClient } from \"@andesine/sdk\";\n\nconst client = createClient({ apiKey: process.env.ANDESINE_API_KEY });\n\nawait client.search.current({\n query: \"installation\",\n limit: 10\n});"
|
|
29137
|
+
}
|
|
29138
|
+
]
|
|
28908
29139
|
}
|
|
28909
29140
|
},
|
|
28910
29141
|
"/search/published": {
|
|
@@ -29241,14 +29472,21 @@
|
|
|
29241
29472
|
"description": "Required for OAuth: ID of the workspace to access. API keys use their own workspace."
|
|
29242
29473
|
}
|
|
29243
29474
|
],
|
|
29244
|
-
"x-sdk-example": { "query": "installation", "channel": "published", "limit": 10 }
|
|
29475
|
+
"x-sdk-example": { "query": "installation", "channel": "published", "limit": 10 },
|
|
29476
|
+
"x-codeSamples": [
|
|
29477
|
+
{
|
|
29478
|
+
"lang": "typescript",
|
|
29479
|
+
"label": "SDK",
|
|
29480
|
+
"source": "import { createClient } from \"@andesine/sdk\";\n\nconst client = createClient({ apiKey: process.env.ANDESINE_API_KEY });\n\nawait client.search.published({\n query: \"installation\",\n channel: \"published\",\n limit: 10\n});"
|
|
29481
|
+
}
|
|
29482
|
+
]
|
|
29245
29483
|
}
|
|
29246
29484
|
},
|
|
29247
29485
|
"/search/current/ask": {
|
|
29248
29486
|
"post": {
|
|
29249
29487
|
"operationId": "search.askCurrent",
|
|
29250
29488
|
"summary": "Ask AI about current content",
|
|
29251
|
-
"description": "Returns a complete answer with numbered sources. Requires explicit ai-answers permission in addition to content read permissions. Accepts up to 1,000 question characters, 10 history messages of up to 4,000 characters each, and 20 property filters. Uses
|
|
29489
|
+
"description": "Returns a complete answer with numbered sources. Requires explicit ai-answers permission in addition to content read permissions. Accepts up to 1,000 question characters, 10 history messages of up to 4,000 characters each, and 20 property filters. Uses 10 AI credits and the Ask AI rate limit. Use a secret key on your server, or a publishable key for published content.\n\nRequired API key permissions: ai-answers, read:entries, read:collections. Write permissions also grant read access for the same resource.",
|
|
29252
29490
|
"tags": ["search"],
|
|
29253
29491
|
"requestBody": {
|
|
29254
29492
|
"required": true,
|
|
@@ -29565,14 +29803,21 @@
|
|
|
29565
29803
|
"description": "Required for OAuth: ID of the workspace to access. API keys use their own workspace."
|
|
29566
29804
|
}
|
|
29567
29805
|
],
|
|
29568
|
-
"x-sdk-example": { "question": "How do I install Andesine?" }
|
|
29806
|
+
"x-sdk-example": { "question": "How do I install Andesine?" },
|
|
29807
|
+
"x-codeSamples": [
|
|
29808
|
+
{
|
|
29809
|
+
"lang": "typescript",
|
|
29810
|
+
"label": "SDK",
|
|
29811
|
+
"source": "import { createClient } from \"@andesine/sdk\";\n\nconst client = createClient({ apiKey: process.env.ANDESINE_API_KEY });\n\nawait client.search.askCurrent({\n question: \"How do I install Andesine?\"\n});"
|
|
29812
|
+
}
|
|
29813
|
+
]
|
|
29569
29814
|
}
|
|
29570
29815
|
},
|
|
29571
29816
|
"/search/published/ask": {
|
|
29572
29817
|
"post": {
|
|
29573
29818
|
"operationId": "search.askPublished",
|
|
29574
29819
|
"summary": "Ask AI about published content",
|
|
29575
|
-
"description": "Returns a complete answer with numbered sources. Requires explicit ai-answers permission in addition to content read permissions. Accepts up to 1,000 question characters, 10 history messages of up to 4,000 characters each, and 20 property filters. Uses
|
|
29820
|
+
"description": "Returns a complete answer with numbered sources. Requires explicit ai-answers permission in addition to content read permissions. Accepts up to 1,000 question characters, 10 history messages of up to 4,000 characters each, and 20 property filters. Uses 10 AI credits and the Ask AI rate limit. Use a secret key on your server, or a publishable key for published content.\n\nRequired API key permissions: ai-answers, read:publishing. Write permissions also grant read access for the same resource.",
|
|
29576
29821
|
"tags": ["search"],
|
|
29577
29822
|
"requestBody": {
|
|
29578
29823
|
"required": true,
|
|
@@ -29890,7 +30135,14 @@
|
|
|
29890
30135
|
"description": "Required for OAuth: ID of the workspace to access. API keys use their own workspace."
|
|
29891
30136
|
}
|
|
29892
30137
|
],
|
|
29893
|
-
"x-sdk-example": { "question": "How do I install Andesine?", "channel": "published" }
|
|
30138
|
+
"x-sdk-example": { "question": "How do I install Andesine?", "channel": "published" },
|
|
30139
|
+
"x-codeSamples": [
|
|
30140
|
+
{
|
|
30141
|
+
"lang": "typescript",
|
|
30142
|
+
"label": "SDK",
|
|
30143
|
+
"source": "import { createClient } from \"@andesine/sdk\";\n\nconst client = createClient({ apiKey: process.env.ANDESINE_API_KEY });\n\nawait client.search.askPublished({\n question: \"How do I install Andesine?\",\n channel: \"published\"\n});"
|
|
30144
|
+
}
|
|
30145
|
+
]
|
|
29894
30146
|
}
|
|
29895
30147
|
},
|
|
29896
30148
|
"/search/current/ask/stream": {
|
|
@@ -30929,7 +31181,14 @@
|
|
|
30929
31181
|
}
|
|
30930
31182
|
}
|
|
30931
31183
|
},
|
|
30932
|
-
"x-sdk-example": { "collectionID": "coll_example" }
|
|
31184
|
+
"x-sdk-example": { "collectionID": "coll_example" },
|
|
31185
|
+
"x-codeSamples": [
|
|
31186
|
+
{
|
|
31187
|
+
"lang": "typescript",
|
|
31188
|
+
"label": "SDK",
|
|
31189
|
+
"source": "import { createClient } from \"@andesine/sdk\";\n\nconst client = createClient({ apiKey: process.env.ANDESINE_API_KEY });\n\nawait client.schemas.create({\n collectionID: \"coll_example\"\n});"
|
|
31190
|
+
}
|
|
31191
|
+
]
|
|
30933
31192
|
}
|
|
30934
31193
|
},
|
|
30935
31194
|
"/schemas/{schemaID}": {
|
|
@@ -31279,7 +31538,14 @@
|
|
|
31279
31538
|
}
|
|
31280
31539
|
}
|
|
31281
31540
|
},
|
|
31282
|
-
"x-sdk-example": { "schemaID": "sch_example", "confirmedDataLoss": false }
|
|
31541
|
+
"x-sdk-example": { "schemaID": "sch_example", "confirmedDataLoss": false },
|
|
31542
|
+
"x-codeSamples": [
|
|
31543
|
+
{
|
|
31544
|
+
"lang": "typescript",
|
|
31545
|
+
"label": "SDK",
|
|
31546
|
+
"source": "import { createClient } from \"@andesine/sdk\";\n\nconst client = createClient({ apiKey: process.env.ANDESINE_API_KEY });\n\nawait client.schemas.delete({\n schemaID: \"sch_example\",\n confirmedDataLoss: false\n});"
|
|
31547
|
+
}
|
|
31548
|
+
]
|
|
31283
31549
|
}
|
|
31284
31550
|
},
|
|
31285
31551
|
"/schema-revisions/{revisionID}": {
|
|
@@ -31576,7 +31842,14 @@
|
|
|
31576
31842
|
}
|
|
31577
31843
|
}
|
|
31578
31844
|
},
|
|
31579
|
-
"x-sdk-example": { "revisionID": "schr_example" }
|
|
31845
|
+
"x-sdk-example": { "revisionID": "schr_example" },
|
|
31846
|
+
"x-codeSamples": [
|
|
31847
|
+
{
|
|
31848
|
+
"lang": "typescript",
|
|
31849
|
+
"label": "SDK",
|
|
31850
|
+
"source": "import { createClient } from \"@andesine/sdk\";\n\nconst client = createClient({ apiKey: process.env.ANDESINE_API_KEY });\n\nawait client.schemas.getRevision({\n revisionID: \"schr_example\"\n});"
|
|
31851
|
+
}
|
|
31852
|
+
]
|
|
31580
31853
|
}
|
|
31581
31854
|
},
|
|
31582
31855
|
"/schemas/collection": {
|
|
@@ -31894,7 +32167,14 @@
|
|
|
31894
32167
|
}
|
|
31895
32168
|
}
|
|
31896
32169
|
},
|
|
31897
|
-
"x-sdk-example": { "collectionID": "coll_example" }
|
|
32170
|
+
"x-sdk-example": { "collectionID": "coll_example" },
|
|
32171
|
+
"x-codeSamples": [
|
|
32172
|
+
{
|
|
32173
|
+
"lang": "typescript",
|
|
32174
|
+
"label": "SDK",
|
|
32175
|
+
"source": "import { createClient } from \"@andesine/sdk\";\n\nconst client = createClient({ apiKey: process.env.ANDESINE_API_KEY });\n\nawait client.schemas.get({\n collectionID: \"coll_example\"\n});"
|
|
32176
|
+
}
|
|
32177
|
+
]
|
|
31898
32178
|
}
|
|
31899
32179
|
},
|
|
31900
32180
|
"/schemas/{schemaID}/draft": {
|
|
@@ -32328,7 +32608,14 @@
|
|
|
32328
32608
|
}
|
|
32329
32609
|
]
|
|
32330
32610
|
}
|
|
32331
|
-
}
|
|
32611
|
+
},
|
|
32612
|
+
"x-codeSamples": [
|
|
32613
|
+
{
|
|
32614
|
+
"lang": "typescript",
|
|
32615
|
+
"label": "SDK",
|
|
32616
|
+
"source": "import { createClient } from \"@andesine/sdk\";\n\nconst client = createClient({ apiKey: process.env.ANDESINE_API_KEY });\n\nawait client.schemas.updateDraft({\n schemaID: \"sch_example\",\n definition: {\n formatVersion: 1,\n fields: [\n {\n id: \"summary\",\n kind: \"property\",\n label: \"Summary\",\n type: \"text\",\n initialValue: \"\",\n options: []\n }\n ]\n }\n});"
|
|
32617
|
+
}
|
|
32618
|
+
]
|
|
32332
32619
|
}
|
|
32333
32620
|
},
|
|
32334
32621
|
"/schemas/{schemaID}/apply": {
|
|
@@ -32742,7 +33029,14 @@
|
|
|
32742
33029
|
"schemaID": "sch_example",
|
|
32743
33030
|
"confirmedDataLoss": true,
|
|
32744
33031
|
"name": "Reviewed schema"
|
|
32745
|
-
}
|
|
33032
|
+
},
|
|
33033
|
+
"x-codeSamples": [
|
|
33034
|
+
{
|
|
33035
|
+
"lang": "typescript",
|
|
33036
|
+
"label": "SDK",
|
|
33037
|
+
"source": "import { createClient } from \"@andesine/sdk\";\n\nconst client = createClient({ apiKey: process.env.ANDESINE_API_KEY });\n\nawait client.schemas.apply({\n schemaID: \"sch_example\",\n confirmedDataLoss: true,\n name: \"Reviewed schema\"\n});"
|
|
33038
|
+
}
|
|
33039
|
+
]
|
|
32746
33040
|
}
|
|
32747
33041
|
},
|
|
32748
33042
|
"/schema-migrations/{id}/content-loss-entries": {
|
|
@@ -33069,7 +33363,14 @@
|
|
|
33069
33363
|
}
|
|
33070
33364
|
}
|
|
33071
33365
|
},
|
|
33072
|
-
"x-sdk-example": { "id": "smg_example", "limit": 20 }
|
|
33366
|
+
"x-sdk-example": { "id": "smg_example", "limit": 20 },
|
|
33367
|
+
"x-codeSamples": [
|
|
33368
|
+
{
|
|
33369
|
+
"lang": "typescript",
|
|
33370
|
+
"label": "SDK",
|
|
33371
|
+
"source": "import { createClient } from \"@andesine/sdk\";\n\nconst client = createClient({ apiKey: process.env.ANDESINE_API_KEY });\n\nawait client.schemaMigrations.listContentLossEntries({\n id: \"smg_example\",\n limit: 20\n});"
|
|
33372
|
+
}
|
|
33373
|
+
]
|
|
33073
33374
|
}
|
|
33074
33375
|
},
|
|
33075
33376
|
"/collections/{collectionID}/schema-migration": {
|
|
@@ -33370,7 +33671,14 @@
|
|
|
33370
33671
|
}
|
|
33371
33672
|
}
|
|
33372
33673
|
},
|
|
33373
|
-
"x-sdk-example": { "collectionID": "coll_example" }
|
|
33674
|
+
"x-sdk-example": { "collectionID": "coll_example" },
|
|
33675
|
+
"x-codeSamples": [
|
|
33676
|
+
{
|
|
33677
|
+
"lang": "typescript",
|
|
33678
|
+
"label": "SDK",
|
|
33679
|
+
"source": "import { createClient } from \"@andesine/sdk\";\n\nconst client = createClient({ apiKey: process.env.ANDESINE_API_KEY });\n\nawait client.schemaMigrations.getActive({\n collectionID: \"coll_example\"\n});"
|
|
33680
|
+
}
|
|
33681
|
+
]
|
|
33374
33682
|
}
|
|
33375
33683
|
},
|
|
33376
33684
|
"/schema-migrations/{id}": {
|
|
@@ -33667,7 +33975,14 @@
|
|
|
33667
33975
|
}
|
|
33668
33976
|
}
|
|
33669
33977
|
},
|
|
33670
|
-
"x-sdk-example": { "id": "smg_example" }
|
|
33978
|
+
"x-sdk-example": { "id": "smg_example" },
|
|
33979
|
+
"x-codeSamples": [
|
|
33980
|
+
{
|
|
33981
|
+
"lang": "typescript",
|
|
33982
|
+
"label": "SDK",
|
|
33983
|
+
"source": "import { createClient } from \"@andesine/sdk\";\n\nconst client = createClient({ apiKey: process.env.ANDESINE_API_KEY });\n\nawait client.schemaMigrations.get({\n id: \"smg_example\"\n});"
|
|
33984
|
+
}
|
|
33985
|
+
]
|
|
33671
33986
|
}
|
|
33672
33987
|
},
|
|
33673
33988
|
"/schemas/{schemaID}/versions": {
|
|
@@ -33991,7 +34306,14 @@
|
|
|
33991
34306
|
}
|
|
33992
34307
|
}
|
|
33993
34308
|
},
|
|
33994
|
-
"x-sdk-example": { "schemaID": "sch_example", "limit": 20 }
|
|
34309
|
+
"x-sdk-example": { "schemaID": "sch_example", "limit": 20 },
|
|
34310
|
+
"x-codeSamples": [
|
|
34311
|
+
{
|
|
34312
|
+
"lang": "typescript",
|
|
34313
|
+
"label": "SDK",
|
|
34314
|
+
"source": "import { createClient } from \"@andesine/sdk\";\n\nconst client = createClient({ apiKey: process.env.ANDESINE_API_KEY });\n\nawait client.schemaVersions.list({\n schemaID: \"sch_example\",\n limit: 20\n});"
|
|
34315
|
+
}
|
|
34316
|
+
]
|
|
33995
34317
|
}
|
|
33996
34318
|
},
|
|
33997
34319
|
"/schema-versions/{id}": {
|
|
@@ -34288,7 +34610,14 @@
|
|
|
34288
34610
|
}
|
|
34289
34611
|
}
|
|
34290
34612
|
},
|
|
34291
|
-
"x-sdk-example": { "id": "schv_example" }
|
|
34613
|
+
"x-sdk-example": { "id": "schv_example" },
|
|
34614
|
+
"x-codeSamples": [
|
|
34615
|
+
{
|
|
34616
|
+
"lang": "typescript",
|
|
34617
|
+
"label": "SDK",
|
|
34618
|
+
"source": "import { createClient } from \"@andesine/sdk\";\n\nconst client = createClient({ apiKey: process.env.ANDESINE_API_KEY });\n\nawait client.schemaVersions.get({\n id: \"schv_example\"\n});"
|
|
34619
|
+
}
|
|
34620
|
+
]
|
|
34292
34621
|
},
|
|
34293
34622
|
"patch": {
|
|
34294
34623
|
"operationId": "schemaVersions.update",
|
|
@@ -34626,7 +34955,14 @@
|
|
|
34626
34955
|
}
|
|
34627
34956
|
}
|
|
34628
34957
|
},
|
|
34629
|
-
"x-sdk-example": { "id": "schv_example", "name": "Reviewed schema" }
|
|
34958
|
+
"x-sdk-example": { "id": "schv_example", "name": "Reviewed schema" },
|
|
34959
|
+
"x-codeSamples": [
|
|
34960
|
+
{
|
|
34961
|
+
"lang": "typescript",
|
|
34962
|
+
"label": "SDK",
|
|
34963
|
+
"source": "import { createClient } from \"@andesine/sdk\";\n\nconst client = createClient({ apiKey: process.env.ANDESINE_API_KEY });\n\nawait client.schemaVersions.update({\n id: \"schv_example\",\n name: \"Reviewed schema\"\n});"
|
|
34964
|
+
}
|
|
34965
|
+
]
|
|
34630
34966
|
}
|
|
34631
34967
|
},
|
|
34632
34968
|
"/schema-versions/{id}/revert": {
|
|
@@ -34969,7 +35305,14 @@
|
|
|
34969
35305
|
}
|
|
34970
35306
|
}
|
|
34971
35307
|
},
|
|
34972
|
-
"x-sdk-example": { "id": "schv_example", "confirmedDataLoss": true }
|
|
35308
|
+
"x-sdk-example": { "id": "schv_example", "confirmedDataLoss": true },
|
|
35309
|
+
"x-codeSamples": [
|
|
35310
|
+
{
|
|
35311
|
+
"lang": "typescript",
|
|
35312
|
+
"label": "SDK",
|
|
35313
|
+
"source": "import { createClient } from \"@andesine/sdk\";\n\nconst client = createClient({ apiKey: process.env.ANDESINE_API_KEY });\n\nawait client.schemaVersions.revert({\n id: \"schv_example\",\n confirmedDataLoss: true\n});"
|
|
35314
|
+
}
|
|
35315
|
+
]
|
|
34973
35316
|
}
|
|
34974
35317
|
},
|
|
34975
35318
|
"/memberships": {
|
|
@@ -35288,7 +35631,14 @@
|
|
|
35288
35631
|
}
|
|
35289
35632
|
}
|
|
35290
35633
|
},
|
|
35291
|
-
"x-sdk-example": {}
|
|
35634
|
+
"x-sdk-example": {},
|
|
35635
|
+
"x-codeSamples": [
|
|
35636
|
+
{
|
|
35637
|
+
"lang": "typescript",
|
|
35638
|
+
"label": "SDK",
|
|
35639
|
+
"source": "import { createClient } from \"@andesine/sdk\";\n\nconst client = createClient({ apiKey: process.env.ANDESINE_API_KEY });\n\nawait client.memberships.list({});"
|
|
35640
|
+
}
|
|
35641
|
+
]
|
|
35292
35642
|
},
|
|
35293
35643
|
"post": {
|
|
35294
35644
|
"operationId": "memberships.invite",
|
|
@@ -35619,7 +35969,14 @@
|
|
|
35619
35969
|
"description": "Required for OAuth: ID of the workspace to access. API keys use their own workspace."
|
|
35620
35970
|
}
|
|
35621
35971
|
],
|
|
35622
|
-
"x-sdk-example": { "email": "editor@example.com", "roleID": "rl_example" }
|
|
35972
|
+
"x-sdk-example": { "email": "editor@example.com", "roleID": "rl_example" },
|
|
35973
|
+
"x-codeSamples": [
|
|
35974
|
+
{
|
|
35975
|
+
"lang": "typescript",
|
|
35976
|
+
"label": "SDK",
|
|
35977
|
+
"source": "import { createClient } from \"@andesine/sdk\";\n\nconst client = createClient({ apiKey: process.env.ANDESINE_API_KEY });\n\nawait client.memberships.invite({\n email: \"editor@example.com\",\n roleID: \"rl_example\"\n});"
|
|
35978
|
+
}
|
|
35979
|
+
]
|
|
35623
35980
|
}
|
|
35624
35981
|
},
|
|
35625
35982
|
"/memberships/{id}": {
|
|
@@ -35929,7 +36286,14 @@
|
|
|
35929
36286
|
}
|
|
35930
36287
|
}
|
|
35931
36288
|
},
|
|
35932
|
-
"x-sdk-example": { "id": "ms_example", "roleID": "rl_example" }
|
|
36289
|
+
"x-sdk-example": { "id": "ms_example", "roleID": "rl_example" },
|
|
36290
|
+
"x-codeSamples": [
|
|
36291
|
+
{
|
|
36292
|
+
"lang": "typescript",
|
|
36293
|
+
"label": "SDK",
|
|
36294
|
+
"source": "import { createClient } from \"@andesine/sdk\";\n\nconst client = createClient({ apiKey: process.env.ANDESINE_API_KEY });\n\nawait client.memberships.update({\n id: \"ms_example\",\n roleID: \"rl_example\"\n});"
|
|
36295
|
+
}
|
|
36296
|
+
]
|
|
35933
36297
|
},
|
|
35934
36298
|
"delete": {
|
|
35935
36299
|
"operationId": "memberships.remove",
|
|
@@ -36224,7 +36588,14 @@
|
|
|
36224
36588
|
}
|
|
36225
36589
|
}
|
|
36226
36590
|
},
|
|
36227
|
-
"x-sdk-example": { "id": "ms_example" }
|
|
36591
|
+
"x-sdk-example": { "id": "ms_example" },
|
|
36592
|
+
"x-codeSamples": [
|
|
36593
|
+
{
|
|
36594
|
+
"lang": "typescript",
|
|
36595
|
+
"label": "SDK",
|
|
36596
|
+
"source": "import { createClient } from \"@andesine/sdk\";\n\nconst client = createClient({ apiKey: process.env.ANDESINE_API_KEY });\n\nawait client.memberships.remove({\n id: \"ms_example\"\n});"
|
|
36597
|
+
}
|
|
36598
|
+
]
|
|
36228
36599
|
}
|
|
36229
36600
|
},
|
|
36230
36601
|
"/memberships/invites": {
|
|
@@ -36540,7 +36911,14 @@
|
|
|
36540
36911
|
}
|
|
36541
36912
|
}
|
|
36542
36913
|
},
|
|
36543
|
-
"x-sdk-example": {}
|
|
36914
|
+
"x-sdk-example": {},
|
|
36915
|
+
"x-codeSamples": [
|
|
36916
|
+
{
|
|
36917
|
+
"lang": "typescript",
|
|
36918
|
+
"label": "SDK",
|
|
36919
|
+
"source": "import { createClient } from \"@andesine/sdk\";\n\nconst client = createClient({ apiKey: process.env.ANDESINE_API_KEY });\n\nawait client.memberships.listInvites({});"
|
|
36920
|
+
}
|
|
36921
|
+
]
|
|
36544
36922
|
}
|
|
36545
36923
|
},
|
|
36546
36924
|
"/memberships/invites/{id}/resend": {
|
|
@@ -36839,7 +37217,14 @@
|
|
|
36839
37217
|
}
|
|
36840
37218
|
}
|
|
36841
37219
|
},
|
|
36842
|
-
"x-sdk-example": { "id": "inv_example" }
|
|
37220
|
+
"x-sdk-example": { "id": "inv_example" },
|
|
37221
|
+
"x-codeSamples": [
|
|
37222
|
+
{
|
|
37223
|
+
"lang": "typescript",
|
|
37224
|
+
"label": "SDK",
|
|
37225
|
+
"source": "import { createClient } from \"@andesine/sdk\";\n\nconst client = createClient({ apiKey: process.env.ANDESINE_API_KEY });\n\nawait client.memberships.resendInvite({\n id: \"inv_example\"\n});"
|
|
37226
|
+
}
|
|
37227
|
+
]
|
|
36843
37228
|
}
|
|
36844
37229
|
},
|
|
36845
37230
|
"/memberships/invites/{id}": {
|
|
@@ -37136,7 +37521,14 @@
|
|
|
37136
37521
|
}
|
|
37137
37522
|
}
|
|
37138
37523
|
},
|
|
37139
|
-
"x-sdk-example": { "id": "inv_example" }
|
|
37524
|
+
"x-sdk-example": { "id": "inv_example" },
|
|
37525
|
+
"x-codeSamples": [
|
|
37526
|
+
{
|
|
37527
|
+
"lang": "typescript",
|
|
37528
|
+
"label": "SDK",
|
|
37529
|
+
"source": "import { createClient } from \"@andesine/sdk\";\n\nconst client = createClient({ apiKey: process.env.ANDESINE_API_KEY });\n\nawait client.memberships.revokeInvite({\n id: \"inv_example\"\n});"
|
|
37530
|
+
}
|
|
37531
|
+
]
|
|
37140
37532
|
}
|
|
37141
37533
|
},
|
|
37142
37534
|
"/publishing/collections/{collectionID}": {
|
|
@@ -37496,7 +37888,14 @@
|
|
|
37496
37888
|
}
|
|
37497
37889
|
}
|
|
37498
37890
|
},
|
|
37499
|
-
"x-sdk-example": { "collectionID": "coll_example", "enabled": true, "publish": false }
|
|
37891
|
+
"x-sdk-example": { "collectionID": "coll_example", "enabled": true, "publish": false },
|
|
37892
|
+
"x-codeSamples": [
|
|
37893
|
+
{
|
|
37894
|
+
"lang": "typescript",
|
|
37895
|
+
"label": "SDK",
|
|
37896
|
+
"source": "import { createClient } from \"@andesine/sdk\";\n\nconst client = createClient({ apiKey: process.env.ANDESINE_API_KEY });\n\nawait client.publishing.setCollection({\n collectionID: \"coll_example\",\n enabled: true,\n publish: false\n});"
|
|
37897
|
+
}
|
|
37898
|
+
]
|
|
37500
37899
|
},
|
|
37501
37900
|
"post": {
|
|
37502
37901
|
"operationId": "publishing.publishCollection",
|
|
@@ -37848,7 +38247,14 @@
|
|
|
37848
38247
|
}
|
|
37849
38248
|
}
|
|
37850
38249
|
},
|
|
37851
|
-
"x-sdk-example": { "collectionID": "coll_example", "channel": "published" }
|
|
38250
|
+
"x-sdk-example": { "collectionID": "coll_example", "channel": "published" },
|
|
38251
|
+
"x-codeSamples": [
|
|
38252
|
+
{
|
|
38253
|
+
"lang": "typescript",
|
|
38254
|
+
"label": "SDK",
|
|
38255
|
+
"source": "import { createClient } from \"@andesine/sdk\";\n\nconst client = createClient({ apiKey: process.env.ANDESINE_API_KEY });\n\nawait client.publishing.publishCollection({\n collectionID: \"coll_example\",\n channel: \"published\"\n});"
|
|
38256
|
+
}
|
|
38257
|
+
]
|
|
37852
38258
|
},
|
|
37853
38259
|
"delete": {
|
|
37854
38260
|
"operationId": "publishing.unpublishCollection",
|
|
@@ -38189,7 +38595,14 @@
|
|
|
38189
38595
|
}
|
|
38190
38596
|
}
|
|
38191
38597
|
},
|
|
38192
|
-
"x-sdk-example": { "collectionID": "coll_example", "channel": "published" }
|
|
38598
|
+
"x-sdk-example": { "collectionID": "coll_example", "channel": "published" },
|
|
38599
|
+
"x-codeSamples": [
|
|
38600
|
+
{
|
|
38601
|
+
"lang": "typescript",
|
|
38602
|
+
"label": "SDK",
|
|
38603
|
+
"source": "import { createClient } from \"@andesine/sdk\";\n\nconst client = createClient({ apiKey: process.env.ANDESINE_API_KEY });\n\nawait client.publishing.unpublishCollection({\n collectionID: \"coll_example\",\n channel: \"published\"\n});"
|
|
38604
|
+
}
|
|
38605
|
+
]
|
|
38193
38606
|
}
|
|
38194
38607
|
},
|
|
38195
38608
|
"/publishing/collections/bulk/set": {
|
|
@@ -38547,7 +38960,14 @@
|
|
|
38547
38960
|
"description": "Required for OAuth: ID of the workspace to access. API keys use their own workspace."
|
|
38548
38961
|
}
|
|
38549
38962
|
],
|
|
38550
|
-
"x-sdk-example": { "ids": ["coll_example"], "enabled": true, "publish": false }
|
|
38963
|
+
"x-sdk-example": { "ids": ["coll_example"], "enabled": true, "publish": false },
|
|
38964
|
+
"x-codeSamples": [
|
|
38965
|
+
{
|
|
38966
|
+
"lang": "typescript",
|
|
38967
|
+
"label": "SDK",
|
|
38968
|
+
"source": "import { createClient } from \"@andesine/sdk\";\n\nconst client = createClient({ apiKey: process.env.ANDESINE_API_KEY });\n\nawait client.publishing.bulkSetCollections({\n ids: [\n \"coll_example\"\n ],\n enabled: true,\n publish: false\n});"
|
|
38969
|
+
}
|
|
38970
|
+
]
|
|
38551
38971
|
}
|
|
38552
38972
|
},
|
|
38553
38973
|
"/publishing/collections/bulk/publish": {
|
|
@@ -38900,7 +39320,14 @@
|
|
|
38900
39320
|
"description": "Required for OAuth: ID of the workspace to access. API keys use their own workspace."
|
|
38901
39321
|
}
|
|
38902
39322
|
],
|
|
38903
|
-
"x-sdk-example": { "ids": ["coll_example"], "channel": "published" }
|
|
39323
|
+
"x-sdk-example": { "ids": ["coll_example"], "channel": "published" },
|
|
39324
|
+
"x-codeSamples": [
|
|
39325
|
+
{
|
|
39326
|
+
"lang": "typescript",
|
|
39327
|
+
"label": "SDK",
|
|
39328
|
+
"source": "import { createClient } from \"@andesine/sdk\";\n\nconst client = createClient({ apiKey: process.env.ANDESINE_API_KEY });\n\nawait client.publishing.bulkPublishCollections({\n ids: [\n \"coll_example\"\n ],\n channel: \"published\"\n});"
|
|
39329
|
+
}
|
|
39330
|
+
]
|
|
38904
39331
|
}
|
|
38905
39332
|
},
|
|
38906
39333
|
"/publishing/collections/bulk/unpublish": {
|
|
@@ -39242,7 +39669,14 @@
|
|
|
39242
39669
|
"description": "Required for OAuth: ID of the workspace to access. API keys use their own workspace."
|
|
39243
39670
|
}
|
|
39244
39671
|
],
|
|
39245
|
-
"x-sdk-example": { "ids": ["coll_example"], "channel": "published" }
|
|
39672
|
+
"x-sdk-example": { "ids": ["coll_example"], "channel": "published" },
|
|
39673
|
+
"x-codeSamples": [
|
|
39674
|
+
{
|
|
39675
|
+
"lang": "typescript",
|
|
39676
|
+
"label": "SDK",
|
|
39677
|
+
"source": "import { createClient } from \"@andesine/sdk\";\n\nconst client = createClient({ apiKey: process.env.ANDESINE_API_KEY });\n\nawait client.publishing.bulkUnpublishCollections({\n ids: [\n \"coll_example\"\n ],\n channel: \"published\"\n});"
|
|
39678
|
+
}
|
|
39679
|
+
]
|
|
39246
39680
|
}
|
|
39247
39681
|
},
|
|
39248
39682
|
"/publishing/entries/{entryID}": {
|
|
@@ -39595,7 +40029,14 @@
|
|
|
39595
40029
|
}
|
|
39596
40030
|
}
|
|
39597
40031
|
},
|
|
39598
|
-
"x-sdk-example": { "entryID": "ent_example", "channel": "published" }
|
|
40032
|
+
"x-sdk-example": { "entryID": "ent_example", "channel": "published" },
|
|
40033
|
+
"x-codeSamples": [
|
|
40034
|
+
{
|
|
40035
|
+
"lang": "typescript",
|
|
40036
|
+
"label": "SDK",
|
|
40037
|
+
"source": "import { createClient } from \"@andesine/sdk\";\n\nconst client = createClient({ apiKey: process.env.ANDESINE_API_KEY });\n\nawait client.publishing.publishEntry({\n entryID: \"ent_example\",\n channel: \"published\"\n});"
|
|
40038
|
+
}
|
|
40039
|
+
]
|
|
39599
40040
|
},
|
|
39600
40041
|
"delete": {
|
|
39601
40042
|
"operationId": "publishing.unpublishEntry",
|
|
@@ -39942,7 +40383,14 @@
|
|
|
39942
40383
|
"entryID": "ent_example",
|
|
39943
40384
|
"channel": "published",
|
|
39944
40385
|
"versionID": "ver_example"
|
|
39945
|
-
}
|
|
40386
|
+
},
|
|
40387
|
+
"x-codeSamples": [
|
|
40388
|
+
{
|
|
40389
|
+
"lang": "typescript",
|
|
40390
|
+
"label": "SDK",
|
|
40391
|
+
"source": "import { createClient } from \"@andesine/sdk\";\n\nconst client = createClient({ apiKey: process.env.ANDESINE_API_KEY });\n\nawait client.publishing.unpublishEntry({\n entryID: \"ent_example\",\n channel: \"published\",\n versionID: \"ver_example\"\n});"
|
|
40392
|
+
}
|
|
40393
|
+
]
|
|
39946
40394
|
}
|
|
39947
40395
|
},
|
|
39948
40396
|
"/publishing/entries/bulk/publish": {
|
|
@@ -40293,7 +40741,14 @@
|
|
|
40293
40741
|
"description": "Required for OAuth: ID of the workspace to access. API keys use their own workspace."
|
|
40294
40742
|
}
|
|
40295
40743
|
],
|
|
40296
|
-
"x-sdk-example": { "entries": [{ "entryID": "ent_example" }], "channel": "published" }
|
|
40744
|
+
"x-sdk-example": { "entries": [{ "entryID": "ent_example" }], "channel": "published" },
|
|
40745
|
+
"x-codeSamples": [
|
|
40746
|
+
{
|
|
40747
|
+
"lang": "typescript",
|
|
40748
|
+
"label": "SDK",
|
|
40749
|
+
"source": "import { createClient } from \"@andesine/sdk\";\n\nconst client = createClient({ apiKey: process.env.ANDESINE_API_KEY });\n\nawait client.publishing.bulkPublishEntries({\n entries: [\n {\n entryID: \"ent_example\"\n }\n ],\n channel: \"published\"\n});"
|
|
40750
|
+
}
|
|
40751
|
+
]
|
|
40297
40752
|
}
|
|
40298
40753
|
},
|
|
40299
40754
|
"/publishing/entries/bulk/unpublish": {
|
|
@@ -40633,7 +41088,14 @@
|
|
|
40633
41088
|
"description": "Required for OAuth: ID of the workspace to access. API keys use their own workspace."
|
|
40634
41089
|
}
|
|
40635
41090
|
],
|
|
40636
|
-
"x-sdk-example": { "ids": ["ent_example"], "channel": "published" }
|
|
41091
|
+
"x-sdk-example": { "ids": ["ent_example"], "channel": "published" },
|
|
41092
|
+
"x-codeSamples": [
|
|
41093
|
+
{
|
|
41094
|
+
"lang": "typescript",
|
|
41095
|
+
"label": "SDK",
|
|
41096
|
+
"source": "import { createClient } from \"@andesine/sdk\";\n\nconst client = createClient({ apiKey: process.env.ANDESINE_API_KEY });\n\nawait client.publishing.bulkUnpublishEntries({\n ids: [\n \"ent_example\"\n ],\n channel: \"published\"\n});"
|
|
41097
|
+
}
|
|
41098
|
+
]
|
|
40637
41099
|
}
|
|
40638
41100
|
},
|
|
40639
41101
|
"/publishing/changes/revert": {
|
|
@@ -41042,7 +41504,14 @@
|
|
|
41042
41504
|
"snapshotID": "snp_example",
|
|
41043
41505
|
"entryIDs": ["ent_example"],
|
|
41044
41506
|
"channel": "published"
|
|
41045
|
-
}
|
|
41507
|
+
},
|
|
41508
|
+
"x-codeSamples": [
|
|
41509
|
+
{
|
|
41510
|
+
"lang": "typescript",
|
|
41511
|
+
"label": "SDK",
|
|
41512
|
+
"source": "import { createClient } from \"@andesine/sdk\";\n\nconst client = createClient({ apiKey: process.env.ANDESINE_API_KEY });\n\nawait client.publishing.revertChanges({\n collectionID: \"coll_example\",\n snapshotID: \"snp_example\",\n entryIDs: [\n \"ent_example\"\n ],\n channel: \"published\"\n});"
|
|
41513
|
+
}
|
|
41514
|
+
]
|
|
41046
41515
|
}
|
|
41047
41516
|
},
|
|
41048
41517
|
"/publishing/entries/{entryID}/version": {
|
|
@@ -41392,7 +41861,14 @@
|
|
|
41392
41861
|
}
|
|
41393
41862
|
}
|
|
41394
41863
|
},
|
|
41395
|
-
"x-sdk-example": { "entryID": "ent_example", "channel": "published" }
|
|
41864
|
+
"x-sdk-example": { "entryID": "ent_example", "channel": "published" },
|
|
41865
|
+
"x-codeSamples": [
|
|
41866
|
+
{
|
|
41867
|
+
"lang": "typescript",
|
|
41868
|
+
"label": "SDK",
|
|
41869
|
+
"source": "import { createClient } from \"@andesine/sdk\";\n\nconst client = createClient({ apiKey: process.env.ANDESINE_API_KEY });\n\nawait client.publishing.getEntryVersion({\n entryID: \"ent_example\",\n channel: \"published\"\n});"
|
|
41870
|
+
}
|
|
41871
|
+
]
|
|
41396
41872
|
}
|
|
41397
41873
|
},
|
|
41398
41874
|
"/publishing/entries/{entryID}/publications": {
|
|
@@ -41694,7 +42170,14 @@
|
|
|
41694
42170
|
}
|
|
41695
42171
|
}
|
|
41696
42172
|
},
|
|
41697
|
-
"x-sdk-example": { "entryID": "ent_example" }
|
|
42173
|
+
"x-sdk-example": { "entryID": "ent_example" },
|
|
42174
|
+
"x-codeSamples": [
|
|
42175
|
+
{
|
|
42176
|
+
"lang": "typescript",
|
|
42177
|
+
"label": "SDK",
|
|
42178
|
+
"source": "import { createClient } from \"@andesine/sdk\";\n\nconst client = createClient({ apiKey: process.env.ANDESINE_API_KEY });\n\nawait client.publishing.listEntryPublications({\n entryID: \"ent_example\"\n});"
|
|
42179
|
+
}
|
|
42180
|
+
]
|
|
41698
42181
|
}
|
|
41699
42182
|
},
|
|
41700
42183
|
"/publishing/channels": {
|
|
@@ -42000,7 +42483,14 @@
|
|
|
42000
42483
|
}
|
|
42001
42484
|
}
|
|
42002
42485
|
},
|
|
42003
|
-
"x-sdk-example": { "includeAssignmentCount": true }
|
|
42486
|
+
"x-sdk-example": { "includeAssignmentCount": true },
|
|
42487
|
+
"x-codeSamples": [
|
|
42488
|
+
{
|
|
42489
|
+
"lang": "typescript",
|
|
42490
|
+
"label": "SDK",
|
|
42491
|
+
"source": "import { createClient } from \"@andesine/sdk\";\n\nconst client = createClient({ apiKey: process.env.ANDESINE_API_KEY });\n\nawait client.publishing.listChannels({\n includeAssignmentCount: true\n});"
|
|
42492
|
+
}
|
|
42493
|
+
]
|
|
42004
42494
|
},
|
|
42005
42495
|
"post": {
|
|
42006
42496
|
"operationId": "publishing.createChannel",
|
|
@@ -42325,7 +42815,14 @@
|
|
|
42325
42815
|
"description": "Required for OAuth: ID of the workspace to access. API keys use their own workspace."
|
|
42326
42816
|
}
|
|
42327
42817
|
],
|
|
42328
|
-
"x-sdk-example": { "name": "Preview" }
|
|
42818
|
+
"x-sdk-example": { "name": "Preview" },
|
|
42819
|
+
"x-codeSamples": [
|
|
42820
|
+
{
|
|
42821
|
+
"lang": "typescript",
|
|
42822
|
+
"label": "SDK",
|
|
42823
|
+
"source": "import { createClient } from \"@andesine/sdk\";\n\nconst client = createClient({ apiKey: process.env.ANDESINE_API_KEY });\n\nawait client.publishing.createChannel({\n name: \"Preview\"\n});"
|
|
42824
|
+
}
|
|
42825
|
+
]
|
|
42329
42826
|
}
|
|
42330
42827
|
},
|
|
42331
42828
|
"/publishing/channels/{channel}/content": {
|
|
@@ -42653,7 +43150,14 @@
|
|
|
42653
43150
|
}
|
|
42654
43151
|
}
|
|
42655
43152
|
},
|
|
42656
|
-
"x-sdk-example": { "channel": "published", "collectionID": "coll_example" }
|
|
43153
|
+
"x-sdk-example": { "channel": "published", "collectionID": "coll_example" },
|
|
43154
|
+
"x-codeSamples": [
|
|
43155
|
+
{
|
|
43156
|
+
"lang": "typescript",
|
|
43157
|
+
"label": "SDK",
|
|
43158
|
+
"source": "import { createClient } from \"@andesine/sdk\";\n\nconst client = createClient({ apiKey: process.env.ANDESINE_API_KEY });\n\nawait client.publishing.getChannelContent({\n channel: \"published\",\n collectionID: \"coll_example\"\n});"
|
|
43159
|
+
}
|
|
43160
|
+
]
|
|
42657
43161
|
}
|
|
42658
43162
|
},
|
|
42659
43163
|
"/publishing/channels/{code}": {
|
|
@@ -42965,7 +43469,14 @@
|
|
|
42965
43469
|
}
|
|
42966
43470
|
}
|
|
42967
43471
|
},
|
|
42968
|
-
"x-sdk-example": { "code": "preview", "name": "Staging" }
|
|
43472
|
+
"x-sdk-example": { "code": "preview", "name": "Staging" },
|
|
43473
|
+
"x-codeSamples": [
|
|
43474
|
+
{
|
|
43475
|
+
"lang": "typescript",
|
|
43476
|
+
"label": "SDK",
|
|
43477
|
+
"source": "import { createClient } from \"@andesine/sdk\";\n\nconst client = createClient({ apiKey: process.env.ANDESINE_API_KEY });\n\nawait client.publishing.updateChannel({\n code: \"preview\",\n name: \"Staging\"\n});"
|
|
43478
|
+
}
|
|
43479
|
+
]
|
|
42969
43480
|
},
|
|
42970
43481
|
"delete": {
|
|
42971
43482
|
"operationId": "publishing.deleteChannel",
|
|
@@ -43299,7 +43810,14 @@
|
|
|
43299
43810
|
}
|
|
43300
43811
|
}
|
|
43301
43812
|
},
|
|
43302
|
-
"x-sdk-example": { "code": "preview" }
|
|
43813
|
+
"x-sdk-example": { "code": "preview" },
|
|
43814
|
+
"x-codeSamples": [
|
|
43815
|
+
{
|
|
43816
|
+
"lang": "typescript",
|
|
43817
|
+
"label": "SDK",
|
|
43818
|
+
"source": "import { createClient } from \"@andesine/sdk\";\n\nconst client = createClient({ apiKey: process.env.ANDESINE_API_KEY });\n\nawait client.publishing.deleteChannel({\n code: \"preview\"\n});"
|
|
43819
|
+
}
|
|
43820
|
+
]
|
|
43303
43821
|
}
|
|
43304
43822
|
},
|
|
43305
43823
|
"/workspaces": {
|
|
@@ -44071,7 +44589,14 @@
|
|
|
44071
44589
|
}
|
|
44072
44590
|
},
|
|
44073
44591
|
"x-idempotent": true,
|
|
44074
|
-
"x-sdk-example": { "entryID": "ent_example", "name": "Before release" }
|
|
44592
|
+
"x-sdk-example": { "entryID": "ent_example", "name": "Before release" },
|
|
44593
|
+
"x-codeSamples": [
|
|
44594
|
+
{
|
|
44595
|
+
"lang": "typescript",
|
|
44596
|
+
"label": "SDK",
|
|
44597
|
+
"source": "import { createClient } from \"@andesine/sdk\";\n\nconst client = createClient({ apiKey: process.env.ANDESINE_API_KEY });\n\nawait client.versions.create({\n entryID: \"ent_example\",\n name: \"Before release\"\n});"
|
|
44598
|
+
}
|
|
44599
|
+
]
|
|
44075
44600
|
},
|
|
44076
44601
|
"get": {
|
|
44077
44602
|
"operationId": "versions.list",
|
|
@@ -44393,7 +44918,14 @@
|
|
|
44393
44918
|
}
|
|
44394
44919
|
}
|
|
44395
44920
|
},
|
|
44396
|
-
"x-sdk-example": { "entryID": "ent_example", "limit": 20 }
|
|
44921
|
+
"x-sdk-example": { "entryID": "ent_example", "limit": 20 },
|
|
44922
|
+
"x-codeSamples": [
|
|
44923
|
+
{
|
|
44924
|
+
"lang": "typescript",
|
|
44925
|
+
"label": "SDK",
|
|
44926
|
+
"source": "import { createClient } from \"@andesine/sdk\";\n\nconst client = createClient({ apiKey: process.env.ANDESINE_API_KEY });\n\nawait client.versions.list({\n entryID: \"ent_example\",\n limit: 20\n});"
|
|
44927
|
+
}
|
|
44928
|
+
]
|
|
44397
44929
|
}
|
|
44398
44930
|
},
|
|
44399
44931
|
"/versions/{id}": {
|
|
@@ -44859,7 +45391,14 @@
|
|
|
44859
45391
|
}
|
|
44860
45392
|
}
|
|
44861
45393
|
},
|
|
44862
|
-
"x-sdk-example": { "id": "ver_example" }
|
|
45394
|
+
"x-sdk-example": { "id": "ver_example" },
|
|
45395
|
+
"x-codeSamples": [
|
|
45396
|
+
{
|
|
45397
|
+
"lang": "typescript",
|
|
45398
|
+
"label": "SDK",
|
|
45399
|
+
"source": "import { createClient } from \"@andesine/sdk\";\n\nconst client = createClient({ apiKey: process.env.ANDESINE_API_KEY });\n\nawait client.versions.get({\n id: \"ver_example\"\n});"
|
|
45400
|
+
}
|
|
45401
|
+
]
|
|
44863
45402
|
},
|
|
44864
45403
|
"patch": {
|
|
44865
45404
|
"operationId": "versions.update",
|
|
@@ -45172,7 +45711,14 @@
|
|
|
45172
45711
|
}
|
|
45173
45712
|
}
|
|
45174
45713
|
},
|
|
45175
|
-
"x-sdk-example": { "id": "ver_example", "name": "Release candidate" }
|
|
45714
|
+
"x-sdk-example": { "id": "ver_example", "name": "Release candidate" },
|
|
45715
|
+
"x-codeSamples": [
|
|
45716
|
+
{
|
|
45717
|
+
"lang": "typescript",
|
|
45718
|
+
"label": "SDK",
|
|
45719
|
+
"source": "import { createClient } from \"@andesine/sdk\";\n\nconst client = createClient({ apiKey: process.env.ANDESINE_API_KEY });\n\nawait client.versions.update({\n id: \"ver_example\",\n name: \"Release candidate\"\n});"
|
|
45720
|
+
}
|
|
45721
|
+
]
|
|
45176
45722
|
}
|
|
45177
45723
|
},
|
|
45178
45724
|
"/versions/{id}/revert": {
|
|
@@ -45516,7 +46062,14 @@
|
|
|
45516
46062
|
}
|
|
45517
46063
|
}
|
|
45518
46064
|
},
|
|
45519
|
-
"x-sdk-example": { "id": "ver_example" }
|
|
46065
|
+
"x-sdk-example": { "id": "ver_example" },
|
|
46066
|
+
"x-codeSamples": [
|
|
46067
|
+
{
|
|
46068
|
+
"lang": "typescript",
|
|
46069
|
+
"label": "SDK",
|
|
46070
|
+
"source": "import { createClient } from \"@andesine/sdk\";\n\nconst client = createClient({ apiKey: process.env.ANDESINE_API_KEY });\n\nawait client.versions.revert({\n id: \"ver_example\"\n});"
|
|
46071
|
+
}
|
|
46072
|
+
]
|
|
45520
46073
|
}
|
|
45521
46074
|
},
|
|
45522
46075
|
"/type-metadata/current": {
|
|
@@ -45878,7 +46431,14 @@
|
|
|
45878
46431
|
"description": "Required for OAuth: ID of the workspace to access. API keys use their own workspace."
|
|
45879
46432
|
}
|
|
45880
46433
|
],
|
|
45881
|
-
"x-sdk-example": { "collections": ["/Tutorials"], "includeEntries": false }
|
|
46434
|
+
"x-sdk-example": { "collections": ["/Tutorials"], "includeEntries": false },
|
|
46435
|
+
"x-codeSamples": [
|
|
46436
|
+
{
|
|
46437
|
+
"lang": "typescript",
|
|
46438
|
+
"label": "SDK",
|
|
46439
|
+
"source": "import { createClient } from \"@andesine/sdk\";\n\nconst client = createClient({ apiKey: process.env.ANDESINE_API_KEY });\n\nawait client.typeMetadata.getCurrent({\n collections: [\n \"/Tutorials\"\n ],\n includeEntries: false\n});"
|
|
46440
|
+
}
|
|
46441
|
+
]
|
|
45882
46442
|
}
|
|
45883
46443
|
},
|
|
45884
46444
|
"/type-metadata/published": {
|
|
@@ -46217,7 +46777,14 @@
|
|
|
46217
46777
|
"description": "Required for OAuth: ID of the workspace to access. API keys use their own workspace."
|
|
46218
46778
|
}
|
|
46219
46779
|
],
|
|
46220
|
-
"x-sdk-example": { "channel": "published", "collections": ["/Tutorials"] }
|
|
46780
|
+
"x-sdk-example": { "channel": "published", "collections": ["/Tutorials"] },
|
|
46781
|
+
"x-codeSamples": [
|
|
46782
|
+
{
|
|
46783
|
+
"lang": "typescript",
|
|
46784
|
+
"label": "SDK",
|
|
46785
|
+
"source": "import { createClient } from \"@andesine/sdk\";\n\nconst client = createClient({ apiKey: process.env.ANDESINE_API_KEY });\n\nawait client.typeMetadata.getPublished({\n channel: \"published\",\n collections: [\n \"/Tutorials\"\n ]\n});"
|
|
46786
|
+
}
|
|
46787
|
+
]
|
|
46221
46788
|
}
|
|
46222
46789
|
}
|
|
46223
46790
|
}
|