HTTP-APIs / hydrus

REST server - Flask Hydra-powered for Semantic Web
https://pypi.org/project/hydrus/
MIT License
195 stars 130 forks source link

Add to the documentation how to handle ApiDoc/schema changes #589

Open Mec-iS opened 3 years ago

Mec-iS commented 3 years ago

I'm submitting a

Current Behaviour:

We have alembic installed but there is no mention in the documentation about how to create the first migration nor an automatic mechanism todo migration when the ApiDoc changes.

Expected Behaviour:

When the hydrus instance is run for the first time, a migration file should be created with the initial database schema. Every time a change happens on the ApiDoc that affects the database, the "migrate" command should be run to write a new migration version.

Krish-bhardwaj commented 2 years ago

I'm submitting a

  • [x] feature request.

Current Behaviour:

We have alembic installed but there is no mention in the documentation about how to create the first migration nor an automatic mechanism todo migration when the ApiDoc changes.

Expected Behaviour:

When the hydrus instance is run for the first time, a migration file should be created with the initial database schema. Every time a change happens on the ApiDoc that affects the database, the "migrate" command should be run to write a new migration version.

Hi can you specify clearly what we have to do i'll add this to my current PR

Mec-iS commented 2 years ago

it is not advisable to provide different feature in the same PR, please open another one.

Are you familiar with alembic and database schemas?

Wansh619 commented 2 years ago

Hi i am new to this open source stuff can i get assign for this issue ? Can you please tell me what I have to learn for solving this issue?

Mec-iS commented 2 years ago

@Wansh619 https://www.hydraecosystem.org/Starting-Material

Wansh619 commented 2 years ago

Thank and if i need more resources i will tell you.

arneja-arnav commented 2 years ago

Hey. has this issue been resolved? Would love to work on it