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.

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

OpenAPI support #146

Closed
wants to merge 1 commit into from
Closed

OpenAPI support #146

wants to merge 1 commit into from

Conversation

sverhoeven
Copy link
Member

@sverhoeven sverhoeven commented Nov 13, 2023

Your model might be written in a language which does not have gRPC support.
In this case, you can use the OpenAPI specifcation to wrap your model in a JSON web service.

Refs #101

TODO

  • Wrap the generated Python client in a BMI class grpc4bmi.bmi_openapi_client.BmiOpenApiClient
  • Apptainer client which can talk to openapi powered web service
  • Docker client whcih can talk to openapi powered web service
  • Call BMI class from generated Python server
  • Call BMI methods from generate Julia server
  • Make Python client and server part of grpc4bmi Python package?
  • Annotate bmi.proto for nicer paths and methods (not everything POST, get_* methods should use GET request method)
  • Document when languages which don't have a server stub generator, ask developer to make web service in that language which follows proto/grpc4bmi/bmi.swagger.yaml spec.
  • Suggest calling model from another language which has gRPC support. See Add Julia support to gprc4bmi #144 for troubles with multi lang setup.

Copy link

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

@sverhoeven
Copy link
Member Author

Or do we make a new Python package with openapi specification?

@sverhoeven
Copy link
Member Author

Created https://github.com/eWaterCycle/remotebmi for it

@sverhoeven sverhoeven closed this Mar 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant