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

[Feature Request] Additional tasks related to the docfx JSON schema #9867

Open
filzrev opened this issue Apr 12, 2024 · 0 comments
Open

[Feature Request] Additional tasks related to the docfx JSON schema #9867

filzrev opened this issue Apr 12, 2024 · 0 comments
Labels
fundamental Engineering system and core components

Comments

@filzrev
Copy link
Contributor

filzrev commented Apr 12, 2024

Summary

docfx JSON Schema definition files are merged to main branch (#9852).

So it can validate JSON/YAML files with following schema URL.

How to test JSON Schema for docfx.
Reference following URLs from editor that support JSON Schema.
And verify validation/intellisense works as expected for JSON/YAML files.

Note

If there is problems. Please report problem this issue or create new issues.

Known issues

  • Currently enum is handled as case sensitive.
    (It's because there is no supports for case insensitive enums. and it require additinal regex pattern)
  • docfx JSON Schema is using JSONSchema older version draft-07 (It's latest version supported by Visual Studio)
    But "$defs" schemas are used instead of $definition. ($defs is supported after 2019-09 or later)

Remaining tasks
If there are no major problems are reported.
The following tasks will be completed in this issue.

  1. Create PR to update SchemaStore's JSON Schema for docfx.
    (SchemaStore's JSON schema files are used if $schema URL is not specified)
  2. Add schema validation logics when loading docfx.json config. (For better syntax error reporting)
  3. Reorganize Config Reference page contents based on JSON schema.
    4, Add automated tests to verify JSON Schema related changes (By using schema that generated automatically from source code)
@yufeih yufeih added the fundamental Engineering system and core components label Apr 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
fundamental Engineering system and core components
Projects
None yet
Development

No branches or pull requests

2 participants