cloudflare / cloudflare/chanfana

How to hide routes while using Chanfana?

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

Description

The docs say "Just don't use Chanfana, register the route directly":
https://chanfana.pages.dev/examples-and-recipes#hiding-routes-in-openapi-schema
but what if I want docs for dev runs but then hide certain routes in prod?

Is there a way to hide routes from the openapi output?

Contributor guide

Open the contributing guide

Research direction

Start with the linked “hiding routes in OpenAPI schema” documentation and trace how routes are registered and included in the generated OpenAPI output. Done means establishing a supported way to keep documentation routes available during development while excluding selected routes from the production OpenAPI output.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi, typescript
Domain
api
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 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.