Orange-OpenSource / ods-ios

A SwiftUI components library with code examples for Orange Design System
https://orange-opensource.github.io/ods-ios/
MIT License
26 stars 6 forks source link

[Doc]: JSON Schema #696

Open jy95 opened 6 months ago

jy95 commented 6 months ago

Documentation Location

https://github.com/Orange-OpenSource/ods-ios/blob/qualif/DEVELOP.md

Current issue

The schema is put in markdown file :

// Can be stored in a schema.json file for further tests
{
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "$id": "https://github.com/Orange-OpenSource/ods-ios/schema/AppNews",
    "title": "App News",
    "description": "The catalog of app news with date, versions and news",
    "items": {
        "type": "object",
        "properties": {
            "version": {
                "description": "The version of the app with these news, matching the releases",
                "type": "string"
            },
            "date": {
                "description": "The date in yyyy-MM-dd format",
                "type": "string"
            },
            "news": {
                "description": "The main news of the app",
                "type": "string"
            }
        }
    },
  "required": [ "version", "date", "news" ]
}

Expected Correction

Have a interactive way such as in a Docusaurus documentation with docusaurus-json-schema-plugin

Additional context

Could be used in other Orange-OpenSource repos if you want ;)