From 5b99567a00cf15f994beb7da595891fe45c8c8e1 Mon Sep 17 00:00:00 2001 From: Naman Anand Date: Fri, 24 May 2024 16:29:18 +0530 Subject: [PATCH] chore: update example --- README.md | 104 +++++++++++++------------- examples/next-app/package.json | 2 +- examples/next-app/pnpm-lock.yaml | 8 +- examples/next-app/src/pages/index.tsx | 2 +- examples/node-app/package.json | 2 +- examples/node-app/pnpm-lock.yaml | 8 +- examples/node-app/server.js | 2 +- 7 files changed, 63 insertions(+), 65 deletions(-) diff --git a/README.md b/README.md index 14335fa..4dca4c5 100644 --- a/README.md +++ b/README.md @@ -114,7 +114,7 @@ export default function TypescriptSdkDemo() { ); useEffect(() => { - client.Auth.getUserQuery() + client.Auth.getUserQuery({ userName: "users/admin" }) .then((data: any) => { console.log("data", data); setUser(data); @@ -229,27 +229,27 @@ client.PipelineClient.createUserPipelineMutation("", ``` -| function | params | -| :------------------------------------ | :---------------------------------------------: | -| listPipelinesQuery | pageSize, nextPageToken, enablePagination | +| function | params | +| :------------------------------------ | :-------------------------------------------------: | +| listPipelinesQuery | pageSize, nextPageToken, enablePagination | | listUserPipelinesQuery | pageSize, nextPageToken, userName, enablePagination | -| getUserPipelineQuery | pipelineName | -| ListUserPipelineReleasesQuery | userName, pipelineName, pageSize, nextPageToken | -| getUserPipelineReleaseQuery | pipelineReleaseName | -| watchUserPipelineReleaseQuery | pipelineReleaseName | -| createUserPipelineMutation | userName, payload | -| updateUserPipelineMutation | payload | -| deleteUserPipelineMutation | pipelineName | -| renameUserPipelineMutation | payload | -| createUserPipelineReleaseMutation | pipelineName, payload | -| updateUserPipelineReleaseMutation | pipelineReleaseName, payload | -| deleteUserPipelineReleaseMutation | pipelineReleaseName | +| getUserPipelineQuery | pipelineName | +| ListUserPipelineReleasesQuery | userName, pipelineName, pageSize, nextPageToken | +| getUserPipelineReleaseQuery | pipelineReleaseName | +| watchUserPipelineReleaseQuery | pipelineReleaseName | +| createUserPipelineMutation | userName, payload | +| updateUserPipelineMutation | payload | +| deleteUserPipelineMutation | pipelineName | +| renameUserPipelineMutation | payload | +| createUserPipelineReleaseMutation | pipelineName, payload | +| updateUserPipelineReleaseMutation | pipelineReleaseName, payload | +| deleteUserPipelineReleaseMutation | pipelineReleaseName | | triggerUserPipelineAction | pipelineName, payload, returnTraces, shareCode | -| triggerAsyncUserPipelineAction | pipelineName, payload, returnTraces | -| setDefaultUserPipelineReleaseMutation | pipelineReleaseName | -| restoreUserPipelineReleaseMutation | pipelineReleaseName | -| triggerUserPipelineReleaseAction | pipelineReleaseName, payload, returnTraces | -| triggerAsyncUserPipelineReleaseAction | pipelineReleaseName, payload, returnTraces | +| triggerAsyncUserPipelineAction | pipelineName, payload, returnTraces | +| setDefaultUserPipelineReleaseMutation | pipelineReleaseName | +| restoreUserPipelineReleaseMutation | pipelineReleaseName | +| triggerUserPipelineReleaseAction | pipelineReleaseName, payload, returnTraces | +| triggerAsyncUserPipelineReleaseAction | pipelineReleaseName, payload, returnTraces | ### Connector @@ -275,21 +275,21 @@ query.ConnectorClient.createUserConnectorMutation("", }) ``` -| function | params | -| :---------------------------------------- | :---------------------------------------: | -| listConnectorsQuery | pageSize, nextPageToken, filter | -| listUserConnectorsQuery | userName, pageSize, nextPageToken, filter | -| listConnectorDefinitionsQuery | connectorDefinitionName | -| getConnectorDefinitionQuery | connectorDefinitionName | -| getUserConnectorQuery | connectorName | -| watchUserConnector | connectorName | -| createUserConnectorMutation | entityName, payload | -| deleteUserConnectorMutation | connectorName | -| updateUserConnectorMutation | payload | -| renameUserConnector | payload | -| testUserConnectorConnectionAction | connectorName | -| connectUserConnectorAction | connectorName | -| disconnectUserConnectorAction | connectorName | +| function | params | +| :-------------------------------- | :---------------------------------------: | +| listConnectorsQuery | pageSize, nextPageToken, filter | +| listUserConnectorsQuery | userName, pageSize, nextPageToken, filter | +| listConnectorDefinitionsQuery | connectorDefinitionName | +| getConnectorDefinitionQuery | connectorDefinitionName | +| getUserConnectorQuery | connectorName | +| watchUserConnector | connectorName | +| createUserConnectorMutation | entityName, payload | +| deleteUserConnectorMutation | connectorName | +| updateUserConnectorMutation | payload | +| renameUserConnector | payload | +| testUserConnectorConnectionAction | connectorName | +| connectUserConnectorAction | connectorName | +| disconnectUserConnectorAction | connectorName | ### Metric @@ -323,23 +323,21 @@ query.ConnectorClient.createUserConnectorMutation("", | getOperationQuery | operationName | | checkUntilOperationIsDoen | operationName | - ### Oraganization -| function | params | -| :--------------------------------- | :-----------------------------: | -| getOrganizationMembershipQuery | organizationID, userID | -| getOrganizationQuery | organizationID | -| getUserMembershipQuery | organizationID, userID | -| getUserMembershipsQuery | userID | -| listOrganizationsQuery | pageSize, nextPageToken, filter | -| createOrganizationMutation | payload | -| deleteOrganizationMutation | organizationName | -| deleteUserMembershipMutation | organizationID, userID | -| updateOrganizationMembershipMutation | payload | -| updateOrganizationMutation | payload | -| updateUserMembershipMutation | payload | - +| function | params | +| :----------------------------------- | :-----------------------------: | +| getOrganizationMembershipQuery | organizationID, userID | +| getOrganizationQuery | organizationID | +| getUserMembershipQuery | organizationID, userID | +| getUserMembershipsQuery | userID | +| listOrganizationsQuery | pageSize, nextPageToken, filter | +| createOrganizationMutation | payload | +| deleteOrganizationMutation | organizationName | +| deleteUserMembershipMutation | organizationID, userID | +| updateOrganizationMembershipMutation | payload | +| updateOrganizationMutation | payload | +| updateUserMembershipMutation | payload | ### Mgmt @@ -360,16 +358,16 @@ client.AuthClient.createApiTokenMutation({ ``` | function | params | -| :--------------------- | :---------------------: | +| :------------------------------ | :---------------------: | | getUserQuery | userName | -| getAuthenticatedUserQuery | | +| getAuthenticatedUserQuery | | | checkUserIdExist | id | | getApiTokenQuery | tokenName | | listApiTokensQuery | pageSize, nextPageToken | | updateAuthenticatedUserMutation | payload | | createApiTokenMutation | payload | | deleteApiTokenMutation | tokenName | -| checkNamespace | id | +| checkNamespace | id | ## Contribution Guidelines: diff --git a/examples/next-app/package.json b/examples/next-app/package.json index d88427f..43b1d74 100644 --- a/examples/next-app/package.json +++ b/examples/next-app/package.json @@ -9,7 +9,7 @@ "lint": "next lint" }, "dependencies": { - "instill-sdk": "0.0.6", + "instill-sdk": "0.0.7", "next": "^14.2.3", "react": "latest", "react-dom": "latest" diff --git a/examples/next-app/pnpm-lock.yaml b/examples/next-app/pnpm-lock.yaml index 934678c..b39b7e3 100644 --- a/examples/next-app/pnpm-lock.yaml +++ b/examples/next-app/pnpm-lock.yaml @@ -6,8 +6,8 @@ settings: dependencies: instill-sdk: - specifier: 0.0.6 - version: 0.0.6 + specifier: 0.0.7 + version: 0.0.7 next: specifier: ^14.2.3 version: 14.2.3(react-dom@18.2.0)(react@18.2.0) @@ -236,8 +236,8 @@ packages: resolution: {integrity: sha512-RbJ5/jmFcNNCcDV5o9eTnBLJ/HszWV0P73bc+Ff4nS/rJj+YaS6IGyiOL0VoBYX+l1Wrl3k63h/KrH+nhJ0XvQ==} dev: false - /instill-sdk@0.0.6: - resolution: {integrity: sha512-GBl0yR3iBp3DH5WBeHmBv8YqHieEWzz0qqjE07k8LsNFCe1n4AbkkBI7nUg0/WtTDUT+mZIYNWD1n4Oi2C4NJw==} + /instill-sdk@0.0.7: + resolution: {integrity: sha512-MS8YWqyTIc54PSjQ3CMg7BaHBKzGNNIzRHfFR58EzHPZKIpm2eRBsC/SrYMQ6br9a70XzjesUlbePvoylx4rLg==} dependencies: '@types/json-schema': 7.0.13 axios: 1.6.8 diff --git a/examples/next-app/src/pages/index.tsx b/examples/next-app/src/pages/index.tsx index ea8f7be..b2caaa4 100644 --- a/examples/next-app/src/pages/index.tsx +++ b/examples/next-app/src/pages/index.tsx @@ -12,7 +12,7 @@ export default function TypescriptSdkDemo() { ); useEffect(() => { - client.Auth.getUserQuery() + client.Auth.getUserQuery({ userName: "users/admin" }) .then((data: any) => { console.log("data", data); setUser(data); diff --git a/examples/node-app/package.json b/examples/node-app/package.json index e883c3f..e184497 100644 --- a/examples/node-app/package.json +++ b/examples/node-app/package.json @@ -4,7 +4,7 @@ "description": "", "main": "index.js", "dependencies": { - "instill-sdk": "0.0.6", + "instill-sdk": "0.0.7", "express": "^4.19.2" }, "scripts": { diff --git a/examples/node-app/pnpm-lock.yaml b/examples/node-app/pnpm-lock.yaml index 7e0ff16..4bdca04 100644 --- a/examples/node-app/pnpm-lock.yaml +++ b/examples/node-app/pnpm-lock.yaml @@ -9,8 +9,8 @@ dependencies: specifier: ^4.19.2 version: 4.19.2 instill-sdk: - specifier: 0.0.6 - version: 0.0.6 + specifier: 0.0.7 + version: 0.0.7 packages: @@ -283,8 +283,8 @@ packages: resolution: {integrity: sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ==} dev: false - /instill-sdk@0.0.6: - resolution: {integrity: sha512-GBl0yR3iBp3DH5WBeHmBv8YqHieEWzz0qqjE07k8LsNFCe1n4AbkkBI7nUg0/WtTDUT+mZIYNWD1n4Oi2C4NJw==} + /instill-sdk@0.0.7: + resolution: {integrity: sha512-MS8YWqyTIc54PSjQ3CMg7BaHBKzGNNIzRHfFR58EzHPZKIpm2eRBsC/SrYMQ6br9a70XzjesUlbePvoylx4rLg==} dependencies: '@types/json-schema': 7.0.13 axios: 1.6.8 diff --git a/examples/node-app/server.js b/examples/node-app/server.js index d595c23..624c798 100644 --- a/examples/node-app/server.js +++ b/examples/node-app/server.js @@ -13,7 +13,7 @@ const client = new InstillClient( // Define a route for listing pipelines using the SDK app.get("/", async (req, res) => { try { - const data = await client.Auth.getUserQuery(); + const data = await client.Auth.getUserQuery({ userName: "users/admin" }); res.json(data); } catch (error) { console.error("Error:", error);