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

Incomplete documentation in RequestValidator.cs #745

Open
JohnRosner opened this issue May 21, 2024 · 0 comments
Open

Incomplete documentation in RequestValidator.cs #745

JohnRosner opened this issue May 21, 2024 · 0 comments

Comments

@JohnRosner
Copy link

Issue Summary

There is incomplete documentation to the public facing methods of RequestValidator.cs
Specifically the overloaded Validate method and ValidateBody method are missing docs. Link

Code Snippet

public bool Validate(string url, string body, string expected)

public bool ValidateBody(string rawBody, string expected)

Details

In addition to including documentation for these two methods, I'd like the following details clarified in the documentation:

  • For the Validate function that takes in the body string, the bodySHA256 parameter should be included in the url
  • the expected string is the Twilio signature from the request header. ("expected result" is not specific enough in my opinion)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant