This is probably already known, but the simple example of RAML 1 data types is not sup

Doesnt handle simple RAML 1 example from site about ramldt2jsonschema HOT 1 CLOSED

kevinduffey commented on June 13, 2024

Doesnt handle simple RAML 1 example from site

from ramldt2jsonschema.

Comments (1)

jstoiko commented on June 13, 2024

Closing this issue since it works as expected. I.e. Group is translated properly

test.raml:

#%RAML 1.0

title: A CRUD API for Users and Groups
mediaType: application/json

types:

  ###############
  # Common:
  ###############

  Email:
    pattern: "^\\w+(\\.\\w+)[email protected]"

  StaticGroupNums:
    description: Predefined user groups
    enum: [ 12, 26, 30, 31, 32 ]

  DynamicGroupNum:
    description: Dynamically-defined user groups
    pattern: "D\\-\\d+"

  RecordId:
    usage: An id of any record in the system
    type: number

  Record-base:
    usage: Pattern for any record in the system
    properties:
      id:
        type: RecordId
        required: true
      created:
        type: datetime
        required: true

  ###############
  # User:
  ###############

  User-base:
    usage: The base type for user records
    properties:
      firstname:
        required: true
      lastname:
        required: true

  User-new:
    usage: Data for creating a new user
    type: User-base
    properties:
      HRAuth:
        description: Authorization received from HR
        required: true

  User-update:
    usage: Changeable properties of an existing user
    properties:
      firstname:
      lastname:

  User:
    usage: A user in the system
    type: [ User-base, Record-base ]
    properties:
      emails: Email[]

  ###############
  # Group:
  ###############

  Group-base:
    usage: The base type for group records
    properties:
      name:
        required: true

  Group-new:
    usage: Data for creating a new group
    type: Group-base
    properties:
      ITAuth:
        description: Authorization received from IT
        required: true

  Group-update:
    usage: Changeable properties of an existing group
    properties:
      name:

  Group:
    usage: A group in the system
    type: [ Group-base, Record-base ]
    properties:
      groupnum:
        type: StaticGroupNums | DynamicGroupNum
        required: true

$ dt2js ./test.raml Group
{
  "usage": "A group in the system",
  "properties": {
    "id": {
      "usage": "An id of any record in the system",
      "type": "number"
    },
    "created": {
      "type": "string",
      "pattern": "^(\\d{4})-(\\d{2})-(\\d{2})T(\\d{2})(:)(\\d{2})(:)(\\d{2})(\\.\\d+)?(Z|([+-])(\\d{2})(:)?(\\d{2}))$"
    },
    "name": {
      "type": "any"
    },
    "groupnum": {
      "type": "object",
      "anyOf": [
        {
          "description": "Predefined user groups",
          "enum": [
            12,
            26,
            30,
            31,
            32
          ],
          "type": "any"
        },
        {
          "description": "Dynamically-defined user groups",
          "pattern": "D\\-\\d+",
          "type": "any"
        }
      ]
    }
  },
  "type": "object",
  "additionalProperties": true,
  "required": [
    "id",
    "created",
    "name",
    "groupnum"
  ],
  "$schema": "http://json-schema.org/draft-04/schema#"
}