Skip to content

Commit 016fe47

Browse files
zoo-github-actions-auth[bot]github-actions[bot]
zoo-github-actions-auth[bot]
and
github-actions[bot]
authored
Update api spec (#225)
* YOYO NEW API SPEC! * I have generated the latest API! --------- Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
1 parent cfa2b69 commit 016fe47

File tree

5 files changed

+226
-2
lines changed

5 files changed

+226
-2
lines changed

‎examples_test.go

Lines changed: 19 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎kittycad.go.patch.json

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -119,6 +119,14 @@
119119
"op": "add",
120120
"path": "/paths/~1auth~1email~1callback/get/x-go"
121121
},
122+
{
123+
"value": {
124+
"example": "// GetAuthSamlByOrg: GET /auth/saml/{org_id}\n// \n// Redirects the browser straight to the org’s SAML IdP.\n// \n// \n// Parameters\n// \n// \t- `orgId`: A UUID usually v4 or v7\n// \t- `callbackUrl`\n// \n// GetAuthSamlByOrg: GET /auth/saml/{org_id}\n// Redirects the browser straight to the org’s SAML IdP.\n//\n// Parameters\n//\n// - `orgId`: A UUID usually v4 or v7\n// - `callbackUrl`\nfunc ExampleHiddenService_GetAuthSamlByOrg() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tif err := client.Hidden.GetAuthSamlByOrg(kittycad.ParseUUID(\"6ba7b810-9dad-11d1-80b4-00c04fd430c8\"), kittycad.URL{\u0026url.URL{Scheme: \"https\", Host: \"example.com\"}}); err != nil {\n\t\tpanic(err)\n\t}\n\n}\n",
125+
"libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#HiddenService.GetAuthSamlByOrg"
126+
},
127+
"op": "add",
128+
"path": "/paths/~1auth~1saml~1org~1{org_id}~1login/get/x-go"
129+
},
122130
{
123131
"value": {
124132
"example": "// GetAuthSaml: Get a redirect straight to the SAML IdP.\n// \n// The UI uses this to avoid having to ask the API anything about the IdP. It already knows the SAML IdP ID from the path, so it can just link to this path and rely on the API to redirect to the actual IdP.\n// \n// \n// Parameters\n// \n// \t- `providerId`: A UUID usually v4 or v7\n// \t- `callbackUrl`\n// \n// GetAuthSaml: Get a redirect straight to the SAML IdP.\n// The UI uses this to avoid having to ask the API anything about the IdP. It already knows the SAML IdP ID from the path, so it can just link to this path and rely on the API to redirect to the actual IdP.\n//\n// Parameters\n//\n// - `providerId`: A UUID usually v4 or v7\n// - `callbackUrl`\nfunc ExampleHiddenService_GetAuthSaml() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tif err := client.Hidden.GetAuthSaml(kittycad.ParseUUID(\"6ba7b810-9dad-11d1-80b4-00c04fd430c8\"), kittycad.URL{\u0026url.URL{Scheme: \"https\", Host: \"example.com\"}}); err != nil {\n\t\tpanic(err)\n\t}\n\n}\n",

‎paths.go

Lines changed: 43 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎spec.json

Lines changed: 143 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1571,6 +1571,98 @@
15711571
}
15721572
}
15731573
},
1574+
"/auth/saml/org/{org_id}/login": {
1575+
"get": {
1576+
"tags": [
1577+
"hidden"
1578+
],
1579+
"summary": "GET /auth/saml/{org_id}",
1580+
"description": "Redirects the browser straight to the org’s SAML IdP.",
1581+
"operationId": "get_auth_saml_by_org",
1582+
"parameters": [
1583+
{
1584+
"in": "path",
1585+
"name": "org_id",
1586+
"description": "The ID of the organisation that owns the IdP.",
1587+
"required": true,
1588+
"schema": {
1589+
"$ref": "#/components/schemas/Uuid"
1590+
}
1591+
},
1592+
{
1593+
"in": "query",
1594+
"name": "callback_url",
1595+
"description": "The URL to redirect back to after we have authenticated.",
1596+
"schema": {
1597+
"nullable": true,
1598+
"type": "string",
1599+
"format": "uri"
1600+
}
1601+
}
1602+
],
1603+
"responses": {
1604+
"302": {
1605+
"description": "Temporary Redirect",
1606+
"headers": {
1607+
"Access-Control-Allow-Credentials": {
1608+
"description": "Access-Control-Allow-Credentials header.",
1609+
"style": "simple",
1610+
"schema": {
1611+
"nullable": true,
1612+
"type": "string"
1613+
}
1614+
},
1615+
"Access-Control-Allow-Headers": {
1616+
"description": "Access-Control-Allow-Headers header. This is a comma-separated list of headers.",
1617+
"style": "simple",
1618+
"schema": {
1619+
"nullable": true,
1620+
"type": "string"
1621+
}
1622+
},
1623+
"Access-Control-Allow-Methods": {
1624+
"description": "Access-Control-Allow-Methods header.",
1625+
"style": "simple",
1626+
"schema": {
1627+
"nullable": true,
1628+
"type": "string"
1629+
}
1630+
},
1631+
"Access-Control-Allow-Origin": {
1632+
"description": "Access-Control-Allow-Origin header.",
1633+
"style": "simple",
1634+
"schema": {
1635+
"nullable": true,
1636+
"type": "string"
1637+
}
1638+
},
1639+
"Set-Cookie": {
1640+
"description": "Set-Cookie header.",
1641+
"style": "simple",
1642+
"schema": {
1643+
"nullable": true,
1644+
"type": "string"
1645+
}
1646+
},
1647+
"X-Api-Call-Id": {
1648+
"description": "ID for this request. We return it so that users can report this to us and help us debug their problems.",
1649+
"style": "simple",
1650+
"required": true,
1651+
"schema": {
1652+
"type": "string"
1653+
}
1654+
}
1655+
}
1656+
},
1657+
"4XX": {
1658+
"$ref": "#/components/responses/Error"
1659+
},
1660+
"5XX": {
1661+
"$ref": "#/components/responses/Error"
1662+
}
1663+
}
1664+
}
1665+
},
15741666
"/auth/saml/provider/{provider_id}/login": {
15751667
"get": {
15761668
"tags": [
@@ -19306,6 +19398,14 @@
1930619398
"type": "string",
1930719399
"format": "date-time"
1930819400
},
19401+
"conversation_id": {
19402+
"description": "The conversation ID Conversations group different prompts together.",
19403+
"allOf": [
19404+
{
19405+
"$ref": "#/components/schemas/Uuid"
19406+
}
19407+
]
19408+
},
1930919409
"created_at": {
1931019410
"title": "DateTime",
1931119411
"description": "The time and date the API call was created.",
@@ -19412,6 +19512,7 @@
1941219512
}
1941319513
},
1941419514
"required": [
19515+
"conversation_id",
1941519516
"created_at",
1941619517
"id",
1941719518
"model",
@@ -24060,6 +24161,15 @@
2406024161
"type": "string",
2406124162
"format": "date-time"
2406224163
},
24164+
"conversation_id": {
24165+
"nullable": true,
24166+
"description": "The id for the conversation related to this prompt.",
24167+
"allOf": [
24168+
{
24169+
"$ref": "#/components/schemas/Uuid"
24170+
}
24171+
]
24172+
},
2406324173
"created_at": {
2406424174
"title": "DateTime",
2406524175
"description": "The date and time the ML prompt was created.",
@@ -24268,6 +24378,13 @@
2426824378
"free"
2426924379
]
2427024380
},
24381+
{
24382+
"description": "The plus tier.",
24383+
"type": "string",
24384+
"enum": [
24385+
"plus"
24386+
]
24387+
},
2427124388
{
2427224389
"description": "The pro tier.",
2427324390
"type": "string",
@@ -24447,6 +24564,13 @@
2444724564
"free"
2444824565
]
2444924566
},
24567+
{
24568+
"description": "The plus tier.",
24569+
"type": "string",
24570+
"enum": [
24571+
"plus"
24572+
]
24573+
},
2445024574
{
2445124575
"description": "The pro tier.",
2445224576
"type": "string",
@@ -24593,7 +24717,7 @@
2459324717
]
2459424718
},
2459524719
"extrude_method": {
24596-
"description": "Should the extrusion create a new object or be part of the existing object. If a new object is created, the command id will be the id of the newly created object.",
24720+
"description": "Should the extrusion create a new object or be part of the existing object.",
2459724721
"default": "merge",
2459824722
"allOf": [
2459924723
{
@@ -34728,6 +34852,14 @@
3472834852
"type": "string",
3472934853
"format": "date-time"
3473034854
},
34855+
"conversation_id": {
34856+
"description": "The conversation ID Conversations group different prompts together.",
34857+
"allOf": [
34858+
{
34859+
"$ref": "#/components/schemas/Uuid"
34860+
}
34861+
]
34862+
},
3473134863
"created_at": {
3473234864
"title": "DateTime",
3473334865
"description": "The time and date the API call was created.",
@@ -34828,6 +34960,7 @@
3482834960
}
3482934961
},
3483034962
"required": [
34963+
"conversation_id",
3483134964
"created_at",
3483234965
"id",
3483334966
"model",
@@ -34842,6 +34975,15 @@
3484234975
"description": "Body for iterating on models from text prompts.",
3484334976
"type": "object",
3484434977
"properties": {
34978+
"conversation_id": {
34979+
"nullable": true,
34980+
"description": "The conversation ID Conversations group different prompts together. This should be omitted when starting a new conversation. The conversation_id returned in the response should be used to link future messages in the same conversation.",
34981+
"allOf": [
34982+
{
34983+
"$ref": "#/components/schemas/Uuid"
34984+
}
34985+
]
34986+
},
3484534987
"kcl_version": {
3484634988
"nullable": true,
3484734989
"description": "The version of kcl to use. If empty, the latest version will be used.",

‎types.go

Lines changed: 13 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)