OpenAPI 3.0+ null Type Parsing Not Supported

[LeePui]

Self Checks

• I have searched for existing issues search for existing issues, including closed ones.
• I confirm that I am using English to submit this report (我已阅读并同意 Language Policy).
• Pleas do not modify this template :) and fill in all the required fields.

Dify version

0.5.6

Cloud or Self Hosted

Self Hosted (Docker)

Steps to reproduce

Description

dify does not currently support parsing OpenAPI 3.0+ specifications that use the null type as part of a anyOf/oneOf construct. According to the OpenAPI 3.0+ specification, fields can be specified as nullable either by using the nullable keyword or by including null as one of the types in an anyOf/oneOf construct.

Steps to Reproduce

1. Include a field in an OpenAPI 3.0+ specification with a null type as part of an anyOf construct.
2. Attempt to parse the specification with dify.
3. Observe that the null type is not handled correctly.

3.0+ openapi format:

"properties": {
          "chatId": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Chatid",
            "description": "chatId"
          },

✔️ Expected Behavior

When presented with a schema that includes a field with types including null using the anyOf construct, dify should correctly interpret this as a field that can have a null value or the other specified type.

❌ Actual Behavior

[dosubot]

🤖

Thank you for the detailed report, LeePui. I understand that you're encountering an issue with dify not correctly parsing the null type in an anyOf construct in OpenAPI 3.0+ specifications.

To better assist you, could you please provide the following additional information:

1. The complete error message you're seeing when the parsing fails.
2. The version of Docker you're using for self-hosting.
3. If possible, a more complete snippet of the OpenAPI specification you're trying to parse.

This information will help me understand the issue more clearly and provide a more accurate solution. Thank you for your cooperation.

About Dosu

This response is meant to be useful and save you time. It is not meant to be a precise solution, but rather a starting point for your own research.

Help me be more useful! Please leave a 👍 if this is helpful and 👎 if it is irrelevant.

If you want to continue the conversation, start your reply with @dosu-bot.

[Yeuoly]

Could you pls provider the openapi schema you are using for this?

[LeePui]

Could you pls provider the openapi schema you are using for this?

• fastapi==0.104.0

sure，I provide an interface using Python and FastAPI. Here is my base model：

class DrawBaseModel(BaseModel):
    """a test model
    """
    chatId: Optional[str] = Field(None, description="chatId")
    prompt: str = Field(..., description="prompt")

Here is openapi.json like:

{
  "openapi": "3.1.0",
  "info": {
    "title": "FastAPI",
    "version": "0.1.0"
  },
  "servers": [
    {
      "url": "https://xxx.com"
    }
  ],
  "paths": {
    "/draw": {
      "post": {
        "summary": "draw pic",
        "description": "Draw a picture according to the prompts",
        "x-openai-isConsequential": false,
        "operationId": "draw_post",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/DrawBaseModel"
              }
            }
          },
          "required": true
        }
      }
    }
  },
  "components": {
    "schemas": {
      "DrawBaseModel": {
        "properties": {
          "chatId": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Chatid",
            "description": "chatId"
          },
          "prompt": {
            "type": "string",
            "title": "Prompt",
            "description": "prompt"
          }
        },
        "type": "object",
        "title": "test_model",
        "description": "a test model"
      }
    }
  }
}

When I use Dify to create custom tools and then test, I get the following error:

/console/api/workspaces/current/tool-provider/api/test/pre response:

If the above openapi.json is imported into GPTS, it can be parsed correctly.

If I change the 'chatId' inside the above JSON to this, Dify will be able to parse it correctly:

"chatId": {
    "type": "string",
    "title": "Chatid",
    "description": "chatId"
}

[Yeuoly]

Thanks for your reports, it has been fixed and merged into main branch.

[crazywoola]

Fixed #2625