Generate API docs

[lucacome]

trafficstars

Proposed changes

Problem: We want to have our CRDs documented

Solution: Use gen-crd-api-reference-docs to automatically generate the docs

Closes #1754

Checklist

Before creating a PR, run through this checklist and mark each as complete.

• [ ] I have read the CONTRIBUTING doc
• [ ] I have added tests that prove my fix is effective or that my feature works
• [ ] I have checked that all unit tests pass after adding my changes
• [ ] I have updated necessary documentation
• [ ] I have rebased my branch onto main
• [ ] I will ensure my PR is targeting the main branch and pulling from my branch from my own fork

Release notes

If this PR introduces a change that affects users and needs to be mentioned in the release notes, please add a brief note that summarizes the change.

NONE

[lucacome]

@nginxinc/nginx-docs I need your help to make the new page look good 😅

[ADubhlaoich]

@Jcahilltorre @travisamartin Any thoughts on the formatting issues for this generated API documentation?

I think there's some examples without these formatting issues in NGINX Management Suite, which are OpenAPI based IIRC.

[sjberman]

The issue with this structure is it's just in alphabetical order. I want to easily be able to delineate between the different policies and their sub-fields. Should be separated by policy.

A ToC for each policy would also help.

[lucacome]

Turns out there was a missing tag for the types, they're now showing correctly by policy