Skip to content

Description element can be escaped when converting to a comment #596

@ptrbojko

Description

@ptrbojko

Describe the bug
Following part of spec:

"TimeTrackingProvider": { "required": [	"key" ], "type": "object", "properties": {	"key": { "type": "string", "description": "The key for the time tracking provider. For example, *JIRA*."	},	"name": { "type": "string", "description": "The name of the time tracking provider. For example, *JIRA provided time tracking*."	},	"url": { "type": "string", "description": "The URL of the configuration page for the time tracking provider app. For example, */example/config/url*. This property is only returned if the `adminPageKey` property is set in the module descriptor of the time tracking provider app.", "readOnly": true	} }, "additionalProperties": false, "description": "Details about the time tracking provider." }, 

Converts to

/** * Details about the time tracking provider. */ export type TimeTrackingProvider = { /** * The key for the time tracking provider. For example, *JIRA*. */ key: string; /** * The name of the time tracking provider. For example, *JIRA provided time tracking*. */ name?: string; /** * The URL of the configuration page for the time tracking provider app. For example, */example/config/url*. This property is only returned if the `adminPageKey` property is set in the module descriptor of the time tracking provider app. */ readonly url?: string; } 

which escapes from a comment (see /example/config/url part) and int return the result is not valid source code.

Metadata

Metadata

Assignees

Labels

No labels
No labels

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions