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

Question about OpenAPI Spec 3.1 #1822

Open
4 of 5 tasks
jotando opened this issue Nov 29, 2023 · 2 comments
Open
4 of 5 tasks

Question about OpenAPI Spec 3.1 #1822

jotando opened this issue Nov 29, 2023 · 2 comments

Comments

@jotando
Copy link

jotando commented Nov 29, 2023

My actions before raising this issue

Why do you need this?

I'm proofing the powerful of OpenFaas (from KinD and soon directly with faasd) but I cannot found were reach the OpenApi specifications of functions built to be inspected by tools such as serverless workflow engine (such as serverlessworkflow/synapse)
is it possible today?
If not, do you think the feature worth to work on? do you plan to provide this feature?

Who is this for?

This feature will insterest developpers. And in tech companies which understood the need to share components such as technical portals to all projects.
I works at LabSoft where I'm evangelist of such practice.

Expected Behaviour

It could be nice that each function added could be described regarding openapi spec 3.1 and reach from json file + operation name from the root (such as https://kubernetes.docker.internal:8080/function/swagger.json#figlet)

Current Behaviour

There is no endpoint to reach the global openapi description of the whole hosted functions.

Are you a GitHub Sponsor (Yes/No?)

Check at: https://github.com/sponsors/openfaas

  • Yes
  • No yet

List All Possible Solutions and Workarounds

Which Solution Do You Recommend?

Steps to Reproduce (for bugs)

Context

Your Environment

  • OpenFaaS on Kubernetes or faasd?

  • Operating System and version : Windows

@alexellis
Copy link
Member

alexellis commented Dec 6, 2023

Are you expecting to add a static file into your function, or are you hoping for the template to automatically write / discover the OpenAPI definitions?

We discussed the use-case on the weekly office hours call with @LucasRoesler and @nitishkumar71

@jotando
Copy link
Author

jotando commented Dec 7, 2023

Hello!
I think that discovering the OpenAPI definitions could provide a function oriented version of service discovery feature.
Therefore I'm hoping for the template to provide a mean to allow the discovering of OpenAPI definitions of the functions.
Does it make sense?

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

No branches or pull requests

2 participants