Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Python scripts code refactor #269

Merged
merged 1 commit into from
Aug 6, 2024
Merged

Conversation

Surax98
Copy link
Collaborator

@Surax98 Surax98 commented Jul 22, 2024

And OpenAPI update

Summary

Refactored variables and functions name in python scripts to match snake_case (for variables and functions) and CamelCase for classes.
Also, update the openAPI script to generate OpenAPI JSON file. It is now compliant with the current version (it will be updated in the future to match v0.4.x and newer versions).

Related issue :
#250 #253

@dciangot
Copy link
Collaborator

Since we are here, @Surax98 what about a github action that build the json spec and store it as a release artifact?

So then we can point the documentation to the latest build artifact.

@Surax98
Copy link
Collaborator Author

Surax98 commented Jul 22, 2024

Since we are here, @Surax98 what about a github action that build the json spec and store it as a release artifact?

So then we can point the documentation to the latest build artifact.

Sure thing. Same PR or another one?

@dciangot
Copy link
Collaborator

Another one, thanks

@Surax98
Copy link
Collaborator Author

Surax98 commented Jul 22, 2024

Another one, thanks

Ok, no problem. Would it be ok to actually execute the script upon every push and directly in-place commit and push the generated JSON? Basically, to update the file and replace the old one.

@dciangot
Copy link
Collaborator

no automatic commits, I'd put the json as a release artifact (meaning, the exact position of the binaries), and then doc will take the reference from the public endpoint of the release.

Copy link
Collaborator

@dciangot dciangot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LgTM

@dciangot dciangot merged commit 7499848 into interTwin-eu:main Aug 6, 2024
1 of 3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants