Documentation errors for filters in generated REST API docs

XMLWordPrintable

    • 5
    • Severity 3 - Minor
    • Hide
      Atlassian Update – 06 December 2017

      Hi everyone,

      We have recently reviewed this issue and the overall interest in the problem. As the issue hasn't collect votes, watchers, comments, or support cases from many customers during its lifetime, it's very low on our priority list, and will not be fixed in the foreseeable future. That's why we've decided to resolve it as Time Out.

      Although we're aware the issue is still important to those of you who were involved in the conversations around it, we want to be clear in managing your expectations. The Jira team is focusing on issues that have broad impact and high value, reflected by the number of comments, votes, support cases, and customers interested. Please consult the Atlassian Bugfix Policy for more details.

      We understand how disappointing this decision may be, but we hope you'll appreciate our transparent approach and communication.
      Atlassian will continue to watch this issue for further updates, so please feel free to share your thoughts in the comments.
      Thank you,
      Ignat Alexeyenko
      Jira Bugmaster

      Show
      Atlassian Update – 06 December 2017 Hi everyone, We have recently reviewed this issue and the overall interest in the problem. As the issue hasn't collect votes, watchers, comments, or support cases from many customers during its lifetime, it's very low on our priority list, and will not be fixed in the foreseeable future. That's why we've decided to resolve it as Time Out . Although we're aware the issue is still important to those of you who were involved in the conversations around it, we want to be clear in managing your expectations. The Jira team is focusing on issues that have broad impact and high value, reflected by the number of comments, votes, support cases, and customers interested. Please consult the Atlassian Bugfix Policy for more details. We understand how disappointing this decision may be, but we hope you'll appreciate our transparent approach and communication. Atlassian will continue to watch this issue for further updates, so please feel free to share your thoughts in the comments. Thank you, Ignat Alexeyenko Jira Bugmaster

      https://docs.atlassian.com/jira/REST/5.2.6/#id105416

      There appear to be copy/paste errors for the REST API docs for filters, plus some of the expand/collapse sections don't work

      API Docs Problem
      POST /rest/api/2/filter "acceptable request representations" application/json expand/collapse doesn't work
      POST /rest/api/2/filter Response 400: "Returned if there is a problem looking up the filter given the id" This API creates a new filter and doesn't look up an ID
      PUT /rest/api/2/filter/defaultShareScope "acceptable request representations" application/json expand/collapse doesn't work
      GET /rest/api/2/filter/favourite Response 400: "Returned if there is a problem looking up the filter given the id" This API gets a list of filters and doesn't look up an ID
      PUT /rest/api/2/filter/[id] "acceptable request representations" application/json expand/collapse doesn't work
      DELETE /rest/api/2/filter/[id] "acceptable response representations" "200 - application/json (filter)" expand/collapse doesn't work

              Assignee:
              Mel Paisley (Inactive)
              Reporter:
              Gilmore Davidson (Inactive)
              Votes:
              0 Vote for this issue
              Watchers:
              0 Start watching this issue

                Created:
                Updated:
                Resolved: