Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Non-Object Components for Enums #200

Open
ogunoz opened this issue Dec 4, 2021 · 0 comments
Open

Non-Object Components for Enums #200

ogunoz opened this issue Dec 4, 2021 · 0 comments

Comments

@ogunoz
Copy link

ogunoz commented Dec 4, 2021

The types of the components are always assumed to be object. Generally, enums are allowed to be components and they can have integer or string types.

Example enum component:

"SomeType":{"title":"SomeType","enum":["TYPE_1","TYPE_2","TYPE_3"],"type":"string","description":"An enumeration."} 

Assumption is made here in transforms/components/index.js (line 82 -> type:'object')

return {
    [typedef.name]: {
      ...combineSchema(elements),
      description: schema.description,
      ...(requiredProperties.length ? {
        required: formatRequiredProperties(requiredProperties),
      } : {}),
      type: 'object',
      properties: formatProperties(propertyValues, options),
    },
  };

Would be great if @typedef {string} creates a string type

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant