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

Introduce a deprecated flag on props and schemata #1167

Merged
merged 3 commits into from
Jul 17, 2023
Merged

Conversation

pudo
Copy link
Contributor

@pudo pudo commented Jul 11, 2023

This creates a mechanism for warning users that a given schema or property will be removed in the future and should no longer be used.

I'm not sure where all the places are that we would want to check and alert this - probably want to keep it a bit limited in order to avoid nasty levels of noise and a perf impact.

@tillprochaska
Copy link
Contributor

It would be great to add this to the to_dict methods (so it is included in the model JSON) and ideally to the TS lib, too, so we can display a warning in the model explorer and hide deprecated schemata in the Aleph UI (or at least prevent users from creating new entities using deprecated schemata).

@pudo
Copy link
Contributor Author

pudo commented Jul 14, 2023

I assume this would be really nice to feature in SchemaPageHeader, perhaps as an alert box? Maybe I can ask your help for that?

@tillprochaska
Copy link
Contributor

Yep, I’ll add it to the docs. Will do that in a separate PR though so this one isn’t blocked. Also, this feature needs to be in a release of the TS lib in order to use it in the docs :)

@pudo
Copy link
Contributor Author

pudo commented Jul 17, 2023

Agree that linking hidden and deprecated was sketch :)

Copy link
Contributor

@tillprochaska tillprochaska left a comment

Choose a reason for hiding this comment

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

Nice, thanks!

@pudo pudo merged commit 5edf94e into main Jul 17, 2023
8 checks passed
@pudo pudo deleted the pudo/deprecated branch July 17, 2023 13:57
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.

None yet

2 participants