Right now, we have a comprehensive, auto-generated MDX document on the different config parameters. It would be nice to do the same for API endpoints, since GitProxy administrators may want to write plugins or processors that are easier to develop making calls to the API.
Describe the solution you'd like
We could make a script similar to the one in scripts/doc-schema.js to generate the API reference programmatically.
Describe alternatives you've considered
There's API documentation tools out there (i.e.: Swagger), but I don't think the low complexity of our API warrants using them.
Additional context
Architecture guide issue and PR: #1325 #1335
Right now, we have a comprehensive, auto-generated MDX document on the different config parameters. It would be nice to do the same for API endpoints, since GitProxy administrators may want to write plugins or processors that are easier to develop making calls to the API.
Describe the solution you'd like
We could make a script similar to the one in
scripts/doc-schema.jsto generate the API reference programmatically.Describe alternatives you've considered
There's API documentation tools out there (i.e.: Swagger), but I don't think the low complexity of our API warrants using them.
Additional context
Architecture guide issue and PR: #1325 #1335