Skip to content

Commit 564b030

Browse files
iamnamananand996iamnamananand996
authored
chore: update example (#84)
Because - update example This commit - update example
1 parent 4b08bad commit 564b030

File tree

7 files changed

+63
-65
lines changed

7 files changed

+63
-65
lines changed

‎README.md

+51-53
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ export default function TypescriptSdkDemo() {
114114
);
115115
116116
useEffect(() => {
117-
client.Auth.getUserQuery()
117+
client.Auth.getUserQuery({ userName: "users/admin" })
118118
.then((data: any) => {
119119
console.log("data", data);
120120
setUser(data);
@@ -229,27 +229,27 @@ client.PipelineClient.createUserPipelineMutation("<userName>",
229229
230230
```
231231

232-
| function | params |
233-
| :------------------------------------ | :---------------------------------------------: |
234-
| listPipelinesQuery | pageSize, nextPageToken, enablePagination |
232+
| function | params |
233+
| :------------------------------------ | :-------------------------------------------------: |
234+
| listPipelinesQuery | pageSize, nextPageToken, enablePagination |
235235
| listUserPipelinesQuery | pageSize, nextPageToken, userName, enablePagination |
236-
| getUserPipelineQuery | pipelineName |
237-
| ListUserPipelineReleasesQuery | userName, pipelineName, pageSize, nextPageToken |
238-
| getUserPipelineReleaseQuery | pipelineReleaseName |
239-
| watchUserPipelineReleaseQuery | pipelineReleaseName |
240-
| createUserPipelineMutation | userName, payload |
241-
| updateUserPipelineMutation | payload |
242-
| deleteUserPipelineMutation | pipelineName |
243-
| renameUserPipelineMutation | payload |
244-
| createUserPipelineReleaseMutation | pipelineName, payload |
245-
| updateUserPipelineReleaseMutation | pipelineReleaseName, payload |
246-
| deleteUserPipelineReleaseMutation | pipelineReleaseName |
236+
| getUserPipelineQuery | pipelineName |
237+
| ListUserPipelineReleasesQuery | userName, pipelineName, pageSize, nextPageToken |
238+
| getUserPipelineReleaseQuery | pipelineReleaseName |
239+
| watchUserPipelineReleaseQuery | pipelineReleaseName |
240+
| createUserPipelineMutation | userName, payload |
241+
| updateUserPipelineMutation | payload |
242+
| deleteUserPipelineMutation | pipelineName |
243+
| renameUserPipelineMutation | payload |
244+
| createUserPipelineReleaseMutation | pipelineName, payload |
245+
| updateUserPipelineReleaseMutation | pipelineReleaseName, payload |
246+
| deleteUserPipelineReleaseMutation | pipelineReleaseName |
247247
| triggerUserPipelineAction | pipelineName, payload, returnTraces, shareCode |
248-
| triggerAsyncUserPipelineAction | pipelineName, payload, returnTraces |
249-
| setDefaultUserPipelineReleaseMutation | pipelineReleaseName |
250-
| restoreUserPipelineReleaseMutation | pipelineReleaseName |
251-
| triggerUserPipelineReleaseAction | pipelineReleaseName, payload, returnTraces |
252-
| triggerAsyncUserPipelineReleaseAction | pipelineReleaseName, payload, returnTraces |
248+
| triggerAsyncUserPipelineAction | pipelineName, payload, returnTraces |
249+
| setDefaultUserPipelineReleaseMutation | pipelineReleaseName |
250+
| restoreUserPipelineReleaseMutation | pipelineReleaseName |
251+
| triggerUserPipelineReleaseAction | pipelineReleaseName, payload, returnTraces |
252+
| triggerAsyncUserPipelineReleaseAction | pipelineReleaseName, payload, returnTraces |
253253

254254
### Connector
255255

@@ -275,21 +275,21 @@ query.ConnectorClient.createUserConnectorMutation("<userName>",
275275
})
276276
```
277277

278-
| function | params |
279-
| :---------------------------------------- | :---------------------------------------: |
280-
| listConnectorsQuery | pageSize, nextPageToken, filter |
281-
| listUserConnectorsQuery | userName, pageSize, nextPageToken, filter |
282-
| listConnectorDefinitionsQuery | connectorDefinitionName |
283-
| getConnectorDefinitionQuery | connectorDefinitionName |
284-
| getUserConnectorQuery | connectorName |
285-
| watchUserConnector | connectorName |
286-
| createUserConnectorMutation | entityName, payload |
287-
| deleteUserConnectorMutation | connectorName |
288-
| updateUserConnectorMutation | payload |
289-
| renameUserConnector | payload |
290-
| testUserConnectorConnectionAction | connectorName |
291-
| connectUserConnectorAction | connectorName |
292-
| disconnectUserConnectorAction | connectorName |
278+
| function | params |
279+
| :-------------------------------- | :---------------------------------------: |
280+
| listConnectorsQuery | pageSize, nextPageToken, filter |
281+
| listUserConnectorsQuery | userName, pageSize, nextPageToken, filter |
282+
| listConnectorDefinitionsQuery | connectorDefinitionName |
283+
| getConnectorDefinitionQuery | connectorDefinitionName |
284+
| getUserConnectorQuery | connectorName |
285+
| watchUserConnector | connectorName |
286+
| createUserConnectorMutation | entityName, payload |
287+
| deleteUserConnectorMutation | connectorName |
288+
| updateUserConnectorMutation | payload |
289+
| renameUserConnector | payload |
290+
| testUserConnectorConnectionAction | connectorName |
291+
| connectUserConnectorAction | connectorName |
292+
| disconnectUserConnectorAction | connectorName |
293293

294294
### Metric
295295

@@ -323,23 +323,21 @@ query.ConnectorClient.createUserConnectorMutation("<userName>",
323323
| getOperationQuery | operationName |
324324
| checkUntilOperationIsDoen | operationName |
325325

326-
327326
### Oraganization
328327

329-
| function | params |
330-
| :--------------------------------- | :-----------------------------: |
331-
| getOrganizationMembershipQuery | organizationID, userID |
332-
| getOrganizationQuery | organizationID |
333-
| getUserMembershipQuery | organizationID, userID |
334-
| getUserMembershipsQuery | userID |
335-
| listOrganizationsQuery | pageSize, nextPageToken, filter |
336-
| createOrganizationMutation | payload |
337-
| deleteOrganizationMutation | organizationName |
338-
| deleteUserMembershipMutation | organizationID, userID |
339-
| updateOrganizationMembershipMutation | payload |
340-
| updateOrganizationMutation | payload |
341-
| updateUserMembershipMutation | payload |
342-
328+
| function | params |
329+
| :----------------------------------- | :-----------------------------: |
330+
| getOrganizationMembershipQuery | organizationID, userID |
331+
| getOrganizationQuery | organizationID |
332+
| getUserMembershipQuery | organizationID, userID |
333+
| getUserMembershipsQuery | userID |
334+
| listOrganizationsQuery | pageSize, nextPageToken, filter |
335+
| createOrganizationMutation | payload |
336+
| deleteOrganizationMutation | organizationName |
337+
| deleteUserMembershipMutation | organizationID, userID |
338+
| updateOrganizationMembershipMutation | payload |
339+
| updateOrganizationMutation | payload |
340+
| updateUserMembershipMutation | payload |
343341

344342
### Mgmt
345343

@@ -360,16 +358,16 @@ client.AuthClient.createApiTokenMutation({
360358
```
361359

362360
| function | params |
363-
| :--------------------- | :---------------------: |
361+
| :------------------------------ | :---------------------: |
364362
| getUserQuery | userName |
365-
| getAuthenticatedUserQuery | |
363+
| getAuthenticatedUserQuery | |
366364
| checkUserIdExist | id |
367365
| getApiTokenQuery | tokenName |
368366
| listApiTokensQuery | pageSize, nextPageToken |
369367
| updateAuthenticatedUserMutation | payload |
370368
| createApiTokenMutation | payload |
371369
| deleteApiTokenMutation | tokenName |
372-
| checkNamespace | id |
370+
| checkNamespace | id |
373371

374372
## Contribution Guidelines:
375373

‎examples/next-app/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
"lint": "next lint"
1010
},
1111
"dependencies": {
12-
"instill-sdk": "0.0.6",
12+
"instill-sdk": "0.0.7",
1313
"next": "^14.2.3",
1414
"react": "latest",
1515
"react-dom": "latest"

‎examples/next-app/pnpm-lock.yaml

+4-4
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎examples/next-app/src/pages/index.tsx

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ export default function TypescriptSdkDemo() {
1212
);
1313

1414
useEffect(() => {
15-
client.Auth.getUserQuery()
15+
client.Auth.getUserQuery({ userName: "users/admin" })
1616
.then((data: any) => {
1717
console.log("data", data);
1818
setUser(data);

‎examples/node-app/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
"description": "",
55
"main": "index.js",
66
"dependencies": {
7-
"instill-sdk": "0.0.6",
7+
"instill-sdk": "0.0.7",
88
"express": "^4.19.2"
99
},
1010
"scripts": {

‎examples/node-app/pnpm-lock.yaml

+4-4
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎examples/node-app/server.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ const client = new InstillClient(
1313
// Define a route for listing pipelines using the SDK
1414
app.get("/", async (req, res) => {
1515
try {
16-
const data = await client.Auth.getUserQuery();
16+
const data = await client.Auth.getUserQuery({ userName: "users/admin" });
1717
res.json(data);
1818
} catch (error) {
1919
console.error("Error:", error);

0 commit comments

Comments
 (0)