Skip to content

Commit 2079be3

Browse files
chore: Namananand/ins 2271 update sdk params (#28)
Because - update SDK params This commit - update SDK params
1 parent 046c5c0 commit 2079be3

File tree

1 file changed

+38
-54
lines changed

1 file changed

+38
-54
lines changed

README.md

Lines changed: 38 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -64,38 +64,24 @@ import InstillClient, {
6464
6565
export default function TypescriptSdkDemo() {
6666
const [user, setUser] = useState<User[]>([]);
67-
const [token, setToken] = useState<Nullable<string>>(null);
6867
69-
const client = new InstillClient("http://localhost:8080", "v1alpha", token);
70-
71-
const login = async () => {
72-
const userToken = await client.Auth.authLoginAction({
73-
payload: {
74-
username: "admin",
75-
password: "password",
76-
},
77-
});
78-
79-
setToken(userToken);
80-
};
68+
const client = new InstillClient(
69+
"http://localhost:8080",
70+
"v1alpha",
71+
"" // get console API token from `http://localhost:3000/settings`
72+
);
8173
8274
useEffect(() => {
83-
login();
75+
client.Auth.getUserQuery()
76+
.then((data: any) => {
77+
console.log("data", data);
78+
setUser(data);
79+
})
80+
.catch((error: any) => {
81+
console.log("error", error);
82+
});
8483
}, []);
8584
86-
useEffect(() => {
87-
if (token) {
88-
client.Auth.getUserQuery()
89-
.then((data: any) => {
90-
console.log("data", data);
91-
setUser(data);
92-
})
93-
.catch((error: any) => {
94-
console.log("error", error);
95-
});
96-
}
97-
}, [token]);
98-
9985
return (
10086
<>
10187
<h1>User Data</h1>
@@ -166,7 +152,6 @@ export default function TypescriptSdkDemo() {
166152
}
167153
```
168154

169-
170155
### Next APP
171156

172157
- [next-app](./examples/next-app/)
@@ -179,10 +164,10 @@ export default function TypescriptSdkDemo() {
179164

180165
### Pipelines
181166

182-
| function | params |
183-
| :------------------------------------ | :----------------------------------------------------------: |
167+
| function | params |
168+
| :------------------------------------ | :---------------------------------------------: |
184169
| listPipelinesQuery | pageSize, nextPageToken |
185-
| listUserPipelinesQuery | pageSize, nextPageToken, userName |
170+
| listUserPipelinesQuery | pageSize, nextPageToken, userName |
186171
| getUserPipelineQuery | pipelineName |
187172
| ListUserPipelineReleasesQuery | userName, pipelineName, pageSize, nextPageToken |
188173
| getUserPipelineReleaseQuery | pipelineReleaseName |
@@ -194,30 +179,30 @@ export default function TypescriptSdkDemo() {
194179
| createUserPipelineReleaseMutation | pipelineName, payload |
195180
| updateUserPipelineReleaseMutation | pipelineReleaseName, payload |
196181
| deleteUserPipelineReleaseMutation | pipelineReleaseName |
197-
| triggerUserPipelineAction | pipelineName, payload, returnTraces |
198-
| triggerAsyncUserPipelineAction | pipelineName, payload, returnTraces |
182+
| triggerUserPipelineAction | pipelineName, payload, returnTraces |
183+
| triggerAsyncUserPipelineAction | pipelineName, payload, returnTraces |
199184
| setDefaultUserPipelineReleaseMutation | pipelineReleaseName |
200185
| restoreUserPipelineReleaseMutation | pipelineReleaseName |
201-
| triggerUserPipelineReleaseAction | pipelineReleaseName, payload, returnTraces |
202-
| triggerAsyncUserPipelineReleaseAction | pipelineReleaseName, payload, returnTraces |
186+
| triggerUserPipelineReleaseAction | pipelineReleaseName, payload, returnTraces |
187+
| triggerAsyncUserPipelineReleaseAction | pipelineReleaseName, payload, returnTraces |
203188

204189
### Connector
205190

206191
| function | params |
207192
| :---------------------------------------- | :---------------------------------------: |
208193
| listConnectorResourcesQuery | userName, pageSize, nextPageToken, filter |
209194
| listUserConnectorResourcesQuery | pageSize, nextPageToken, filter |
210-
| listConnectorDefinitionsQuery | connectorDefinitionName |
211-
| getConnectorDefinitionQuery | connectorDefinitionName |
212-
| getUserConnectorResourceQuery | connectorDefinitionName |
213-
| watchUserConnectorResource | userName, payload |
214-
| createUserConnectorResourceMutation | connectorDefinitionName |
215-
| deleteUserConnectorResourceMutation | payload |
216-
| updateUserConnectorResourceMutation | payload |
217-
| renameUserConnectorResource | payload |
218-
| testUserConnectorResourceConnectionAction | connectorDefinitionName |
219-
| connectUserConnectorResourceAction | connectorDefinitionName |
220-
| disconnectUserConnectorResourceAction | connectorDefinitionName |
195+
| listConnectorDefinitionsQuery | connectorDefinitionName |
196+
| getConnectorDefinitionQuery | connectorDefinitionName |
197+
| getUserConnectorResourceQuery | connectorDefinitionName |
198+
| watchUserConnectorResource | userName, payload |
199+
| createUserConnectorResourceMutation | connectorDefinitionName |
200+
| deleteUserConnectorResourceMutation | payload |
201+
| updateUserConnectorResourceMutation | payload |
202+
| renameUserConnectorResource | payload |
203+
| testUserConnectorResourceConnectionAction | connectorDefinitionName |
204+
| connectUserConnectorResourceAction | connectorDefinitionName |
205+
| disconnectUserConnectorResourceAction | connectorDefinitionName |
221206

222207
### Metric
223208

@@ -231,8 +216,8 @@ modelDefinitionName,
231216

232217
### Model
233218

234-
| function | params |
235-
| :------------------------ | :--------------------------------------------: |
219+
| function | params |
220+
| :------------------------ | :-------------------------------: |
236221
| getModelDefinitionQuery | modelDefinitionName |
237222
| listModelDefinitionsQuery | pageSize, nextPageToken |
238223
| getUserModelQuery | modelName |
@@ -248,24 +233,23 @@ modelDefinitionName,
248233

249234
### Operation
250235

251-
| function | params |
252-
| :------------------------ | :------------------------: |
236+
| function | params |
237+
| :------------------------ | :-----------: |
253238
| getOperationQuery | operationName |
254239
| checkUntilOperationIsDoen | operationName |
255240

256241
### Mgmt
257242

258-
| function | params |
259-
| :--------------------- | :----------------------------------: |
260-
| getUserQuery | apiToken |
243+
| function | params |
244+
| :--------------------- | :---------------------: |
245+
| getUserQuery | |
261246
| checkUserIdExist | id |
262247
| getApiTokenQuery | tokenName |
263248
| listApiTokensQuery | pageSize, nextPageToken |
264249
| updateUserMutation | payload |
265250
| createApiTokenMutation | payload |
266251
| deleteApiTokenMutation | tokenName |
267252

268-
269253
## Contribution Guidelines:
270254

271255
Please refer to the [Contributing Guidelines](./.github/CONTRIBUTING.md) for more details.

0 commit comments

Comments
 (0)