Documentation based on JSON Schema

Question

I'd like to use my JSON schemas to generate the documentation.

In the example below, I want to list all combinations ErrorNumber/ErrorMessage available in my output messages in JSON.

But I can't find a way on the object level, my attempts with "examples" or "enum" failed.

Does anyone have a solution?

{
    "type": "object",
    "required": [
        "ErrorNumber",
        "ErrorMessage"
    ],
    "properties": {
        "ErrorNumber": {
            "$id": "#root/ErrorNumber", 
            "type": "integer"
        },
        "ErrorMessage": {
            "$id": "#root/ErrorMessage", 
            "type": "string"
        }
    }
}

Arthur_J · Accepted Answer · 2021-10-07 11:17:19Z

Did you mean to write "$ref" where you use "$id" in the example?
Where exactly did you have problems with enum? The following works fine for me with a draft-2020-12 Validator (and after removing your "$id"!):

{
  // ... your JSON here ...
  "enum": [
    {"ErrorNumber": 200, "ErrorMessage": "OK"},
    {"ErrorNumber": 404, "ErrorMessage": "Not found."}
    // ...
  ]
}

Different approaches, in case you still can change that:

If your error numbers start at 0 and are contiguous, then an Array of messages might serve your purpose.

Alternatively an object with numerical keys might:

{
  "200": "OK",
  "404": "Not found."
}

Collectives™ on Stack Overflow

Documentation based on JSON Schema

1 Answer 1

Comments

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Related