API Generator #177
API Generator #177
Conversation
There was a problem hiding this comment.
This is very good. I would try harder to externalize anything hard-coded like lists of API methods, and I think we still need:
- An (easier) way to run the generator via
rake generate. - A CI/CD that fails when the APIs are out of date.
- A cron that updates the APIs, ala https://github.com/slack-ruby/slack-ruby-client/blob/master/.github/workflows/update_api.yml
|
@dblock Agree with all 3. They are actually in the roadmap. We will have follow-up PRs to add those features. For now, this is to be done manually so that the Ruby client can get the new endpoints added easily. |
nhtruong
force-pushed
the
api_generator
branch
2 times, most recently
from
ac8e7de
to
c461fce
Compare
Signed-off-by: Theo Truong <[email protected]>
…senting namespaces. We don't need to hardcode existing namespaces anymore! Signed-off-by: Theo Truong <[email protected]>
nhtruong
requested review from
VijayanB,
jayeshathila,
robsears,
vamshin,
VachaShah and
harshavamsi
as code owners
| - Download the latest OpenSearch API Specification from [The API Spec Repo](https://github.com/opensearch-project/opensearch-api-specification/blob/main/OpenSearch.openapi.json) | ||
| - Run the generator with the API Spec downloaded previously (see below) | ||
| - Run Rubocop with `-a` flag to remove redundant spacing from the generated code `rubocop -a` | ||
| - Commit and create a PR to merge the updated API actions into `main`. |
There was a problem hiding this comment.
Nit, copy-paste commands to do this as an example so people can "just do it".
| - Commit and create a PR to merge the updated API actions into `main`. | ||
|
|
||
| ### Generate API Actions | ||
| Install all dependencies |
There was a problem hiding this comment.
Do I have to actually do this somewhere or is it a doc on how the generator works? Update text.
| :body, :body_description, :body_required | ||
|
|
||
| # @param [Array<Operation>] operations | ||
| def initialize(operations) |
There was a problem hiding this comment.
Nit: I generally would prefer that initialize just assigns @operations and to expose all the other things as properties that use each-other, this way you could document what they mean.
There's also some assumption here that there's only 1 operation?
attr_reader :operations
def initialize(operations)
@operations = operations
raise "Missing operations." if operations.size == 0
raise "Multiple operations not supported." if operations.size > 1
end
# name of the first operation
def name
operations&.first&.name
end There was a problem hiding this comment.
No there are multiple operations in 1 action, but they all share the group property, which is then broken into name and namespace
|
@dblock Will address these in a follow-up PR. I'm going to switch over getting the security API generated after this is merged. |
Description
Added API Generator to generate API actions from OpenSearch spec.
Issues Resolved
closes #139
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.