docs: Add http/openapi documentation & ci workflow

[shahzadlone]

Relevant issue(s)

Related #510
Resolve #2677

Description

• Detect OpenAPI / HTTP documentation is always up to date.
• Generate open-api docs in the appropriate dir.

How has this been tested?

• using act tool
• manually introducing a change and seeing the action fail: https://github.com/sourcenetwork/defradb/actions/runs/9359749777/job/25763961265?pr=2678

Specify the platform(s) on which this was tested:

• WSL2 instance

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 78.15%. Comparing base (1eb1fb5) to head (2cc8e99).

Additional details and impacted files

@@             Coverage Diff             @@
##           develop    #2678      +/-   ##
===========================================
+ Coverage    78.12%   78.15%   +0.03%     
===========================================
  Files          303      303              
  Lines        23052    23052              
===========================================
+ Hits         18009    18016       +7     
+ Misses        3681     3675       -6     
+ Partials      1362     1361       -1     

Flag	Coverage Δ
all-tests	78.15% <ø> (+0.03%)	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

see 6 files with indirect coverage changes

---

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 1eb1fb5...2cc8e99. Read the comment docs.

[fredcarle]

question: Why do we want to have the openAPI json output published in our docs? I'm asking because it's not really something to be read by humans.

[nasdf]

we can have it render a UI like this with some config options https://docs.source.network/sourcehub/api

[fredcarle]

I see. Hopefully we can make the table easier to read because the one at the link is pretty terrible 😅

[fredcarle]

This is one of my favourite API docs: https://docs.stripe.com/api
If we can eventually make it look like this but on top of it be able to execute the request to a configurable endpoint, that would be amazing.

[shahzadlone]

This is one of my favourite API docs: docs.stripe.com/api If we can eventually make it look like this but on top of it be able to execute the request to a configurable endpoint, that would be amazing.

Nice the stripe docs look really nice. Whoever is responsible for website doc stuff can easily plug it in using the json file this PR introduces

[fredcarle]

LGTM