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

feat: Introduce privateData and publicData #1077

Merged

Conversation

ianshade
Copy link
Contributor

@ianshade ianshade commented Nov 29, 2023

The contributor

This PR is being opened on behalf of TV 2 Norge.

Type of contribution

This is a

  • Bug fix
  • Feature
  • Code improvement
  • Documentation improvement
  • Other (please specify)

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 topics
  • privateData - 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 like executeAction and getEndStateForPart

The metaData property is still available where it was, but marked as deprecated removed.

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

  • PR is ready to be reviewed
  • The functionality has been tested by the author
  • Relevant unit tests has been added / updated
  • Relevant documentation (code comments, system documentation) has been added / updated

@jstarpl jstarpl added the Contribution from TV 2 Norge Contributions sponsored by TV 2 Norge (tv2.no) label Nov 29, 2023
@jstarpl jstarpl self-assigned this Jan 9, 2024
@jstarpl
Copy link
Member

jstarpl commented Jan 10, 2024

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.

@ianshade ianshade marked this pull request as ready for review January 10, 2024 10:50
@ianshade
Copy link
Contributor Author

This is now ready for review. I have resolved all the merge conflict up to this point.

@jstarpl jstarpl merged commit af9f080 into nrkno:release51 Jan 11, 2024
32 of 33 checks passed
Julusian added a commit that referenced this pull request Jan 15, 2024
@ianshade ianshade deleted the contribute/EAV-31/blueprintsData branch May 29, 2024 11:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Contribution from TV 2 Norge Contributions sponsored by TV 2 Norge (tv2.no) Contribution
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants