-
Notifications
You must be signed in to change notification settings - Fork 38
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
feat: Introduce privateData and publicData #1077
Merged
jstarpl
merged 30 commits into
nrkno:release51
from
tv2norge-collab:contribute/EAV-31/blueprintsData
Jan 11, 2024
Merged
feat: Introduce privateData and publicData #1077
jstarpl
merged 30 commits into
nrkno:release51
from
tv2norge-collab:contribute/EAV-31/blueprintsData
Jan 11, 2024
Conversation
This file contains 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
…-33/buckets-api-http-release51
…-33/buckets-api-http-release51
…-33/buckets-api-http-release51
…-33/buckets-api-http-release51
no type = <any>
…-33/buckets-api-http-release51
deprecates `metaData`
jstarpl
added
the
Contribution from TV 2 Norge
Contributions sponsored by TV 2 Norge (tv2.no)
label
Nov 29, 2023
Use `privateData` or `publicData` instead
…-33/buckets-api-http-release51
…-33/buckets-api-http-release51
5 tasks
…-33/buckets-api-http-release51
…3/buckets-api-http-release51
…-31/blueprintsData
With #1070 now merged, is this PR ready to go out of the "Draft" status? We are nearing the end of testing for v1.50, and looking to stabilize v1.51 soon. |
…ribute/EAV-31/blueprintsData
This is now ready for review. I have resolved all the merge conflict up to this point. |
Julusian
approved these changes
Jan 10, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
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.
The contributor
This PR is being opened on behalf of TV 2 Norge.
Type of contribution
This is a
Current behavior
Current behavior is described in the Background section of the RFC #1074, that this PR is a continuation of.
New behavior
On the document interfaces representing Rundown Playlists, Rundowns, Segments, Parts, Pieces, AdLib Pieces and Adlib Actions, the following optional properties are added:
publicData
- the public-facing metadata that has some meaning to the outside world, and the external systems will have access to, through means like the Live Status Gateway's topicsprivateData
- data available only to the blueprints, where the blueprints can store any internal information for their own access later, e.g. to be used in methods likeexecuteAction
andgetEndStateForPart
The
metaData
property isstill available where it was, but marked as deprecatedremoved.Note:
publicData
will be exposed through LSG in a separate PR due to other pending refactoring.Test instructions
Other information
This change is a feature from the perspective of Blueprints API consumers. From that perspective it's also a breaking change, since the
metaData
is removed in favor of the newly introduced properties.Status