@clarify-labs/templates 0.11.3 → 0.11.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
|
@@ -20,18 +20,18 @@ OpenAPI `description` strings render Markdown in both full references and embedd
|
|
|
20
20
|
## Embed one operation
|
|
21
21
|
|
|
22
22
|
```mdx
|
|
23
|
-
<OpenApiOperation specPath="/api"
|
|
23
|
+
<OpenApiOperation specPath="/api" operationId="listProjects" />
|
|
24
24
|
```
|
|
25
25
|
|
|
26
|
-
<OpenApiOperation specPath="/api"
|
|
26
|
+
<OpenApiOperation specPath="/api" operationId="listProjects" />
|
|
27
27
|
|
|
28
28
|
## Embed a request body operation
|
|
29
29
|
|
|
30
30
|
```mdx
|
|
31
|
-
<OpenApiOperation specPath="/api"
|
|
31
|
+
<OpenApiOperation specPath="/api" operationId="createProject" />
|
|
32
32
|
```
|
|
33
33
|
|
|
34
|
-
<OpenApiOperation specPath="/api"
|
|
34
|
+
<OpenApiOperation specPath="/api" operationId="createProject" />
|
|
35
35
|
|
|
36
36
|
## Embed the full API page
|
|
37
37
|
|
|
@@ -60,6 +60,6 @@ export const feature: Feature = {
|
|
|
60
60
|
|
|
61
61
|
Use `OpenApiOperation` to embed a single operation from the site’s OpenAPI spec:
|
|
62
62
|
|
|
63
|
-
<OpenApiOperation specPath="/api"
|
|
63
|
+
<OpenApiOperation specPath="/api" operationId="listProjects" />
|
|
64
64
|
|
|
65
|
-
<OpenApiOperation specPath="/api"
|
|
65
|
+
<OpenApiOperation specPath="/api" operationId="createProject" />
|
|
@@ -20,18 +20,18 @@ OpenAPI 的 `description` 字符串会在完整参考页和嵌入式操作中渲
|
|
|
20
20
|
## 嵌入单个操作
|
|
21
21
|
|
|
22
22
|
```mdx
|
|
23
|
-
<OpenApiOperation specPath="/api"
|
|
23
|
+
<OpenApiOperation specPath="/api" operationId="listProjects" />
|
|
24
24
|
```
|
|
25
25
|
|
|
26
|
-
<OpenApiOperation specPath="/api"
|
|
26
|
+
<OpenApiOperation specPath="/api" operationId="listProjects" />
|
|
27
27
|
|
|
28
28
|
## 嵌入带请求体的操作
|
|
29
29
|
|
|
30
30
|
```mdx
|
|
31
|
-
<OpenApiOperation specPath="/api"
|
|
31
|
+
<OpenApiOperation specPath="/api" operationId="createProject" />
|
|
32
32
|
```
|
|
33
33
|
|
|
34
|
-
<OpenApiOperation specPath="/api"
|
|
34
|
+
<OpenApiOperation specPath="/api" operationId="createProject" />
|
|
35
35
|
|
|
36
36
|
## 嵌入完整 API 页面
|
|
37
37
|
|
|
@@ -60,6 +60,6 @@ export const feature: Feature = {
|
|
|
60
60
|
|
|
61
61
|
使用 `OpenApiOperation` 可以从站点的 OpenAPI spec 中嵌入单个操作：
|
|
62
62
|
|
|
63
|
-
<OpenApiOperation specPath="/api"
|
|
63
|
+
<OpenApiOperation specPath="/api" operationId="listProjects" />
|
|
64
64
|
|
|
65
|
-
<OpenApiOperation specPath="/api"
|
|
65
|
+
<OpenApiOperation specPath="/api" operationId="createProject" />
|