Skip non API routes

Open
#350 8 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
30/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Quiet
Tech stack
ruby
Domain
api

Research direction

The request is for an option that lets the validation middleware skip paths the OpenAPI schema does not describe, today handled by subclassing the middlewares. Read the linked discussion #228 and pull request #347 comment first to see the agreed approach. The payload names no source files, so locate the Rack middleware classes yourself. Done means a configuration option that passes unmatched routes through, with a spec covering that case. Expect a design decision before coding.

Written by the indexing model from the issue text.

Description

enhancement

how can we exclude the paths which are not managed by the schema from validation?

This is a question that keeps coming up. One option is of course the one you described with sub-classing the Middlewares. This should still just work. I think having an option for that would be useful, especially for beginners.

Follow-up of https://github.com/ahx/openapi_first/pull/347#issuecomment-2808730534 and https://github.com/ahx/openapi_first/discussions/228

Dominant language
Ruby
Stars
222
Forks
27
Avg merge
17h 15m
Merged PRs (30d)
6

Getting set up

  • Ships a Dockerfile or Docker Compose file
  • No pull request template
  • No contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from ahx/openapi_first

All issues in ahx/openapi_first

Similar issues

More Ruby issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.