Uploaded image for project: 'OpenIDM'
  1. OpenIDM
  2. OPENIDM-7222

Add JSON Schema descriptions to managed.json

    XMLWordPrintable

    Details

    • Type: Bug
    • Status: Closed
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: OpenIDM 5.5.0
    • Component/s: _Schema
    • Labels:

      Description

      managed.json contains JSON Schema used to generate the API Description. However, it is currently lacking many "description" fields, which would enhance what is displayed in Swagger UI.

      • "title" needed for types
      • "description" needed for fields ("title" will be ignored by Swagger UI)

      Here is a good example already in managed.json, with "title" and "description" where needed,

                          "preferences" : {
                              "title" : "Preferences",
                              "viewable" : true,
                              "searchable" : false,
                              "userEditable" : true,
                              "type" : "object",
                              "properties" : {
                                  "updates" : {
                                      "description" : "Send me news and updates",
                                      "type" : "boolean"
                                  },
                                  "marketing": {
                                      "description" : "Send me special offers and services",
                                      "type" : "boolean"
                                  }
                              },
                              "order": [
                                  "updates",
                                  "marketing"
                              ],
                              "required": []
                          },
      

        Attachments

          Activity

            People

            Assignee:
            joy.feng Joy Feng [X] (Inactive)
            Reporter:
            travis.haagen Travis Haagen [X] (Inactive)
            Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

              Dates

              Created:
              Updated:
              Resolved: