Skip to content

Spec insert >http to pro lang start #10187

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.

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

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

ReveristRealm
Copy link

@ReveristRealm ReveristRealm commented Jul 3, 2025

Description

Converting the Opensearch APIS into the respective language SDK( Starting with Python first)

  • Tested various GET, POST, PUT, DELETE request in cat.md file
  • Doing python first for testing , then moving to javascript
  • Done some test using Opensearch cluster to varify format

Issues Resolved

Code example only showing raw API or curl

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.

Daniel Jackson and others added 3 commits June 17, 2025 15:30
…of API calls into Language SDK.

Started with python first

- Added "Example_code in utils.rb"
- Added Switch statement for example_code
- implemented example_code.rb to hande logic for each language
- example_code.mustache for templating
- cat-allocation.md will be the starting test file
Signed-off-by: Daniel Jackson <imdanjac@amazon.com>
Copy link

github-actions bot commented Jul 3, 2025

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 kolchfa-aws added the 2 - In progress Issue/PR: The issue or PR is in progress. label Jul 7, 2025

{% endcapture %}

{% capture step1_javascript %}
Copy link
Contributor

Choose a reason for hiding this comment

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

Remove code that generates placeholder java tags

<!-- spec_insert_start
api: snapshot.restore
component: example_code
rest: GET _nodes/stats/indices
Copy link
Contributor

Choose a reason for hiding this comment

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

Let's keep this cat/allocation example in this PR. I think `rest:' param value is incorrect though

{{{python_code}}}
{% endcapture %}

{% capture step1_javascript %}
Copy link
Contributor

Choose a reason for hiding this comment

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

Delete placeholder javascript tag

@dzane17
Copy link
Contributor

dzane17 commented Jul 7, 2025

  • Update all commits with --signoff to fix GitHub DCO check
  • Add a testing section in PR description. Show an example of spec start/end tags with generated content inside

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
2 - In progress Issue/PR: The issue or PR is in progress.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants