Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Order sections to reflect API template #8782

Merged
merged 5 commits into from
Nov 20, 2024
Merged

Order sections to reflect API template #8782

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
52206b9
Order sections to reflect API template
Naarcha-AWS Nov 19, 2024
a06ad63
Update DEVELOPER_GUIDE.md
Naarcha-AWS Nov 20, 2024
eee70b8
Update DEVELOPER_GUIDE.md
Naarcha-AWS Nov 20, 2024
e77eee5
Update DEVELOPER_GUIDE.md
Naarcha-AWS Nov 20, 2024
ba2e84d
Merge branch 'main' into api-developer-sections
Naarcha-AWS Nov 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 21 additions & 21 deletions DEVELOPER_GUIDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,27 @@ All spec insert components accept the following arguments:
- `component` (String; required): The name of the component to render, such as `query_parameters`, `path_parameters`, or `paths_and_http_methods`.
- `omit_header` (Boolean; Default is `false`): If set to `true`, the markdown header of the component will not be rendered.

### Paths and HTTP methods
To insert paths and HTTP methods for the `search` API, use the following snippet:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
To insert paths and HTTP methods for the `search` API, use the following snippet:
To insert paths and HTTP methods for the `search` API, use the following snippet:

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For a naive user, could you explain where to get the API name from?

```markdown
<!-- spec_insert_start
api: search
component: paths_and_http_methods
-->
<!-- spec_insert_end -->
```

### Path parameters
To insert path parameters table of the `indices.create` API, use the following snippet:
Naarcha-AWS marked this conversation as resolved.
Show resolved Hide resolved
```markdown
<!-- spec_insert_start
api: indices.create
component: path_parameters
-->
<!-- spec_insert_end -->
```
This table behaves the same as the query parameters table except that it does not accept the `include_global` argument.
Naarcha-AWS marked this conversation as resolved.
Show resolved Hide resolved

### Query parameters
To insert the API query parameters table of the `cat.indices` API, use the following snippet:
```markdown
Expand Down Expand Up @@ -110,24 +131,3 @@ pretty: true
-->
<!-- spec_insert_end -->
```

### Path parameters
To insert path parameters table of the `indices.create` API, use the following snippet:
```markdown
<!-- spec_insert_start
api: indices.create
component: path_parameters
-->
<!-- spec_insert_end -->
```
This table behaves the same as the query parameters table except that it does not accept the `include_global` argument.

### Paths and HTTP methods
To insert paths and HTTP methods for the `search` API, use the following snippet:
```markdown
<!-- spec_insert_start
api: search
component: paths_and_http_methods
-->
<!-- spec_insert_end -->
```
Loading