Skip to content

Commit b25e854

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

File tree

5 files changed

+727
-0
lines changed

5 files changed

+727
-0
lines changed

examples_test.go

Lines changed: 42 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: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -663,6 +663,14 @@
663663
"op": "add",
664664
"path": "/paths/~1orgs~1{id}/get/x-go"
665665
},
666+
{
667+
"value": {
668+
"example": "// AdminDetailsList: Get admin-only details for an organization.\n// \n// Zoo admins can retrieve extended information about any organization, while non-admins receive a 404 to avoid leaking existence.\n// \n// \n// Parameters\n// \n// \t- `id`: A UUID usually v4 or v7\n// \n// AdminDetailsList: Get admin-only details for an organization.\n// Zoo admins can retrieve extended information about any organization, while non-admins receive a 404 to avoid leaking existence.\n//\n// Parameters\n//\n// - `id`: A UUID usually v4 or v7\nfunc ExampleOrgService_AdminDetailsList() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.Org.AdminDetailsList(kittycad.ParseUUID(\"6ba7b810-9dad-11d1-80b4-00c04fd430c8\"))\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n",
669+
"libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#OrgService.AdminDetailsList"
670+
},
671+
"op": "add",
672+
"path": "/paths/~1orgs~1{id}~1admin~1details/get/x-go"
673+
},
666674
{
667675
"value": {
668676
"example": "// UpdateEnterprisePricingFor: Set the enterprise price for an organization.\n// \n// You must be a Zoo admin to perform this request.\n// \n// \n// Parameters\n// \n// \t- `id`: A UUID usually v4 or v7\n// \t- `body`: The price for an enterprise subscription.\n// \n// UpdateEnterprisePricingFor: Set the enterprise price for an organization.\n// You must be a Zoo admin to perform this request.\n//\n// Parameters\n//\n// - `id`: A UUID usually v4 or v7\n// - `body`: The price for an enterprise subscription.\nfunc ExampleOrgService_UpdateEnterprisePricingFor() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.Org.UpdateEnterprisePricingFor(kittycad.ParseUUID(\"6ba7b810-9dad-11d1-80b4-00c04fd430c8\"), \"\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n",
@@ -1151,6 +1159,14 @@
11511159
"op": "add",
11521160
"path": "/paths/~1users~1{id}/get/x-go"
11531161
},
1162+
{
1163+
"value": {
1164+
"example": "// AdminDetailsList: Get admin-only details for a user.\n// \n// Zoo admins can retrieve extended information about any user, while non-admins receive a 404 to avoid leaking the existence of the resource.\n// \n// \n// Parameters\n// \n// \t- `id`\n// \n// AdminDetailsList: Get admin-only details for a user.\n// Zoo admins can retrieve extended information about any user, while non-admins receive a 404 to avoid leaking the existence of the resource.\n//\n// Parameters\n//\n// - `id`\nfunc ExampleUserService_AdminDetailsList() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.User.AdminDetailsList(\"some-string\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n",
1165+
"libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#UserService.AdminDetailsList"
1166+
},
1167+
"op": "add",
1168+
"path": "/paths/~1users~1{id}~1admin~1details/get/x-go"
1169+
},
11541170
{
11551171
"value": {
11561172
"example": "// ListForUser: List API calls for a user.\n// \n// This endpoint requires authentication by any Zoo user. It returns the API calls for the authenticated user if \"me\" is passed as the user id.\n// \n// Alternatively, you can use the `/user/api-calls` endpoint to get the API calls for your user.\n// \n// If the authenticated user is a Zoo employee, then the API calls are returned for the user specified by the user id.\n// \n// The API calls are returned in order of creation, with the most recently created API calls first.\n// \n// \n// Parameters\n// \n// \t- `id`\n// \t- `limit`\n// \t- `pageToken`\n// \t- `sortBy`: Supported set of sort modes for scanning by created_at only.\n// \t\t\n// \t\tCurrently, we only support scanning in ascending order.\n// \n// ListForUser: List API calls for a user.\n// This endpoint requires authentication by any Zoo user. It returns the API calls for the authenticated user if \"me\" is passed as the user id.\n//\n// Alternatively, you can use the `/user/api-calls` endpoint to get the API calls for your user.\n//\n// If the authenticated user is a Zoo employee, then the API calls are returned for the user specified by the user id.\n//\n// The API calls are returned in order of creation, with the most recently created API calls first.\n//\n// Parameters\n//\n// - `id`\n//\n// - `limit`\n//\n// - `pageToken`\n//\n// - `sortBy`: Supported set of sort modes for scanning by created_at only.\n//\n// Currently, we only support scanning in ascending order.\nfunc ExampleAPICallService_ListForUser() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.APICall.ListForUser(\"some-string\", 123, \"some-string\", \"\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n",

paths.go

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

0 commit comments

Comments
 (0)