Support for regexp "pattern"

[senyahnoj]

Would it be possible to support regexp "pattern" in CRDs?

Here's an example snippet from a CRD

rootUrl:
  description: Root URL 
  type: string
  format: uri
  pattern: "^https://[^/]+/?$"

On crdoc 0.6.4, the description, type and format are rendered in the resulting markdown table. If would be really useful if the RegExp pattern could also appear.

Thanks very much!

[thc1006]

Thanks for raising this. I ran into the same thing, where a pattern on a string field just doesn't show up in the generated docs, and while I was looking into it I realized the gap is a little broader than pattern on its own.

The two neighboring string constraints, minLength and maxLength, get left out in the same way. The templates print minimum and maximum for numbers but stop there, so a string field that really does have enforced limits ends up reading as if it had none. It's the same across all three default templates too (markdown.tmpl, frontmatter.tmpl, and adoc.tmpl), since each one walks a fixed set of fields that ends at maximum.

There's also one detail that's specific to AsciiDoc. adoc.tmpl writes into a table that uses the pipe character as its cell separator, and regex patterns often contain a pipe for alternation, for example ^(http|https). If that goes straight into a cell it splits the row, so in the AsciiDoc template the pipe has to be escaped as \|. The markdown templates aren't affected, because they emit an HTML table rather than a pipe table.

I've put together a small change that renders minLength, maxLength, and pattern in all three templates, handles the AsciiDoc escaping, regenerates the example output, and adds a test with a fixture that covers all three. It stays within the templates, the example, and the test, with nothing touched in the model or the parser. If it would be welcome I'd be glad to open it as a pull request that closes this issue, and I'm of course happy to match whatever label wording or style you'd prefer. Thanks again for building this.