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

Support for schema validation of blueprintConfiguration objects #1223

Open
wants to merge 5 commits into
base: release52
Choose a base branch
from

Conversation

scriptorian
Copy link
Contributor

This PR has been opened by SuperFly.tv on behalf of EVS Broadcast Equipment.

What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)

Feature

What is the current behaviour? (You can also link to an open issue here)

When updating blueprintConfiguration objects through the REST API the new configuration is written to the database without any validation that the values conform to any schema.

What is the new behaviour (if this is a feature change)?

This feature supports blueprints that define blueprintConfiguration object JSON schemas and provides methods to support automatic, detailed validation of updated configurations against the published schema before being written to the database. Any invalid properties are reported back to the client.

Included is a small addition to the API that allows the blueprintConfiguration objects to be read and updated without including the rest of the studio or showStyle configuration properties.

Other information:

Status

  • PR is ready to be reviewed.
  • Code documentation for the relevant parts in the code have been added/updated by the PR author
  • No unit test changes are needed for this PR.
  • The functionality has been tested by the PR author

Affected Areas

  • This PR affects the REST API implementation.
  • Without blueprint changes there will be no change in behaviour.

@scriptorian scriptorian requested a review from a team as a code owner July 8, 2024 16:33
Copy link

codecov bot commented Jul 9, 2024

Codecov Report

Attention: Patch coverage is 0% with 567 lines in your changes missing coverage. Please review.

Project coverage is 57.60%. Comparing base (0233073) to head (978a09f).
Report is 434 commits behind head on release51.

Files Patch % Lines
meteor/server/api/rest/v1/typeConversion.ts 0.00% 192 Missing ⚠️
meteor/server/api/rest/v1/showstyles.ts 0.00% 180 Missing ⚠️
meteor/server/api/rest/v1/studios.ts 0.00% 138 Missing ⚠️
meteor/lib/api/rest/v1/showstyles.ts 0.00% 29 Missing ⚠️
meteor/lib/api/rest/v1/studios.ts 0.00% 28 Missing ⚠️
Additional details and impacted files
@@              Coverage Diff              @@
##           release51    #1223      +/-   ##
=============================================
- Coverage      57.95%   57.60%   -0.36%     
=============================================
  Files            485      523      +38     
  Lines          79860    85257    +5397     
  Branches        4152     3863     -289     
=============================================
+ Hits           46284    49113    +2829     
- Misses         33524    36115    +2591     
+ Partials          52       29      -23     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@nytamin nytamin added Contribution from EVS Contributions sponsored by EVS Broadcast Equipment (evs.com) Contribution labels Jul 9, 2024
@nytamin
Copy link
Contributor

nytamin commented Jul 9, 2024

Thank you for this contribution! The NRK team is on vacation at the moment, we'll look at this PR when we're back in August.

meteor/server/api/rest/v1/studios.ts Outdated Show resolved Hide resolved
meteor/server/api/rest/v1/studios.ts Outdated Show resolved Hide resolved
meteor/server/api/rest/v1/studios.ts Outdated Show resolved Hide resolved
meteor/server/api/rest/v1/studios.ts Outdated Show resolved Hide resolved
meteor/server/api/rest/v1/showstyles.ts Outdated Show resolved Hide resolved
meteor/server/api/rest/v1/showstyles.ts Outdated Show resolved Hide resolved
meteor/server/api/rest/v1/showstyles.ts Outdated Show resolved Hide resolved
meteor/server/api/rest/v1/typeConversion.ts Outdated Show resolved Hide resolved
@jstarpl jstarpl changed the base branch from release51 to release52 October 3, 2024 14:00
@nytamin nytamin self-requested a review October 14, 2024 09:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Contribution from EVS Contributions sponsored by EVS Broadcast Equipment (evs.com) Contribution
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants