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

Update Jira Align Swagger Json for Compatibility with ChatGPT Integration

XMLWordPrintable

    • Icon: Suggestion Suggestion
    • Resolution: Unresolved
    • REST API
    • None
    • 1
    • Our product teams collect and evaluate feedback from a number of different sources. To learn more about how we use customer feedback in the planning process, check out our new feature policy.

      Issue Summary

      Some Jira Align users are trying to use ChatGPT's ability to create custom GPTs that can interact with Jira Align through natural language queries. A key step in setting up the GPT involves connecting ChatGPT with Jira Align, which requires uploading an OpenAPI specification of Jira Align to ChatGPT. When they used the JSON file downloaded as an OpenAPI spec from the Jira Align Swagger, they faced several issues due to compatibility and validation errors.

      Steps to Reproduce

      1. Access the Jira Align Swagger
      2. Access the Swagger.json (https://XXXXX.jiraalign.com/rest/align/api/docs/2/swagger.json)
      3. Save it as Json
      4. Use the json file as the OpenAI spec

      Expected Results

      Users expect to be able to upload the Jira Align Swagger JSON file and use it with ChatGPT through OpenAI without any problems.

      Actual Results

      The Jira Align Swagger JSON is not designed to function as an OpenAPI spec. When using the JSON file, the following issues are reported:

      • The spec was marked as version 3.0.1, which is not compatible with ChatGPT's requirement of 3.1.0 or later.
      • It included illegal JSON-Schema elements, such as "required" inside single property definitions.
      • There were casing mismatches in required lists, causing validation failures.
      • Patterns were misused for prose instead of valid ECMA-262 regex.
      • String-length constraints were incorrectly applied to non-string types.

              74e326a60875 Arulganesh Arumugachandran
              f9fc804f30c6 Luiz Felipe Arruda
              Votes:
              1 Vote for this issue
              Watchers:
              3 Start watching this issue

                Created:
                Updated: