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.

Sign up for GitHub

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

Jump to bottom

Create eslint rule to prevent the use of ByServerRelativeUrl API #5333

Closed
milanholemans opened this issue Jul 20, 2023 · 2 comments
Closed

Create eslint rule to prevent the use of ByServerRelativeUrl API #5333

milanholemans opened this issue Jul 20, 2023 · 2 comments
Assignees
@Jwaegebaert
Labels
enhancement work in progress
Milestone
v7.1

Comments

@milanholemans
Copy link
Contributor

Let's add an eslint rule to prevent some SP APIs from being used. We should avoid ByServerRelativeUrl API endpoints because they don't support files and folders with # and % characters in their name.

Following API endpoints should be avoided

  • GetFileByServerRelativeUrl
  • GetFolderByServerRelativeUrl

Instead, we should use:

  • GetFileByServerRelativePath
  • GetFolderByServerRelativePath

This issue is on hold until these issues are closed:
@Jwaegebaert
Copy link
Contributor

Awesome idea to create an eslint rule for this situation so we can prevent it from getting back into our codebase.

@milanholemans
Copy link
Contributor Author

Moved from on hold to help wanted.

@Jwaegebaert Jwaegebaert self-assigned this Aug 23, 2023
Jwaegebaert added a commit to Jwaegebaert/cli-microsoft365 that referenced this issue Aug 27, 2023
@Jwaegebaert
Adds new eslint rule: Prevent usage of 'ByServerRelativeUrl' endpoint. …
6c37955 
…Closes pnp#5333
@Jwaegebaert Jwaegebaert mentioned this issue Aug 27, 2023
Closed
Jwaegebaert added a commit to Jwaegebaert/cli-microsoft365 that referenced this issue Aug 31, 2023
@Jwaegebaert
Adds new eslint rule: Prevent usage of 'ByServerRelativeUrl' endpoint. …
7bcc384 
…Closes pnp#5333
@waldekmastykarz waldekmastykarz added this to the v7.1 milestone Oct 8, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Jwaegebaert Jwaegebaert

Labels
enhancement work in progress
Projects
None yet
Milestone
v7.1
Development

Successfully merging a pull request may close this issue.

Adds new eslint rule: Prevent usage of 'ByServerRelativeUrl' endpoint Jwaegebaert/cli-microsoft365
3 participants
@waldekmastykarz @milanholemans @Jwaegebaert