validate component name

Open
#81 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
45/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Stale
Tech stack
python
Domain
api

Research direction

The issue does not name a file or test; start by locating the validator code that handles OpenAPI component names and compare its behavior with the linked specification and regex. Done means component keys containing characters such as / are rejected while keys matching the permitted pattern remain valid.

Written by the indexing model from the issue text.

Description

Component names aren't validated, e.g. if a model contains a /.

https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#componentsObject

All the fixed fields declared above are objects that MUST use keys that match the regular expression: ^[a-zA-Z0-9\.\-_]+$.

Dominant language
Python
Stars
409
Forks
73
No merged PRs in 30d

Contributor guide

Open the 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 python-openapi/openapi-spec-validator

All issues in python-openapi/openapi-spec-validator

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.