Uploaded image for project: 'Apache NiFi'
  1. Apache NiFi
  2. NIFI-1113

Address missing endpoints in REST API documentation

    Details

    • Type: Improvement
    • Status: Open
    • Priority: Major
    • Resolution: Unresolved
    • Affects Version/s: None
    • Fix Version/s: None
    • Labels:
      None

      Description

      Due to a shortcoming in the tool used to generate the REST API documentation, any endpoints that are overloaded (same path but consume different media types) get ignored. Because of this, only a single media type is documented for each endpoint that is overloaded. Here is a discussion of the issue [1].

      I'm not sure that it is going to resolve itself in a timely manner. We may need to consider another documentation option. Unfortunately, swagger was best in class at the time.

      Another option is that we could create new endpoints that aren't overloaded and essentially deprecate the overloaded versions. Which we could remove when we release 1.0.0. This would allow us to ensure everything is documented without breaking any backwards compatibility.

      [1] https://github.com/swagger-api/swagger-spec/issues/146

        Attachments

          Activity

            People

            • Assignee:
              Unassigned
              Reporter:
              mcgilman Matt Gilman
            • Votes:
              0 Vote for this issue
              Watchers:
              4 Start watching this issue

              Dates

              • Created:
                Updated: