@1claw/openapi-spec 0.23.1 → 0.23.2
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/openapi.json +155 -0
- package/openapi.yaml +108 -0
- package/package.json +1 -1
package/openapi.json
CHANGED
|
@@ -5749,6 +5749,80 @@
|
|
|
5749
5749
|
}
|
|
5750
5750
|
}
|
|
5751
5751
|
}
|
|
5752
|
+
},
|
|
5753
|
+
"/v1/platform/claim/{token}": {
|
|
5754
|
+
"get": {
|
|
5755
|
+
"tags": [
|
|
5756
|
+
"Platform"
|
|
5757
|
+
],
|
|
5758
|
+
"summary": "Preview a claim token",
|
|
5759
|
+
"description": "Verify a claim token and preview what was provisioned (app name, vaults, agents, policies).\nPublic endpoint — the token itself is the authentication.\n",
|
|
5760
|
+
"parameters": [
|
|
5761
|
+
{
|
|
5762
|
+
"in": "path",
|
|
5763
|
+
"name": "token",
|
|
5764
|
+
"required": true,
|
|
5765
|
+
"schema": {
|
|
5766
|
+
"type": "string"
|
|
5767
|
+
},
|
|
5768
|
+
"description": "The `ct_` prefixed claim token from the bootstrap response"
|
|
5769
|
+
}
|
|
5770
|
+
],
|
|
5771
|
+
"responses": {
|
|
5772
|
+
"200": {
|
|
5773
|
+
"description": "Claim preview",
|
|
5774
|
+
"content": {
|
|
5775
|
+
"application/json": {
|
|
5776
|
+
"schema": {
|
|
5777
|
+
"$ref": "#/components/schemas/ClaimPreviewResponse"
|
|
5778
|
+
}
|
|
5779
|
+
}
|
|
5780
|
+
}
|
|
5781
|
+
},
|
|
5782
|
+
"404": {
|
|
5783
|
+
"description": "Invalid or expired claim token"
|
|
5784
|
+
}
|
|
5785
|
+
}
|
|
5786
|
+
},
|
|
5787
|
+
"post": {
|
|
5788
|
+
"tags": [
|
|
5789
|
+
"Platform"
|
|
5790
|
+
],
|
|
5791
|
+
"summary": "Redeem a claim token",
|
|
5792
|
+
"description": "Redeem a one-time claim token, marking the connection as claimed.\nPublic endpoint — the token itself is the authentication. Returns 409 if already claimed, 410 if expired.\n",
|
|
5793
|
+
"parameters": [
|
|
5794
|
+
{
|
|
5795
|
+
"in": "path",
|
|
5796
|
+
"name": "token",
|
|
5797
|
+
"required": true,
|
|
5798
|
+
"schema": {
|
|
5799
|
+
"type": "string"
|
|
5800
|
+
},
|
|
5801
|
+
"description": "The `ct_` prefixed claim token from the bootstrap response"
|
|
5802
|
+
}
|
|
5803
|
+
],
|
|
5804
|
+
"responses": {
|
|
5805
|
+
"200": {
|
|
5806
|
+
"description": "Claim redeemed",
|
|
5807
|
+
"content": {
|
|
5808
|
+
"application/json": {
|
|
5809
|
+
"schema": {
|
|
5810
|
+
"$ref": "#/components/schemas/ClaimRedeemResponse"
|
|
5811
|
+
}
|
|
5812
|
+
}
|
|
5813
|
+
}
|
|
5814
|
+
},
|
|
5815
|
+
"404": {
|
|
5816
|
+
"description": "Invalid claim token"
|
|
5817
|
+
},
|
|
5818
|
+
"409": {
|
|
5819
|
+
"description": "Claim token already used"
|
|
5820
|
+
},
|
|
5821
|
+
"410": {
|
|
5822
|
+
"description": "Claim token has expired"
|
|
5823
|
+
}
|
|
5824
|
+
}
|
|
5825
|
+
}
|
|
5752
5826
|
}
|
|
5753
5827
|
},
|
|
5754
5828
|
"components": {
|
|
@@ -10700,6 +10774,87 @@
|
|
|
10700
10774
|
"format": "date-time"
|
|
10701
10775
|
}
|
|
10702
10776
|
}
|
|
10777
|
+
},
|
|
10778
|
+
"ClaimPreviewResponse": {
|
|
10779
|
+
"type": "object",
|
|
10780
|
+
"properties": {
|
|
10781
|
+
"app_name": {
|
|
10782
|
+
"type": "string"
|
|
10783
|
+
},
|
|
10784
|
+
"app_slug": {
|
|
10785
|
+
"type": "string"
|
|
10786
|
+
},
|
|
10787
|
+
"app_logo_url": {
|
|
10788
|
+
"type": "string",
|
|
10789
|
+
"nullable": true
|
|
10790
|
+
},
|
|
10791
|
+
"auth_mode": {
|
|
10792
|
+
"type": "string"
|
|
10793
|
+
},
|
|
10794
|
+
"vault_ids": {
|
|
10795
|
+
"type": "array",
|
|
10796
|
+
"items": {
|
|
10797
|
+
"type": "string",
|
|
10798
|
+
"format": "uuid"
|
|
10799
|
+
}
|
|
10800
|
+
},
|
|
10801
|
+
"agent_ids": {
|
|
10802
|
+
"type": "array",
|
|
10803
|
+
"items": {
|
|
10804
|
+
"type": "string",
|
|
10805
|
+
"format": "uuid"
|
|
10806
|
+
}
|
|
10807
|
+
},
|
|
10808
|
+
"policy_count": {
|
|
10809
|
+
"type": "integer"
|
|
10810
|
+
},
|
|
10811
|
+
"status": {
|
|
10812
|
+
"type": "string"
|
|
10813
|
+
},
|
|
10814
|
+
"already_claimed": {
|
|
10815
|
+
"type": "boolean"
|
|
10816
|
+
},
|
|
10817
|
+
"expired": {
|
|
10818
|
+
"type": "boolean"
|
|
10819
|
+
},
|
|
10820
|
+
"return_to": {
|
|
10821
|
+
"type": "string",
|
|
10822
|
+
"nullable": true
|
|
10823
|
+
}
|
|
10824
|
+
}
|
|
10825
|
+
},
|
|
10826
|
+
"ClaimRedeemResponse": {
|
|
10827
|
+
"type": "object",
|
|
10828
|
+
"properties": {
|
|
10829
|
+
"status": {
|
|
10830
|
+
"type": "string"
|
|
10831
|
+
},
|
|
10832
|
+
"connection_id": {
|
|
10833
|
+
"type": "string",
|
|
10834
|
+
"format": "uuid"
|
|
10835
|
+
},
|
|
10836
|
+
"vault_ids": {
|
|
10837
|
+
"type": "array",
|
|
10838
|
+
"items": {
|
|
10839
|
+
"type": "string",
|
|
10840
|
+
"format": "uuid"
|
|
10841
|
+
}
|
|
10842
|
+
},
|
|
10843
|
+
"agent_ids": {
|
|
10844
|
+
"type": "array",
|
|
10845
|
+
"items": {
|
|
10846
|
+
"type": "string",
|
|
10847
|
+
"format": "uuid"
|
|
10848
|
+
}
|
|
10849
|
+
},
|
|
10850
|
+
"return_to": {
|
|
10851
|
+
"type": "string",
|
|
10852
|
+
"nullable": true
|
|
10853
|
+
},
|
|
10854
|
+
"dashboard_url": {
|
|
10855
|
+
"type": "string"
|
|
10856
|
+
}
|
|
10857
|
+
}
|
|
10703
10858
|
}
|
|
10704
10859
|
}
|
|
10705
10860
|
}
|
package/openapi.yaml
CHANGED
|
@@ -3730,6 +3730,56 @@ paths:
|
|
|
3730
3730
|
"404":
|
|
3731
3731
|
description: Connection not found
|
|
3732
3732
|
|
|
3733
|
+
/v1/platform/claim/{token}:
|
|
3734
|
+
get:
|
|
3735
|
+
tags: [Platform]
|
|
3736
|
+
summary: Preview a claim token
|
|
3737
|
+
description: |
|
|
3738
|
+
Verify a claim token and preview what was provisioned (app name, vaults, agents, policies).
|
|
3739
|
+
Public endpoint — the token itself is the authentication.
|
|
3740
|
+
parameters:
|
|
3741
|
+
- in: path
|
|
3742
|
+
name: token
|
|
3743
|
+
required: true
|
|
3744
|
+
schema:
|
|
3745
|
+
type: string
|
|
3746
|
+
description: The `ct_` prefixed claim token from the bootstrap response
|
|
3747
|
+
responses:
|
|
3748
|
+
"200":
|
|
3749
|
+
description: Claim preview
|
|
3750
|
+
content:
|
|
3751
|
+
application/json:
|
|
3752
|
+
schema:
|
|
3753
|
+
$ref: "#/components/schemas/ClaimPreviewResponse"
|
|
3754
|
+
"404":
|
|
3755
|
+
description: Invalid or expired claim token
|
|
3756
|
+
post:
|
|
3757
|
+
tags: [Platform]
|
|
3758
|
+
summary: Redeem a claim token
|
|
3759
|
+
description: |
|
|
3760
|
+
Redeem a one-time claim token, marking the connection as claimed.
|
|
3761
|
+
Public endpoint — the token itself is the authentication. Returns 409 if already claimed, 410 if expired.
|
|
3762
|
+
parameters:
|
|
3763
|
+
- in: path
|
|
3764
|
+
name: token
|
|
3765
|
+
required: true
|
|
3766
|
+
schema:
|
|
3767
|
+
type: string
|
|
3768
|
+
description: The `ct_` prefixed claim token from the bootstrap response
|
|
3769
|
+
responses:
|
|
3770
|
+
"200":
|
|
3771
|
+
description: Claim redeemed
|
|
3772
|
+
content:
|
|
3773
|
+
application/json:
|
|
3774
|
+
schema:
|
|
3775
|
+
$ref: "#/components/schemas/ClaimRedeemResponse"
|
|
3776
|
+
"404":
|
|
3777
|
+
description: Invalid claim token
|
|
3778
|
+
"409":
|
|
3779
|
+
description: Claim token already used
|
|
3780
|
+
"410":
|
|
3781
|
+
description: Claim token has expired
|
|
3782
|
+
|
|
3733
3783
|
# =============================================================================
|
|
3734
3784
|
# COMPONENTS
|
|
3735
3785
|
# =============================================================================
|
|
@@ -7198,3 +7248,61 @@ components:
|
|
|
7198
7248
|
created_at:
|
|
7199
7249
|
type: string
|
|
7200
7250
|
format: date-time
|
|
7251
|
+
|
|
7252
|
+
ClaimPreviewResponse:
|
|
7253
|
+
type: object
|
|
7254
|
+
properties:
|
|
7255
|
+
app_name:
|
|
7256
|
+
type: string
|
|
7257
|
+
app_slug:
|
|
7258
|
+
type: string
|
|
7259
|
+
app_logo_url:
|
|
7260
|
+
type: string
|
|
7261
|
+
nullable: true
|
|
7262
|
+
auth_mode:
|
|
7263
|
+
type: string
|
|
7264
|
+
vault_ids:
|
|
7265
|
+
type: array
|
|
7266
|
+
items:
|
|
7267
|
+
type: string
|
|
7268
|
+
format: uuid
|
|
7269
|
+
agent_ids:
|
|
7270
|
+
type: array
|
|
7271
|
+
items:
|
|
7272
|
+
type: string
|
|
7273
|
+
format: uuid
|
|
7274
|
+
policy_count:
|
|
7275
|
+
type: integer
|
|
7276
|
+
status:
|
|
7277
|
+
type: string
|
|
7278
|
+
already_claimed:
|
|
7279
|
+
type: boolean
|
|
7280
|
+
expired:
|
|
7281
|
+
type: boolean
|
|
7282
|
+
return_to:
|
|
7283
|
+
type: string
|
|
7284
|
+
nullable: true
|
|
7285
|
+
|
|
7286
|
+
ClaimRedeemResponse:
|
|
7287
|
+
type: object
|
|
7288
|
+
properties:
|
|
7289
|
+
status:
|
|
7290
|
+
type: string
|
|
7291
|
+
connection_id:
|
|
7292
|
+
type: string
|
|
7293
|
+
format: uuid
|
|
7294
|
+
vault_ids:
|
|
7295
|
+
type: array
|
|
7296
|
+
items:
|
|
7297
|
+
type: string
|
|
7298
|
+
format: uuid
|
|
7299
|
+
agent_ids:
|
|
7300
|
+
type: array
|
|
7301
|
+
items:
|
|
7302
|
+
type: string
|
|
7303
|
+
format: uuid
|
|
7304
|
+
return_to:
|
|
7305
|
+
type: string
|
|
7306
|
+
nullable: true
|
|
7307
|
+
dashboard_url:
|
|
7308
|
+
type: string
|