Skip to content

Components fields name too restrictive? #1387

@PerthCharern

Description

@PerthCharern
Contributor

Components fields name currently has this regex as restrictions: ^[a-zA-Z0-9\.\-_]+$
This was mainly discussed and agreed on in #634.

I found this restriction a little too restrictive. I'd imagine that for the Schemas part of the component, most people will use class names as field names. Allowing the period (.) is good because that allows you to add namespace to class name Namespace.ClassName.

However, quite a number of languages have generics and APIs can have request body that are of type implementing generics. The current allowed characters make it very difficult to represent class name that is derived from generic type. The most intuitive (I think) way to represent generic class name as string is to use some kind of brackets/parentheses Namespace.GenericClassName(AnotherClassName). Of course, one can bypass this by using the allowed underscore or hyphen instead, but that just looks plain ugly.

Should we allow parentheses and/or brackets?

Activity

changed the title [-]Components fields name example too restrictive?[/-] [+]Components fields name too restrictive?[/+] on Oct 23, 2017
MikeRalphson

MikeRalphson commented on Jan 8, 2018

@MikeRalphson
Member

Only the top-level schema object name must conform to the components key regex.

Is it possible you could do something like

components:
  schemas:
    container:
     type: object
     properties:
       namespace.generic(type):
         type: ...

or

components:
  schemas:
    namespace:
     type: object
     properties:
       generic(type):
         type: ...

and use a $ref nested through the container/namespace object, e.g.:

$ref: '/components/schemas/container/namespace.generic(type)'
  
zdne

zdne commented on Jun 10, 2019

@zdne

It would be good to be more explicit in the spec as this is confusing restriction for many.

added
clarificationrequests to clarify, but not change, part of the spec
on Jan 29, 2024
added
examplesrequests for more or better examples in the specification
on Aug 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    clarificationrequests to clarify, but not change, part of the specexamplesrequests for more or better examples in the specification

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

      Development

      No branches or pull requests

        Participants

        @MikeRalphson@zdne@ralfhandl@handrews@PerthCharern

        Issue actions

          Components fields name too restrictive? · Issue #1387 · OAI/OpenAPI-Specification