Updating Example Request with spec_insert tags #10546
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Daniel Jackson <[email protected]>
…n of API calls into Language SDK. Signed-off-by: Daniel Jackson <[email protected]>
…n of API calls into Language SDK. Refactored code base to make "api" tag optional for quicker tag placements Examples: <!-- spec_insert_start component: example_code rest: GET /_cat/allocation?v=true&format=json&bytes=mb --> <!-- spec_insert_end --> <!-- spec_insert_start component: example_code rest: GET /users/_doc/42?_source=name,email include_client_setup: T --> Signed-off-by: Daniel Jackson <[email protected]>
…rt' into Spec-Insert->HTTP-to-ProLang_Start
Signed-off-by: Daniel Jackson <[email protected]>
|
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
reviewed
Aug 1, 2025
| @@ -36,7 +36,7 @@ include_deprecated: false | |||
| --> | |||
| ## Query parameters | |||
|
|
|||
| The following table lists the available query parameters. All query parameters are optional. | |||
| The following table lists the available query parameters. | |||
There was a problem hiding this comment.
@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 <[email protected]>
- 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 <[email protected]>
- 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 <[email protected]>
…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 <[email protected]>
- 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 <[email protected]>
ReveristRealm
requested review from
AMoo-Miki,
natebower,
dlvenable,
epugh and
sumobrian
as code owners
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Updated example request with spec insert tags to display python conversions.
Example
Included Script with directions in
DEVELOPER-GUIDE.MDIssues 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
For more information on following Developer Certificate of Origin and signing off your commits, please check here.