cloudflare / cloudflare/chanfana

How do I specify the server URL in openapi.json?

Open
#120 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
TypeScript
Stars
766
Forks
70
Avg merge
25m
Merged PRs (30d)
4

Description

https://cloudflare.github.io/itty-router-openapi/user-guide/router-options/

I thought `OpenAPIRouter` supports specifying the server URL so that the generated `openapi.json` will have the server URL info, but I can't find the option in the doc linked above. Is this feature supported?

Contributor guide

Open the contributing guide

Research direction

Start with the linked router options guide and the OpenAPIRouter configuration entry point. Check whether the generated openapi.json currently supports a server URL and whether the option is documented there. Done means the supported behavior and configuration path are clear, or the missing feature's scope is defined.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi, typescript
Domain
api
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.