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

Document pre-compiled schemas for CSP in README #1239

Merged
merged 4 commits into from Jul 1, 2020
Merged

Document pre-compiled schemas for CSP in README #1239

merged 4 commits into from Jul 1, 2020

Conversation

GrahamLea
Copy link
Contributor

@GrahamLea GrahamLea commented Jun 30, 2020

Pre-compiled schemas are a workaround for maintaining a secure Content Security Policy (CSP)

What issue does this pull request resolve?
#1228

What changes did you make?
Added two paragraphs to the README

Is there anything that requires more attention while reviewing?
Unlikely

Pre-compiled schemas are a workaround for maintaining a secure Content Security Policy (CSP)
Fixes #1228
@GrahamLea
Copy link
Contributor Author

GrahamLea commented Jun 30, 2020

I've added this under the "Using in browser" section, but it could also fit in the "Security considerations" section.
I didn't add it to the menu at the top as I wasn't sure whether it needed to contain all level 3 headings.

@epoberezkin
Copy link
Member

epoberezkin commented Jun 30, 2020

Thank you. I think it is important to comment somehow that the schemas, if they successfully compile, are equivalent, but that not everything that can be compile with ajv can be processed with ajv-pack. As is the change may create impression that the compiled schemas are not equivalent.

Re placement - I don't mind either way, it's ok in browser section, there can be a link from security section if you like.

@GrahamLea
Copy link
Contributor Author

GrahamLea commented Jun 30, 2020

I think it is important to comment somehow that the schemas, if they successfully compile, are equivalent, but that not everything that can be compile with ajv can be processed with ajv-pack.

Ah, yeah, thanks. I wasn't totally sure on what the deal was there. i.e. whether the limitations were in compiling or in the functionality of the compiled schemas. I've revised that text now to be clearer.

Also added a Contents link and a link from the Security section.

@epoberezkin epoberezkin merged commit 65e3678 into ajv-validator:master Jul 1, 2020
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants