Uploaded image for project: 'Jira Align'
  1. Jira Align
  2. JIRAALIGN-5479

API: Incorrect status code 200 is documented in Swagger for Connector POST endpoints instead of 201

    XMLWordPrintable

Details

    • Bug
    • Resolution: Fixed
    • Low
    • 10.132.0
    • 10.124.3
    • REST API
    • 1
    • Severity 3 - Minor
    • No

    Description

      Issue Summary

      Incorrect status code 200 is documented in Swagger for Connector POST endpoints instead of 201, which is inconsistent with the actual behaviour and the rest of API POST request docs.

      Steps to Reproduce

      1. Send a valid POST request to any of the Connector endpoints that accept it:
        • POST /align/api/2/Connectors/{connectorId}/projects
        • POST /align/api/2/Connectors/{connectorId}/boards
        • POST /align/api/2/Connectors/{connectorId}/products
        • POST /align/api/2/Connectors/{connectorId}/customFields/teams
      2. Observe the returned status is 201, which is consistent with the rest of the API behavior
      3. However in Swagger UI, for those endpoints, we see the success status code documented is 200

      Expected Results

      Swagger UI should show status code 201 for successful POST requests for the connector endpoints, to be consistent with the actual functionality and the rest of the documentation.

      Actual Results

      API returns status code 201, but Swagger UI indicates it should be status code 200.

      Workaround

      Please use status code 201 to check for success.

      Attachments

        Issue Links

          Activity

            People

              fea1a6ef3355 Yannick Genin
              c7f2a2ebc58e Kirill Duplyakin
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved:

                Backbone Issue Sync