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

Validate the EditorInterface.yaml of a Content Block package #8

Closed
3 of 4 tasks
typecat opened this issue Nov 5, 2020 · 3 comments
Closed
3 of 4 tasks

Validate the EditorInterface.yaml of a Content Block package #8

typecat opened this issue Nov 5, 2020 · 3 comments
Labels
enhancement New feature or request

Comments

@typecat
Copy link
Contributor

typecat commented Nov 5, 2020

Technical Story

Validate the EditorInterface.yaml of a Content Block package

Acceptance criteria

  • The file defines the editor interface of exactly one content block
  • At least one field is defined
  • The fields are only of types and have only properties defined in the documentation
  • The YAML file contents are validated against a JSON schema
@typecat typecat changed the title Validate the EditorInterface.yaml of a Content Block package Validate the EditorInterface.yaml of a Content Block package Nov 6, 2020
@typecat typecat added the enhancement New feature or request label Feb 28, 2022
@typecat
Copy link
Contributor Author

typecat commented Feb 28, 2022

Can also be partly done for v2.

@krausandre
Copy link
Collaborator

TODO: The fields are only of types and have only properties defined in the documentation

-> Conclusion: Since the system ignores not matching types and properties, this is not necessary.


TODO: The YAML file contents are validated against a JSON schema

-> Not clear what to do here and if necessary.
-> Tough to implement and less benefit though
-> Suggestion: omit this or do that later

@typecat
Copy link
Contributor Author

typecat commented Apr 7, 2022

The YAML file contents are validated against a JSON schema

Moved this into an own issue for further evaluation: #88

@typecat typecat closed this as completed Apr 7, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants