feat(cat-gateway): config API

[bkioshn]

Description

Implement a config API endpoint

Related Issue(s)

Closes #926

Description of Changes

Create a config endpoint
GET /api/draft/config/frontend

• Get IP from X-Real-IP, Forwarded, X-Forwarded-For or Remote Address.

GET /api/draft/config/frontend/schema

• Get the frontend JSON schema

PUT /api/draft/config/frontend?ip=<ipAddress>

• Set the config for the specify IP if it already exist in the table, if not exist insert a new row
• If ip is not specify, update the general config

Additional Changes

• The value for JSON is validated with JSON schema.
• Default value is implemented.
• Remove refinery_schema_history v2 to v9

Please confirm the following checks

• My code follows the style guidelines of this project
• I have performed a self-review of my code
• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation
• My changes generate no new warnings
• I have added tests that prove my fix is effective or that my feature works
• New and existing unit tests pass locally with my changes
• Any dependent changes have been merged and published in downstream module

[github-actions]

✅ Test Report | ${\color{lightgreen}Pass: 297/297}$ | ${\color{red}Fail: 0/297}$ |

[stevenj]

Re endpoints. Use:

GET /api/draft/config/frontend
PUT /api/draft/config/frontend?ip=<ip4addr/ip6addr>

GET and PUT are enough to signify if it's a read or write.

PUT is more correct because we are setting the whole resource, its "idempotent". Doing the same PUT multiple times is the same as doing it once.

There is no requirement for ip as a parameter on GET. It should be obtained directly from the headers of the request. See: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For Poem should have a way to get this. There are other headers which could also carry the clients IP address. The logic should be, Get the general config, and the IP config, replace or set any key in the general config with the keys from the ip config (merge the json).

On PUT, the ip addr is a query parameter, if its specified you write the IP config record with the JSON given (if its valid) and it its not, you write the general config.

[stevenj]

See comments for requested changes

[Mr-Leshiy]

LGTM

[stevenj]

LGTM