OpenAPI version 3.1.0 is not supported. when creating Copilot Declarative Agent

[alexheat]

Describe the bug
When attempting to import an OpenAPI specification file, an error message is displayed stating: "OpenAPI version 3.1.0 is not supported. Use version 3.0.x."

To Reproduce
Steps to reproduce the behavior:

1. Create new App in the Teams Toolkit
2. Choose Declarative Agent and then Add Plugin and Start with an OpenAPI Description Document
3. Browse for a file with OpenAI schema version 3.1.0 (see attached file as a sample)
4. Upon import I get an error "OpenAPI version 3.1.0 is not supported. Use version 3.0.x."
   

Expected behavior
Open AI GPTs only support Open API 3.1.0 so in order to import an existing OpenAPI description the Teams Toolkit should support the 3.1.0 schema

Screenshots
If applicable, add screenshots to help explain your problem.

From Open AI GPTs: They don't support OpenAPI 3.0

VS Code Extension Information (please complete the following information):

• OS: Mac
• Version: v5.9.2024091807

CLI Information (please complete the following information):

• OS: 14.6.1
• Version: 3.0.2

Additional context
Sample file for testing attached here: sample.json

{
  "openapi": "3.1.0",
  "info": {
    "title": "Get weather data",
    "description": "Retrieves current weather data for a location.",
    "version": "v1.0.0"
  },
  "servers": [
    {
      "url": "https://weather.example.com"
    }
  ],
  "paths": {
    "/location": {
      "get": {
        "description": "Get temperature for a specific location",
        "operationId": "GetCurrentWeather",
        "parameters": [
          {
            "name": "location",
            "in": "query",
            "description": "The city and state to retrieve the weather for",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "deprecated": false
      }
    }
  },
  "components": {
    "schemas": {}
  }
}

[SLdragon]

Hi, @alexheat , this is a known limitation for Copilot Declarative Agent, because the backend using OpenAPI.NET to parse OpenAPI spec file, which currently only support version < 3.1.0. We will support it once it is ready

Related issue can be found here:
microsoft/OpenAPI.NET#795

For your scenario, if you're not using OpenAPI 3.1.0 features, you can change it to 3.0 for the Copilot Declarative Agent and keep it at 3.1.0 for OpenAI GPTs.

[abms26]

Is there a document for supported OpenAPI specs by teams toolkit?

I am facing errors like this when I try to create a plugin for a declarative agent, but the error logs are not very informative:

(×) Error: No supported API is found in the OpenAPI description document.
Reasons for API incompatibility are listed below:
GET /HttpTriggerWithOpenAPICSharp1: authorization type is not supported
GET /PromptFlowAPIHTTPTrigger: authorization type is not supported

[SpecParser.update-manifest-failed]: Unsupported schema in post /score: {"additionalProperties":{},"type":"object"}

[SLdragon]

Hi @abms26,

Please try using TTKs version 13 or later for improved compatibility with various OpenAPI specifications and enhanced project scaffolding.

Regarding authentication, Declarative Agent supports OAuth 2.0 (auth code flow), API key authentication (header/query), and Microsoft Entra ID SSO. Other authentication types are not currently supported.

https://learn.microsoft.com/en-us/microsoft-365-copilot/extensibility/api-plugin-authentication