how to make description tag mandatory in raml 1.0 for consistency data in developer portal

We can make description property as mandatory by setting required filed to true.

 types:
   Person:
     type: object
     properties: 
       name: string
       age: 
         type: number
         required: true
       description:
         required: true

We can't make description tag itself mandatory as RAML defines it as optional node. The only mandatory tag among possible root elements of RAML is 'title'.

Hi Nanda,

Good question. I don't think it is possible to make in mandatory in RAML itself as it is constrained by the RAML spec. But you can try out Code quality tool like RAMLLINT: https://www.npmjs.com/package/ramllint. It provides some level of static code analysis on the RAML quality.

Having said that, it's possible that the rule you are looking for is not there, but you can always contribute.

Hi Guys, Thanks for replying. Then what i am thinking is that i need to enforce the developer to provide the description for all resources ,so that we may have consistent data in developer portal.

description: required: true

The RAML spec defines the description property for a resource as optional. So, your requirement is something to be achieved through code analysis tooling.

description: required: true