Skip to content

Commit 7ff2161

Browse files
authored
fix: Display the deprecated tag in the api directory. (#37)
* fix: add deprecated tag and update api search label. * fix: Display the deprecated flag in the api directory. * docs:update readme * docs:update readme * docs:update readme * fix:Remove the method in the title * fix: package.json scripts
1 parent 6114f56 commit 7ff2161

File tree

10 files changed

+134
-197
lines changed

10 files changed

+134
-197
lines changed

CHANGELOG.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Release Notes
2+
3+
## v0.0.9
4+
5+
- The UI was optimized and a deprecated tag was added to indicate that the API is not recommended.
6+
7+
## v0.0.8
8+
9+
- Fixed some Windows compatibility issues.
10+
- Optimized the UI interface of webview.
11+
12+
## v0.0.7
13+
14+
- Launch experience satisfaction questionnaire survey
15+
- You are welcome to submit your questions and suggestions on the [experience questionnaire](https://g.alicdn.com/aes/tracker-survey-preview/0.0.13/survey.html?pid=fePxMy&id=3486).
16+
17+
## v0.0.6
18+
19+
- Surpport code snippets.
20+
21+
## v0.0.5
22+
23+
- Added aliyun-cli installation instructions.
24+
25+
## v0.0.3
26+
27+
- Support API calling.
28+
- Support SDK code sample.
29+
30+
## v0.0.1
31+
32+
Initial release
33+
34+
- Support product searching and subscription.
35+
- Support API searching.
36+
- Support API Document View.

README.en-US.md

Lines changed: 0 additions & 69 deletions
This file was deleted.

README.md

Lines changed: 33 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -8,40 +8,42 @@ The Alibaba Cloud API Toolkit for VSCode makes it easier to access Alibaba Cloud
88

99
English | [简体中文](./README.zh_CN.md)
1010

11-
## Features
12-
* **Alicloud Product Subscription:** You can search for Alicloud products and subscribe to its APIs you want to use.
11+
## Features
1312

14-
* **API Searching:** You can search the Open API of Alibaba Cloud products to which you are subscribed.
13+
- **Alicloud Product Subscription:** You can search for Alicloud products and subscribe to its APIs you want to use.
1514

16-
* **API Document View:** Clicking on an API can navigate you to a new tab which displays the corresponding API document,
17-
including descriptions, request parameters, response parameters and error codes.
15+
- **API Searching:** You can search the Open API of Alibaba Cloud products to which you are subscribed.
1816

19-
* **Call the API:** You can use the form to call the Alibaba Cloud API and see the response.
20-
21-
* **SDK Code Sample:** You can get the SDK code samples and quickly open the corresponding SDK code in VS Code.
17+
- **API Document View:** Clicking on an API can navigate you to a new tab which displays the corresponding API document,
18+
including descriptions, request parameters, response parameters and error codes.
2219

23-
* **Code Snippets:** You can use the code snippets to quickly generate the code.
20+
- **Call the API:** You can use the form to call the Alibaba Cloud API and see the response.
21+
- **SDK Code Sample:** You can get the SDK code samples and quickly open the corresponding SDK code in VS Code.
2422

25-
* More features are under development, please stay tuned.
23+
- **Code Snippets:** You can use the code snippets to quickly generate the code.
24+
25+
- More features are under development, please stay tuned.
2626

2727
## Extension UI Guide
2828

29-
![VSCode Extension Guide](https://img.alicdn.com/imgextra/i1/O1CN01rOmqbK1pOoGtdWxFO_!!6000000005351-0-tps-2462-1440.jpg)
29+
![VSCode Extension Guide](https://img.alicdn.com/imgextra/i2/O1CN01t993u81InC3xh7RVU_!!6000000000937-0-tps-2328-1646.jpg)
3030

3131
### Product Searching `ctrl+cmd+k`
32-
32+
3333
![Product Searching](https://img.alicdn.com/imgextra/i1/O1CN01bcJ5DM1RpmnlOjDHK_!!6000000002161-0-tps-1202-798.jpg)
34-
34+
3535
### API Searching `ctrl+cmd+l`
3636

37-
![API Serching](https://img.alicdn.com/imgextra/i1/O1CN01KaWkBF1UfCUkY0N3v_!!6000000002544-0-tps-1286-518.jpg)
37+
![API Serching](https://img.alicdn.com/imgextra/i4/O1CN01KCrc1a1vooTmC9a1h_!!6000000006220-0-tps-1986-542.jpg)
3838

3939
### Call the API
4040

41-
The feature requires you to configure your AK/SK information as follows:
42-
1. Install [Alibaba Cloud CLI Tools](https://marketplace.visualstudio.com/items?itemName=alibabacloud-openapi.aliyuncli) extentions.
43-
2. Install [aliyun-cli](https://github.com/aliyun/aliyun-cli?tab=readme-ov-file#installation).
44-
3. You can run the `aliyun configure` command for quick configuration.
41+
The feature requires you to configure your AK/SK information as follows:
42+
43+
1. Install Aliyun CLI: [Install guide](https://www.alibabacloud.com/help/en/cli/installation-guide).
44+
2. Install [Alibaba Cloud CLI Tools](https://marketplace.visualstudio.com/items?itemName=alibabacloud-openapi.aliyuncli) extentions.
45+
3. You can run the `aliyun configure` command for quick configuration.
46+
4547
```
4648
$ aliyun configure
4749
Configuring profile 'default' ...
@@ -51,20 +53,23 @@ Default Region Id [None]: cn-hangzhou
5153
Default output format [json]: json
5254
Default Language [zh]: zh
5355
```
56+
5457
4. Click the Alibaba Cloud icon in VS Code status bar to manage your profiles.
55-
![](https://img.alicdn.com/imgextra/i1/O1CN0144NU9N1L4G1cq89Uf_!!6000000001245-0-tps-248-46.jpg)
56-
![](https://img.alicdn.com/imgextra/i2/O1CN01btLUkc1ldEHJQ0w4S_!!6000000004841-0-tps-1206-190.jpg)
57-
5. More information please refer to the [Alibaba Cloud CLI Documentation](https://github.com/aliyun/aliyun-cli?tab=readme-ov-file#configure).
58+
![](https://img.alicdn.com/imgextra/i1/O1CN0144NU9N1L4G1cq89Uf_!!6000000001245-0-tps-248-46.jpg)
59+
![](https://img.alicdn.com/imgextra/i2/O1CN01btLUkc1ldEHJQ0w4S_!!6000000004841-0-tps-1206-190.jpg)
60+
More information please refer to the [Alibaba Cloud CLI Documentation](https://github.com/aliyun/aliyun-cli?tab=readme-ov-file#configure).
5861

59-
![API debug](https://img.alicdn.com/imgextra/i4/O1CN01F1qI7S1BunIFJPiAt_!!6000000000006-0-tps-2618-2050.jpg)
62+
![API debug](https://img.alicdn.com/imgextra/i3/O1CN01yfMcHl1i6lNdjzmzs_!!6000000004364-2-tps-2688-1820.png)
6063

6164
### SDK Code Sample
65+
6266
You can generate the SDK Sample by using the debugger form and then open it in your editor.
6367

64-
![sdk demo](https://img.alicdn.com/imgextra/i1/O1CN01GVhWTl1waRdYmCn7E_!!6000000006324-0-tps-2630-2038.jpg)
68+
![sdk demo](https://img.alicdn.com/imgextra/i1/O1CN01C0vQDB29gTtW5erj4_!!6000000008097-0-tps-2638-1778.jpg)
6569

6670
### Code Snippets
67-
You can use the code snippets to quickly generate the code.
71+
72+
You can use the code snippets to quickly generate the code.
6873

6974
Type your subscribed API into the editor and select the API snippet you want to generate.
7075

@@ -74,38 +79,14 @@ Or use the keyboard shortcuts `ctrl+cmd+l` to search the API and select Insert s
7479
![code snippets](https://img.alicdn.com/imgextra/i3/O1CN01dmGwmX1ZyVHozyKx4_!!6000000003263-1-tps-842-468.gif)
7580

7681
## Feedback
77-
Submit bug reports and feature requests on [our Github repository](https://github.com/aliyun/alibabacloud-api-vscode-toolkit/issues)
78-
.
7982

80-
## Requirements
81-
- Need VS Code 1.75.0 or above.
82-
83-
## Release Notes
84-
85-
### 0.0.8
86-
- Fixed some Windows compatibility issues.
87-
- Optimized the UI interface of webview.
88-
89-
### 0.0.7
90-
- Launch experience satisfaction questionnaire survey
83+
- Submit bug reports and feature requests on [our Github repository](https://github.com/aliyun/alibabacloud-api-vscode-toolkit/issues).
9184
- You are welcome to submit your questions and suggestions on the [experience questionnaire](https://g.alicdn.com/aes/tracker-survey-preview/0.0.13/survey.html?pid=fePxMy&id=3486).
9285

93-
### 0.0.6
94-
- Surpport code snippets.
95-
96-
### 0.0.5
97-
- Added aliyun-cli installation instructions.
98-
99-
### 0.0.3
100-
- Support API calling.
101-
- Support SDK code sample.
86+
## Requirements
10287

103-
### 0.0.1
104-
Initial release
105-
- Support product searching and subscription.
106-
- Support API searching.
107-
- Support API Document View.
88+
- Need VS Code 1.75.0 or above.
10889

10990
## License
11091

111-
See the [Apache License 2.0](./LICENSE).
92+
See the [Apache License 2.0](./LICENSE).

README.zh_CN.md

Lines changed: 10 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -26,22 +26,22 @@ Alibaba Cloud API Toolkit 是一个轻量化的阿里云 API 工具,支持在
2626

2727
## 插件 UI 导览
2828

29-
![VSCode Extension Guide](https://img.alicdn.com/imgextra/i1/O1CN01o9s4TT1GTq3oggW7K_!!6000000000624-0-tps-2456-1446.jpg)
29+
![VSCode Extension Guide](https://img.alicdn.com/imgextra/i1/O1CN01tlXFtt1mj0vE1ZrhR_!!6000000004989-0-tps-2498-1768.jpg)
3030

3131
### 产品搜索 `ctrl+cmd+k`
3232

3333
![Product Searching](https://img.alicdn.com/imgextra/i1/O1CN01bcJ5DM1RpmnlOjDHK_!!6000000002161-0-tps-1202-798.jpg)
3434

3535
### API 搜索 `ctrl+cmd+l`
3636

37-
![API Serching](https://img.alicdn.com/imgextra/i1/O1CN01KaWkBF1UfCUkY0N3v_!!6000000002544-0-tps-1286-518.jpg)
37+
![API Serching](https://img.alicdn.com/imgextra/i2/O1CN01ySJXt41c4ZnIbj51N_!!6000000003547-0-tps-1986-542.jpg)
3838

3939
### API 调试
4040

4141
调试功能需要配置你的 AK/SK 信息,配置方法如下:
4242

43-
1. 安装 [Alibaba Cloud CLI Tools](https://marketplace.visualstudio.com/items?itemName=alibabacloud-openapi.aliyuncli) 插件,
44-
2. 打开命令行安装 aliyun-cli `brew install aliyun-cli`
43+
1. 安装阿里云 CLI[安装指南](https://help.aliyun.com/zh/cli/installation-guide)
44+
2. 安装 [Alibaba Cloud CLI Tools](https://marketplace.visualstudio.com/items?;itemName=alibabacloud-openapi.aliyuncli) 插件;
4545
3. 输入 `aliyun configure` 命令,按照提示进行配置,
4646

4747
```
@@ -54,20 +54,18 @@ Default output format [json]: json
5454
Default Language [zh]: zh
5555
```
5656

57-
4. 点击 VS Code 状态栏中的阿里云图标,管理你的 profiles,
57+
4. 点击 VS Code 底部状态栏中的阿里云图标,管理你的 profiles,
5858
![](https://img.alicdn.com/imgextra/i1/O1CN0144NU9N1L4G1cq89Uf_!!6000000001245-0-tps-248-46.jpg)
5959
![](https://img.alicdn.com/imgextra/i2/O1CN01btLUkc1ldEHJQ0w4S_!!6000000004841-0-tps-1206-190.jpg)
60-
1. 更多信息请参考 [Alibaba Cloud CLI Documentation](https://github.com/aliyun/aliyun-cli?tab=readme-ov-file#configure)
60+
更多信息请参考 [Alibaba Cloud CLI Documentation](https://github.com/aliyun/aliyun-cli?tab=readme-ov-file#configure)
6161

62-
![API debug](https://img.alicdn.com/imgextra/i4/O1CN01F1qI7S1BunIFJPiAt_!!6000000000006-0-tps-2618-2050.jpg)
63-
64-
![API debug](https://learn.microsoft.com/zh-cn/visualstudio/ide/media/vs-2022/copilot-chat-visual-studio.gif?view=vs-2022#lightbox)
62+
![API debug](https://img.alicdn.com/imgextra/i3/O1CN01yfMcHl1i6lNdjzmzs_!!6000000004364-2-tps-2688-1820.png)
6563

6664
### SDK 示例
6765

6866
你能够通过调试表单生成 SDK 代码示例,并在编辑器中打开对应的 SDK 代码。
6967

70-
![sdk demo](https://img.alicdn.com/imgextra/i1/O1CN01GVhWTl1waRdYmCn7E_!!6000000006324-0-tps-2630-2038.jpg)
68+
![sdk demo](https://img.alicdn.com/imgextra/i1/O1CN01C0vQDB29gTtW5erj4_!!6000000008097-0-tps-2638-1778.jpg)
7169

7270
### Code Snippets
7371

@@ -83,44 +81,13 @@ Default Language [zh]: zh
8381

8482
## 反馈
8583

86-
欢迎在我们的 [Github repository](https://github.com/aliyun/alibabacloud-api-vscode-toolkit/issues) 上提交你的问题和建议。
84+
- 欢迎在我们的 [Github repository](https://github.com/aliyun/alibabacloud-api-vscode-toolkit/issues) 上提交你的问题和建议。
85+
- 您对插件的使用体验满意吗?点击 [体验问卷](https://g.alicdn.com/aes/tracker-survey-preview/0.0.13/survey.html?pid=fePxMy&id=3486) 进行吐槽或夸赞,您的反馈对我们十分重要!
8786

8887
## Requirements
8988

9089
- Need VS Code 1.75.0 or above.
9190

92-
## Release Notes
93-
94-
### 0.0.8
95-
- Fixed some Windows compatibility issues.
96-
- Optimized the UI interface of webview.
97-
98-
### 0.0.7
99-
100-
- Launch experience satisfaction questionnaire survey.
101-
- You are welcome to submit your questions and suggestions on the [experience questionnaire](https://g.alicdn.com/aes/tracker-survey-preview/0.0.13/survey.html?pid=fePxMy&id=3486).
102-
103-
### 0.0.6
104-
105-
- Surpport code snippets.
106-
107-
### 0.0.5
108-
109-
- Added aliyun-cli installation instructions.
110-
111-
### 0.0.3
112-
113-
- Support API calling.
114-
- Support SDK code sample.
115-
116-
### 0.0.1
117-
118-
Initial release
119-
120-
- Support product searching and subscription.
121-
- Support API searching.
122-
- Support API Document View.
123-
12491
## License
12592

12693
See the [Apache License 2.0](./LICENSE).

media/src/components/APIPage/API.tsx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -181,9 +181,9 @@ export const API: React.FC<APIProps> = (props) => {
181181
<div className="flex h-[calc(100vh_-_140px)] bg-white">
182182
<div className={`expand-arrow ${isExpand ? "" : "!left-1"}`} onClick={() => setIsExpand(!isExpand)}>
183183
{isExpand ? (
184-
<div className="codicon codicon-chevron-left relative top-6 right-0.5"></div>
184+
<div className="codicon codicon-chevron-left relative right-0.5 top-6"></div>
185185
) : (
186-
<div className="codicon codicon-chevron-right relative top-6 right-0.5"></div>
186+
<div className="codicon codicon-chevron-right relative right-0.5 top-6"></div>
187187
)}
188188
</div>
189189
{isExpand && <div className="w-[25rem]">{isExpand && <APIDebugger></APIDebugger>}</div>}
@@ -246,11 +246,11 @@ export const API: React.FC<APIProps> = (props) => {
246246
<div className="flex justify-between">
247247
<div>
248248
<div className="flex">
249-
{selectedApi.method ? (
249+
{/* {selectedApi.method ? (
250250
<div className="h-6 w-16 rounded-sm border-2 border-solid border-emerald-100 bg-emerald-100 text-center text-base font-medium leading-5 text-teal-500 ">
251251
{selectedApi.method?.toUpperCase()}
252252
</div>
253-
) : null}
253+
) : null} */}
254254
{selectedApi.deprecated ? (
255255
<Tag className="my-auto ml-2">
256256
<span className="text-gray-500">deprecated</span>

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -214,7 +214,7 @@
214214
"reinstall": "rimraf node_modules && npm i",
215215
"afterinstall": "cd ../../ && lerna bootstrap",
216216
"build:ncc": "rimraf dist && ncc build ./src/extension.ts -o dist -m --license licenses.txt && mv dist/index.js dist/extension.js",
217-
"vscode:prepublish": "npm run build:ncc",
217+
"vscode:prepublish": "npm run build:media && npm run build:ncc",
218218
"esbuild-base": "esbuild ./src/extension.ts --bundle --outfile=dist/extension.js --external:vscode --format=cjs --platform=node --minify",
219219
"esbuild": "npm run esbuild-base -- --sourcemap",
220220
"esbuild-watch": "npm run esbuild-base -- --sourcemap --watch",

resources/deprecated.svg

Lines changed: 1 addition & 0 deletions
Loading

0 commit comments

Comments
 (0)