feat: add json schema

[SethFalco]

• Closes Publish configuration file schema to http://schemastore.org #6363
  • As soon as this is merged, I'll make the PR and get it added to the JSON Schema Store catalog.
• Closes Created Schema from Yaml to JSON  #6501

Assuming I've understood the YAML Schema correctly (I did read the Yamale README), I believe they should be equivalent (or at least almost equivalent.)

I made a new PR instead of reviewing an older one, as I felt there was a lot to change.

I've tested this against the following:

• https://github.com/pytube/pytube/blob/master/.readthedocs.yml
• https://github.com/Rapptz/discord.py/blob/master/.readthedocs.yml
• https://github.com/deepmind/open_spiel/blob/master/readthedocs.yml
• https://github.com/tensorlayer/hyperpose/blob/master/.readthedocs.yml
• https://github.com/deepchem/deepdock/blob/master/.readthedocs.yml

Note: Before testing I manually changed all python.version values to 3.6 as original values (3.7/3.8) aren't valid against the schema. (Maybe consider using string rather than enum here?)

Let me know if anything looks off to you!

Subtle Differences

• For paths, it just accepts any string. I could validate it against a regex? I thought maybe just leaving it as any string would be fine.

[stsewd]

Thanks for taking over this!

[SethFalco]

Redirects aren't implemented yet, either.

I interpreted that as "take that same action as with pip file support".
Let me know if that was wrong of me!

Just noting the dropped sections here for future reference.

Pipfile (properties.python.properties.install.items.anyOf[2])

{
  "properties": {
    "pipfile": {
      "title": "Pipfile",
      "description": "The path to the directory that contains the Pipfile.",
      "type": "string"
    },
    "dev": {
      "title": "Dev",
      "description": "Add the --dev option to pipenv install.",
      "type": "boolean",
      "default": false
    },
    "ignore_pipfile": {
      "title": "Ignore Pipfile",
      "description": "Add the --ignore-pipfile option to pipenv install.",
      "type": "boolean",
      "default": true
    },
    "skip_lock": {
      "title": "Skip Lock",
      "description": "Add the --skip-lock option to pipenv install.",
      "type": "boolean",
      "default": true
    }
  },
  "required": [
    "pipfile"
  ]
}

Redirects (properties.redirects)

"redirects": {
  "title": "Redirects",
  "description": "Redirects for the current version to be built",
  "properties": {
    "page": {
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "default": null
}

[stsewd]

I interpreted that as "take that same action as with pip file support".

yes, that was it

[SethFalco]

I did the things you asked for , plus one additional change:

Since version only has one possible value, and it's a required field anyway, I figured it might as well also have a default configured to "2" as well.

Would you care to give an opinion on that?

Can I also just confirm, did I reference the correct YAML Schema when I created the JSON Schema? 🤔 (I used this one.)
As in, are your suggestions fixing mistakes of mine, or are they fresh/new changes to keep things up to date?

Does the YAML Schema need to be updated separately as well?

[stsewd]

Since version only has one possible value, and it's a required field anyway, I figured it might as well also have a default configured to "2" as well.

We do allow 1, which is the default to use if you don't set a version, so it should be required.

Can I also just confirm, did I reference the correct YAML Schema when I created the JSON Schema? thinking (I used this one.)
As in, are your suggestions fixing mistakes of mine, or are they fresh/new changes to keep things up to date?

Yeah, that scheme is the one, but it has some ideas that were never implemented, we may remove it and use this json scheme instead of yamale, so no need to update it here.

[stsewd]

Thanks!

[stsewd]

@SethFalco let us know if you need anything from us to submit this to https://github.com/SchemaStore/schemastore/

[SethFalco]

Thanks for that! I think it's simple, so no need to worry.
Just have to add it a reference to the file merged to the catalog.json file in the repo.

• feat: add readthedocs schema to catalog SchemaStore/schemastore#1691

{
  "name": "Read the Docs",
  "description": "Read the Docs configuration file",
  "fileMatch": [
    "readthedocs.yml",
    "readthedocs.yaml",
    ".readthedocs.yml",
    ".readthedocs.yaml"
  ],
  "url": "https://raw.githubusercontent.com/readthedocs/readthedocs.org/master/readthedocs/rtd_tests/fixtures/spec/v2/schema.json"
}