Skip to content

[Feature Request]: Align schema handling with CMSIS-Solution approach and test documentation links for completeness #99

Description

@jkrech

Description

Optimize schema and documentation for best user experience.

CMSIS SDS VS Code extension v0.11.0 manages schema reference in .vscode/setting.json

    "yaml.schemas": {
        "file:///c%3A/Users/jkrech/.vscode/extensions/arm.cmsis-sds-0.11.0-win32-x64/schema/sds.schema.json": [
            "**/*.sds.yml",
            "**/*.sds.yaml"
        ],
        "file:///c%3A/Users/jkrech/.vscode/extensions/arm.cmsis-sds-0.11.0-win32-x64/schema/sdsio.schema.json": [
            "**/*.sdsio.yml",
            "**/*.sdsio.yaml"
        ]
    },

Why is that required?

Incomplete links to documentation:
E.g. top level node in *.sdsio.yml

sdsio: does not link to documentation https://arm-software.github.io/SDS-Framework/main/utilities.html#sdsio

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "SDSIO Control File Schema \nDocumentation: https://arm-software.github.io/SDS-Framework/main/utilities.html#sdsio",
  "description": "Schema for SDSIO control files (.sdsio.yml)",
  "type": "object",
  "required": ["sdsio"],

Is this request a Security Requirement?

  • Yes

Metadata

Metadata

Assignees

Labels

No labels
No labels

Fields

No fields configured for Feature.

Projects

Status
In progress

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions