Skip to content

move missing new visibility spec to the split spec #31

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

Open
wants to merge 7 commits into
base: master
Choose a base branch
from

Conversation

markus-zolliker
Copy link
Contributor

  • keep old secop_specification_draft_wip.rst in candidates

+ keep old secop_specification_draft_wip.rst in candidates
Copy link
Member

Choose a reason for hiding this comment

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

If you really want to keep this file, please rename it to give it a cut-off date (similar to the other files in candidates).

Copy link
Contributor Author

Choose a reason for hiding this comment

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

i wanted to keep it, in case there are other things not (yet) copied to the split spec. but yes, we should put a date

hint to the UI for the amount of exposed modules. A visibility of
"advanced" means that the UI should hide the module for users, but
show it for experts and advanced users.
string indicating a hint for UIs for which user roles the module should be
Copy link
Member

Choose a reason for hiding this comment

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

(nit, this is indented by 5 spaces not 4)

A SECoP client SHOULD ignore any value not listed in the last two columns of
above table.

:Note:
Copy link
Member

Choose a reason for hiding this comment

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

keep .. note:: markup here

A SECoP client SHOULD ignore any value not listed in the last two columns of the above
table.

:Remark:
Copy link
Member

Choose a reason for hiding this comment

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

Either also .. note:: or .. adminition:: Remark

There are redundant possibilities for expressing the same access levels,
best practice for a SEC node is:

- avoid explicit "w" on parameters with readonly=true
Copy link
Member

Choose a reason for hiding this comment

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

Should this case not be flagged as an error? (I.e. disallowed by the spec)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

What makes the difference between discouraged and disallowed? I think a client should be able to handle this case correctly, even when it is disallowed. There might be different scenarios, where this may happen: there is an old config file using old style visibility, but the framework converts automatically "advanced" to "ww-". Or a visibility on a parameter is set in the code to "ww-", but in the config file readonly is set to true. We may try to handle all these cases in Frappy on the server side, but I think it is not worth the work. Anyway, on the client side the final visibility of a parameter is merged with the visibility of the module - so this case has to be handled on the client side anyway.

Copy link
Member

Choose a reason for hiding this comment

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

👍

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