should render additionalProperties

[jonaslagoni]

Reason/Context

Currently the CommonModel does include additionalProperties, however they are not rendered as properties in the generator

Questions:

• How should we handle additionalProperties if we already have a property called additionalProperties?

[magicmatatjahu]

@jonaslagoni You pinged me about problems with addProperties etc in slack, so I give you some tips here, also to check by another people from community:

For additionalProperties:

• in TS and JS we should render for additionalProperties additional accessor for set and get, but not native, but something like getAdditionalProperty(key: string): {type} and setAdditionalProperty(key: string, value: {type}): void.
• in Java we can make something similar public {type} getAddtionalProperty(String key) { this.additionalProperties.get(key) } and similar setAdditionalProperty.

For patternProperties situation is very similar to additionalProperties. We have an example:

{
  "type": "object",
  "patternProperties": {
    "^S_": { "type": "string" },
    "^I_": { "type": "integer" }
  },
  "additionalProperties": false
}

• in TS and JS we should render:

patternProperties: Record<string, any>;

getPatternProperty(key: string): {type | undefined} {
  return patternProperties[key];
}

setPatternProperty(key: string, value: any): void {
  // here we must check patterns
  if (/^S_/.test(key) && typeof value === "string") {
    this.patternProperties[key] = value;
  }
  if (/^I_/.test(key) && typeof value === "number") {
    this.patternProperties[key] = value;
  }
  // maybe throw error
}

• for Java very similar like for TS - additional get and set for patternProperties and inside them check pattern before saving data.

additionalProperties and patternProperties you can render in 2 ways:

• using additionalContent preset for class here or
• adjust renderProperties in appropriate renderer

[github-actions]

This issue has been automatically marked as stale because it has not had recent activity 😴
It will be closed in 60 days if no further activity occurs. To unstale this issue, add a comment with detailed explanation.
Thank you for your contributions ❤️

[asyncapi-bot]

🎉 This issue has been resolved in version 0.11.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀