Save OpenAPI definition as json, generate client and run tests

[ChuckMoe]

See #958

[ChuckMoe]

To further work on this PR, I have some questions:

1. Which languages do you want to generate code for now? For all of them, please create repositories and add the credentials as environment variables in the project settings.
2. At the moment I am using schemathesis to run automatically generated tests. This is not the best solution, but it would us get started immediately. In theory. It seems like the backend and the definition are still not aligned. To try it our yourself, execute schemathesis locally.
3. If I start the node server in one part of a step and want to call its API in another part, is it still running or simply exited?
4. Should I create some rudimentary tests for one client in order to test it now?

Run Schemathesis

Install

pip3 install --user schemathesis

Run

Prepare the group variables in your env in a way, that your user is allowed everything.

st run \
  -H "Authorization: Bearer TOKEN" \
  --checks all \
  --validate-schema true \
  http://localhost:3000/explorer-json

[bpedersen2]

Some minor changes, but overall this looks good.

[ChuckMoe]

The list of generated clients can also be moved into an environment variable of the repository. That way, there is no need to change the code in the case you want to add or remove one.

[dylanmcreynolds]

This looks great to me. I had one quick comment on the new mongo docker-compose. While reading, I hadn't realized that that was probably there for the github action and not local development, so maybe my comment does not really apply.

[dylanmcreynolds]

This looks great to me. I had one quick comment on the new mongo docker-compose. While reading, I hadn't realized that that was probably there for the github action and not local development, so maybe my comment does not really apply.

[ChuckMoe]

I tried writing the tests for the generated javascript-client and typescript-client but both had some problems. Is it alright, if I write the tests for the python client?

[ChuckMoe]

One big open question for me is still where to save/upload the client code to. Is it supposed to be a mono-repo or should they be uploaded into different repositories?

[bpedersen2]

I guess the mongoose-managed fields ( createdAt )etc. should have a default in the schema definition for the HistoryClass to match the other schemas.

[bpedersen2]

#1132 should fix the HistoryClass errors

[nitrosx]

Regarding the test failing: are we able to download the openapi.json file and run the api creation successfully locally?
Do we have instructions on how to do that?

[ChuckMoe]

@nitrosx You can download or create it yourself but it won't change the outcome. The same error will appear until the example value of updatedAt in issue #1055 is fixed. You could use --skip_validation but that would also skip every other potential error in the schema, so I advocate against it.
If you want to create the schema locally take a look at this tutorial on how to run OpenAPI on your machine.

[nitrosx]

@ChuckMoe thank you for clarifying.
I will look into it and make sure that somebody from the community will work on it.

[sbliven]

Is this PR superseded by the Core Release SDK autogeneration and pySciCat project? The plan is to generate the SDK in a different repo, right? Should this PR be closed?

[nitrosx]

As mentioned by @sbliven, this PR as been superseeded by the completion of Core Release SDK autogeneration and pySciCat project.

Closing it