Document usage of Vaadin interernal requests (/VAADIN/*, etc.)
Nobody has claimed this yet.
- Dominant language
- AsciiDoc
- Stars
- 38
- Forks
- 225
- Avg merge
- 1d 4h
- Merged PRs (30d)
- 170
Description
In a Vaadin Flow app, we can observe many requests being made to the application, which are framework internal.
Typically these requests have the url of /VAADIN/*
While users can observe these from the browser network tools, there is no documentation regarding what these are and what they do.
It would be nice to have atleast the nature of these requests documented, with some guidance for users along the lines of whether these urls should be protected behind an authentication layer or not.
If you think this issue is important, add a 👍 reaction to help the community and maintainers prioritize this issue.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the framework-internal requests visible under /VAADIN/* in a Vaadin Flow app and identify their general purpose. Document the nature of these requests and provide guidance on whether they should be protected by authentication, using the browser network tools to verify the request categories.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation, security
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100