Merge pull request #6 from jelu/wetzel

Documentation

.github/workflows/static.yml

@@ -31,18 +31,19 @@ jobs:
  steps:
  - name: Checkout
  uses: actions/checkout@v4
- - name: Build
- run: |
- pip install json-schema-for-humans
- mkdir pages
- generate-schema-doc dns-metrics.schema.json pages
- ( cd pages; ln -s dns-metrics.schema.html index.html )
  - name: Setup Pages
  uses: actions/configure-pages@v5
+ - name: Build
+ run: |
+ npm install wetzel
+ npx wetzel dns-metrics.schema.json > SCHEMA.md
+ - name: Build with Jekyll
+ uses: actions/jekyll-build-pages@v1
+ with:
+ source: ./
+ destination: ./_site
  - name: Upload artifact
  uses: actions/upload-pages-artifact@v3
- with:
- path: "pages"
  - name: Deploy to GitHub Pages
  id: deployment
  uses: actions/deploy-pages@v4

README.md

@@ -3,6 +3,12 @@
 A JSON schema to define DNS metrics that tools can use to generate compatible
 JSON metrics and statistics.
 
+## Documentation
+
+[Documentation](SCHEMA.md) is generated automatically with [wetzel](https://www.npmjs.com/package/wetzel)
+but please note that it does not handle everything correctly, for example
+the oneOf `"type": "..."` is currently not displayed correctly.
+
 ## Test
 
 ```

dns-metrics.schema.json

@@ -43,6 +43,7 @@
  ],
  "$defs": {
  "header": {
+ "title": "DNS Metric Header",
  "description": "A header object that contains information on the schema version and parameters related to the run",
  "type": "object",
  "properties": {
@@ -81,6 +82,7 @@
  "required": [ "schema_version", "generator", "generator_version", "stats_interval" ]
  },
  "event": {
+ "title": "DNS Metric Event",
  "description": "A generic event object for tools to give context on the run",
  "type": "object",
  "properties": {
@@ -96,6 +98,7 @@
  "required": [ "msg" ]
  },
  "stats": {
+ "title": "DNS Metric Stats",
  "description": "A stats object with the metrics",
  "type": "object",
  "properties": {