Updating Example Request with spec_insert tags by ReveristRealm · Pull Request #10546 · opensearch-project/documentation-website

ReveristRealm · 2025-07-31T23:34:51Z

Description

Updated example request with spec insert tags to display python conversions.

Example

Included Script with directions in `DEVELOPER-GUIDE.MD`

Issues Resolved

Closes #[delete this text, including the brackets, and replace with the issue number]

Version

List the OpenSearch version to which this PR applies, e.g. 2.14, 2.12--2.14, or all.

Frontend features

If you're submitting documentation for an OpenSearch Dashboards feature, add a video that shows how a user will interact with the UI step by step. A voiceover is optional.

Checklist

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and subject to the Developers Certificate of Origin.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

Signed-off-by: Daniel Jackson <imdanjac@amazon.com>

…n of API calls into Language SDK. Signed-off-by: Daniel Jackson <imdanjac@amazon.com>

…n of API calls into Language SDK. Refactored code base to make "api" tag optional for quicker tag placements Examples:    Signed-off-by: Daniel Jackson <imdanjac@amazon.com>

…rt' into Spec-Insert->HTTP-to-ProLang_Start

Signed-off-by: Daniel Jackson <imdanjac@amazon.com>

github-actions · 2025-07-31T23:34:59Z

Thank you for submitting your PR. The PR states are In progress (or Draft) -> Tech review -> Doc review -> Editorial review -> Merged.

Before you submit your PR for doc review, make sure the content is technically accurate. If you need help finding a tech reviewer, tag a maintainer.

When you're ready for doc review, tag the assignee of this PR. The doc reviewer may push edits to the PR directly or leave comments and editorial suggestions for you to address (let us know in a comment if you have a preference). The doc reviewer will arrange for an editorial review.

kolchfa-aws · 2025-08-01T13:07:51Z

_api-reference/cat/cat-allocation.md

 ## Query parameters

-The following table lists the available query parameters. All query parameters are optional.
+The following table lists the available query parameters.


@ReveristRealm Why did the "All query parameters are optional." get deleted? It is important information.

- Added test examples to test files. Signed-off-by: Daniel Jackson <imdanjac@amazon.com>

- Added more test examples to fixtures file. - Included test for NDJSON files. - Included test to showcase multi-line for body tag Signed-off-by: Daniel Jackson <imdanjac@amazon.com>

- Changed "include_client_setup" to be called from "insert_arguments.rb" for scalability and clarity. Also changed it so that you have to state "true" or "false". - Included "skip" tag. This is for when you come across a spec-insert that cant be converted to a client.You can do it manually, and it won't mess with future renders - Allowed for the body tag to be in multiple lines instead of one. Signed-off-by: Daniel Jackson <imdanjac@amazon.com>

…rt' into Spec-Insert->HTTP-to-ProLang_Start

- Fixed minor query params issue. - Implemented steps in the developer guide. - Removed un-reachable code logic. - Included example with NDJSON body in test files. Signed-off-by: Daniel Jackson <imdanjac@amazon.com>

…rt' into tags

- Inserted tags on pages to display updated python conversions. - Included script to insert tags with steps in the developer guide for proper use. Signed-off-by: Daniel Jackson <imdanjac@amazon.com>

_api-reference/cat/cat-aliases.md

_api-reference/cat/cat-allocation.md

_api-reference/cat/cat-count.md

_api-reference/cat/cat-field-data.md

_api-reference/cat/cat-pending-tasks.md

_api-reference/cat/cat-pit-segments.md

_api-reference/cat/cat-plugins.md

_api-reference/cat/cat-recovery.md

_api-reference/cat/cat-repositories.md

_api-reference/cat/cat-segment-replication.md

_api-reference/cat/cat-segments.md

_api-reference/cat/cat-shards.md

_api-reference/cat/cat-tasks.md

_api-reference/cat/cat-templates.md

_api-reference/cat/cat-thread-pool.md

_api-reference/document-apis/mtermvectors.md

_api-reference/cat/cat-cluster_manager.md

Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>

_api-reference/cat/cat-pending-tasks.md

_api-reference/cat/cat-recovery.md

_api-reference/cat/cat-segment-replication.md

_api-reference/cat/cat-shards.md

_api-reference/cat/cat-snapshots.md

_api-reference/cat/cat-tasks.md

_api-reference/cat/cat-nodes.md

Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>

kolchfa-aws

LGTM

* Updating Spect Insert tool to support client code translations Signed-off-by: Daniel Jackson <imdanjac@amazon.com> * Continued working on the Spect Insert feature for automatic conversion of API calls into Language SDK. Signed-off-by: Daniel Jackson <imdanjac@amazon.com> * Continued working on the Spect Insert feature for automatic conversion of API calls into Language SDK. Refactored code base to make "api" tag optional for quicker tag placements Examples:    Signed-off-by: Daniel Jackson <imdanjac@amazon.com> * Updating Example Request with spec_insert tags Signed-off-by: Daniel Jackson <imdanjac@amazon.com> * Continued working on the Spec-Insert tool. - Added test examples to test files. Signed-off-by: Daniel Jackson <imdanjac@amazon.com> * Continued working on the Spec-Insert tool. - Added more test examples to fixtures file. - Included test for NDJSON files. - Included test to showcase multi-line for body tag Signed-off-by: Daniel Jackson <imdanjac@amazon.com> * Finished Python Client Code Conversion from HTTP w/ some minor tweaks. - Changed "include_client_setup" to be called from "insert_arguments.rb" for scalability and clarity. Also changed it so that you have to state "true" or "false". - Included "skip" tag. This is for when you come across a spec-insert that cant be converted to a client.You can do it manually, and it won't mess with future renders - Allowed for the body tag to be in multiple lines instead of one. Signed-off-by: Daniel Jackson <imdanjac@amazon.com> * Finished Python Client Code Conversion from HTTP w/ some minor tweaks. - Fixed minor query params issue. - Implemented steps in the developer guide. - Removed un-reachable code logic. - Included example with NDJSON body in test files. Signed-off-by: Daniel Jackson <imdanjac@amazon.com> * Finished Spec-Insert feature allowing for multi-language support. - Inserted tags on pages to display updated python conversions. - Included script to insert tags with steps in the developer guide for proper use. Signed-off-by: Daniel Jackson <imdanjac@amazon.com> * Apply suggestions from code review Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> --------- Signed-off-by: Daniel Jackson <imdanjac@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Co-authored-by: Daniel Jackson <imdanjac@amazon.com> Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> (cherry picked from commit 6f18ee6) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

Daniel Jackson and others added 7 commits July 22, 2025 15:38

Updating Spect Insert tool to support client code translations

d428c57

Signed-off-by: Daniel Jackson <imdanjac@amazon.com>

Continued working on the Spect Insert feature for automatic conversio…

46b0106

…n of API calls into Language SDK. Signed-off-by: Daniel Jackson <imdanjac@amazon.com>

Merge branch 'main' into Spec-Insert->HTTP-to-ProLang_Start

b545d6a

Merge remote-tracking branch 'origin/Spec-Insert->HTTP-to-ProLang_Sta…

2ac865f

…rt' into Spec-Insert->HTTP-to-ProLang_Start

Merge branch 'main' into Spec-Insert->HTTP-to-ProLang_Start

32c1278

Updating Example Request with spec_insert tags

cd93360

Signed-off-by: Daniel Jackson <imdanjac@amazon.com>

github-actions bot assigned kolchfa-aws Jul 31, 2025

kolchfa-aws reviewed Aug 1, 2025

View reviewed changes

kolchfa-aws added the In progress Issue/PR: The issue or PR is in progress. label Aug 4, 2025

Daniel Jackson and others added 9 commits August 7, 2025 12:22

Continued working on the Spec-Insert tool.

d83404b

- Added test examples to test files. Signed-off-by: Daniel Jackson <imdanjac@amazon.com>

Continued working on the Spec-Insert tool.

f26c32d

- Added more test examples to fixtures file. - Included test for NDJSON files. - Included test to showcase multi-line for body tag Signed-off-by: Daniel Jackson <imdanjac@amazon.com>

Merge branch 'main' into Spec-Insert->HTTP-to-ProLang_Start

9df6657

Merge remote-tracking branch 'origin/Spec-Insert->HTTP-to-ProLang_Sta…

dd4ebbe

…rt' into Spec-Insert->HTTP-to-ProLang_Start

Finished Python Client Code Conversion from HTTP w/ some minor tweaks.

1c99540

- Fixed minor query params issue. - Implemented steps in the developer guide. - Removed un-reachable code logic. - Included example with NDJSON body in test files. Signed-off-by: Daniel Jackson <imdanjac@amazon.com>

Merge remote-tracking branch 'origin/Spec-Insert->HTTP-to-ProLang_Sta…

d5d987f

…rt' into tags

Finished Spec-Insert feature allowing for multi-language support.

758e9b6

- Inserted tags on pages to display updated python conversions. - Included script to insert tags with steps in the developer guide for proper use. Signed-off-by: Daniel Jackson <imdanjac@amazon.com>

Merge branch 'main' into tags

2a9bb71

ReveristRealm marked this pull request as ready for review August 15, 2025 20:11

ReveristRealm requested review from AMoo-Miki, dlvenable, epugh, natebower and sumobrian as code owners August 15, 2025 20:11