func icon indicating copy to clipboard operation
func copied to clipboard

Generate OpenAPI spec for a function

Open Cali0707 opened this issue 5 months ago • 4 comments

It would be useful if we somehow supported generating and serving an OpenAPI spec for the route(s) served by a function, in particular documenting what the input types are.

Cali0707 avatar Jul 04 '25 13:07 Cali0707

cc @matzew @lkingland

Cali0707 avatar Jul 04 '25 13:07 Cali0707

@Cali0707 , can i work on it?

priyanshuharshbodhi1 avatar Aug 08 '25 20:08 priyanshuharshbodhi1

From discussions in the triage call today, the idea for this feature is:

  1. Each function will server a very simple OpenAPI spec documenting the default paths in a function by default
  2. There will be an option to override the default handler to allow for users to implement more details into their own OpenAPI spec
  3. We will start with playing around with this in https://github.com/knative-extensions/func-go, and when we are happy with it add it elsewhere

cc @lkingland in case I missed something

Cali0707 avatar Aug 19 '25 13:08 Cali0707

@Cali0707 , can i work on it?

@priyanshuharshbodhi1 if you want to feel free to work on it!

Cali0707 avatar Aug 19 '25 13:08 Cali0707

This issue is stale because it has been open for 90 days with no activity. It will automatically close after 30 more days of inactivity. Reopen the issue with /reopen. Mark the issue as fresh by adding the comment /remove-lifecycle stale.

github-actions[bot] avatar Nov 18 '25 01:11 github-actions[bot]