IQSS / IQSS/dataverse

Feature Request/Idea: Review of used regex

Open
#10,607 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Type: Feature
Dominant language
Java
Stars
1.1k
Forks
564
Avg merge
2d 2h
Merged PRs (30d)
29

Description

Overview of the Feature Request

While working on the OpenAPI document fix on #10328 we did some validations using https://quobix.com/vacuum/ where we noticed that we were using some regular expressions that are not compatible with ECMA-262 "^[^:<>;#/\"\\*\\|\\?\\\\]*$" and raise an error.

Our endpoints work with JSON and JavaScript frontends like React so it would make sense to review and abide by the standard that regex uses for ECMA-262, https://json-schema.org/understanding-json-schema/reference/regular_expressions

Also as mentioned by @pdurbin there are some issues raised by Datalad about name conflicts on some languages: https://docs.datalad.org/projects/dataverse/en/latest/settingup.html#dataverse-limitations

"Dataverse will not accept names like Änderungen or Déchiffrer, due to the Ä and é in them."

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by auditing the OpenAPI document and its regular expressions with vacuum, then compare them against the ECMA-262 and JSON Schema regular-expression guidance. Review the linked Datalad limitation for conflicting names; done should mean the affected expressions and naming conflicts have been identified and a concrete compatibility scope has been agreed.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, openapi, react
Domain
api, backend-api-design
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.