REST API Docs

[gewenyu99]

What does this PR do?

Amends the new REST API docs.

What's still missing?

• List of magic strings
• Where you can find raw OpenAPI and Swagger specs

Test Plan

(Write your test plan here. If you changed any code, please provide us with clear instructions on how you verified your changes work.)

Related PRs and Issues

(If this PR is related to any other PR or resolves any issue or related to any issue link all related PR and issues here.)

Have you read the Contributing Guidelines on issues?

(Write your answer here.)

[gewenyu99]

[stnguyen90]

This is awesome and much-needed! I've added my comments

[gewenyu99]

I also split the screenshot into many parts so it's easier to view ❤️

[abnegate]

Looking good. Is the syntax highlighting for HTTP working okay for you? I'm not seeing the request line highlighted, not sure if it's just me

[gewenyu99]

Looking good. Is the syntax highlighting for HTTP working okay for you? I'm not seeing the request line highlighted, not sure if it's just me

Hmmmmmmmm, I think if you remove a space after the route, it highlights it differently but renders weird. I don't think the behavior is expected for prism. This is the most "normal" I can get it. Do we wanna spend some time digging into this? I'd need some help, I've no idea how the highlighting works.

[abnegate]

Hmmmmmmmm, I think if you remove a space after the route, it highlights it differently but renders weird. I don't think the behavior is expected for prism. This is the most "normal" I can get it. Do we wanna spend some time digging into this? I'd need some help, I've no idea how the highlighting works.

We should definitely get it working properly, I'll try have a look later today if I get some time