Skip to content

[BE] WebIDE: Custom schema validation [RUN AS-IF-FOSS]

Himanshu Kapoor requested to merge 226982-custom-schemas-backend into master

What does this MR do?

Issue: #226982 (closed)

Note: This MR includes the backend logic only. Frontend logic is added in !41700 (merged)

Add support for validating custom JSON and YAML files in the Web IDE using schemas defined in the .gitlab/.gitlab-webide.yml file.

You can test it out on any project by adding the following to the above file:

schemas:
  - uri: https://json.schemastore.org/package
    match: 
      - package.json

This is an Enterprise Edition feature available only for GitLab Premium and above. So you would need an appropriate license to test this out.

Note: This MR also fixes issues #232761 (closed).

The schemas not loading in Google Chrome is the prime reason we implemented this backend proxy approach. Additionally this logic in the backend does not need YAML parsing library to be loaded in the frontend thus saving a couple of bytes and processing in the Web IDE frontend.

Screenshots

Does this MR meet the acceptance criteria?

Conformity

Availability and Testing

Security

If this MR contains changes to processing or storing of credentials or tokens, authorization and authentication methods and other items described in the security review guidelines:

  • Label as security and @ mention @gitlab-com/gl-security/appsec
  • The MR includes necessary changes to maintain consistency between UI, API, email, or other methods
  • Security reports checked/validated by a reviewer from the AppSec team
Edited by Himanshu Kapoor

Merge request reports