Skip to content

Commit 5d31d03

Browse files
Naarcha-AWSkolchfa-aws
authored andcommitted
Order sections to reflect API template (opensearch-project#8782)
* Order sections to reflect API template Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Update DEVELOPER_GUIDE.md Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Update DEVELOPER_GUIDE.md Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Update DEVELOPER_GUIDE.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> --------- Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Signed-off-by: Eric Pugh <epugh@opensourceconnections.com>
1 parent 87de954 commit 5d31d03

File tree

1 file changed

+23
-21
lines changed

1 file changed

+23
-21
lines changed

DEVELOPER_GUIDE.md

Lines changed: 23 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,29 @@ All spec insert components accept the following arguments:
7272
- `component` (String; required): The name of the component to render, such as `query_parameters`, `path_parameters`, or `paths_and_http_methods`.
7373
- `omit_header` (Boolean; Default is `false`): If set to `true`, the markdown header of the component will not be rendered.
7474

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+
7598
### Query parameters
7699
To insert the API query parameters table of the `cat.indices` API, use the following snippet:
77100
```markdown
@@ -110,24 +133,3 @@ pretty: true
110133
-->
111134
<!-- spec_insert_end -->
112135
```
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:
127-
```markdown
128-
<!-- spec_insert_start
129-
api: search
130-
component: paths_and_http_methods
131-
-->
132-
<!-- spec_insert_end -->
133-
```

0 commit comments

Comments
 (0)