SG-10151: set field visibility via API #209
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jfboismenu
commented
Sep 9, 2019
| ] | ||
| } | ||
|
|
||
| params = self._add_project_param(params, project_entity) |
Contributor
Author
There was a problem hiding this comment.
The server side simply expects the project to be passed in.
willis102
approved these changes
Sep 9, 2019
shotgun_api3/shotgun.py
Outdated
| ``visible`` property for. If the ``visible`` is present in ``properties`` and | ||
| ``project_entity`` is not set, an exception will be raised. Example: | ||
| ``{'type': 'Project', 'id': 3}`` | ||
| :param project_entity: Link to the project we wish to change the field visibility for. |
Contributor
There was a problem hiding this comment.
Looks like you've documented project_entity twice here.
Contributor
There was a problem hiding this comment.
Also, does project_entity only apply for visible property? Is that something we want to call out more explicitly?
Contributor
Author
There was a problem hiding this comment.
Good point. Let me know what you think of my update.
| Ensure the visibility of a field can be edited via the API. | ||
| """ | ||
| # If the version of Shotgun is too old, do not run this test. | ||
| # TODO: Update this with the real version number once the feature is released. |
Contributor
There was a problem hiding this comment.
Just highlighting this TODO.
Pull Request Test Coverage Report for Build 1248
💛 - Coveralls |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adds support for updating field visibility through the API.
This can be achieved by the following code:
where
projectis a dictionary referring to project in which we want to hide "sg_my_custom_field". Restoring visibility can be done viaNote: The build is currently failing because the feature hasn't been released in Shotgun. Once the feature is released the test will be updated to the right version check and the feature commited.