Request response parameters

[sudeepkunhis]

What is the context of this PR?

https://jira.ons.gov.uk/browse/CIMS-37

This PR is to define the request and response parameters for the API endpoint

Request body -

• CIR schema JSON

Request query parameters -

• current version - string - this will be later restricted to v9.0.0 (aligned to the current Live validator version)
• target version - string - this will be later restricted to v10.0.0

Response -

• Converted CIR schema JSON (for now, this will be same as the input schema without any transformation)
• status - 200 (successful)

How to review

Run the commands make docker-build and make docker-run to spin up the local application, launch the FastAPI webpage and test the endpoint with the below sample JSON in the POST request.

{"valid_json": "valid_json"}

[liamtoozer]

Just left some comments for discussion at this early stage 👍

[berroar]

I think there might be an issue with the linting step at the moment, when I run locally it seems to catch some errors that are not being reported as part of the run in the actions workflow

[sudeepkunhis]

@berroar Linting is alright in local and github, all issues are solved, could you please check.