You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: DEVELOPER_GUIDE.md
+23-21Lines changed: 23 additions & 21 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -72,6 +72,29 @@ All spec insert components accept the following arguments:
72
72
-`component` (String; required): The name of the component to render, such as `query_parameters`, `path_parameters`, or `paths_and_http_methods`.
73
73
-`omit_header` (Boolean; Default is `false`): If set to `true`, the markdown header of the component will not be rendered.
74
74
75
+
### Paths and HTTP methods
76
+
To insert paths and HTTP methods for the `search` API, use the following snippet:
77
+
```markdown
78
+
<!-- spec_insert_start
79
+
api: search
80
+
component: paths_and_http_methods
81
+
-->
82
+
<!-- spec_insert_end -->
83
+
```
84
+
85
+
### Path parameters
86
+
87
+
To insert a path parameters table of the `indices.create` API, use the following snippet. Use the `x-operation-group` field from OpenSearch OpenAPI Spec for the `api` value:
88
+
89
+
```markdown
90
+
<!-- spec_insert_start
91
+
api: indices.create
92
+
component: path_parameters
93
+
-->
94
+
<!-- spec_insert_end -->
95
+
```
96
+
This table accepts the same arguments as the query parameters table except the `include_global` argument.
97
+
75
98
### Query parameters
76
99
To insert the API query parameters table of the `cat.indices` API, use the following snippet:
77
100
```markdown
@@ -110,24 +133,3 @@ pretty: true
110
133
-->
111
134
<!-- spec_insert_end -->
112
135
```
113
-
114
-
### Path parameters
115
-
To insert path parameters table of the `indices.create` API, use the following snippet:
116
-
```markdown
117
-
<!-- spec_insert_start
118
-
api: indices.create
119
-
component: path_parameters
120
-
-->
121
-
<!-- spec_insert_end -->
122
-
```
123
-
This table behaves the same as the query parameters table except that it does not accept the `include_global` argument.
124
-
125
-
### Paths and HTTP methods
126
-
To insert paths and HTTP methods for the `search` API, use the following snippet:
0 commit comments