Cannot create the Tool from OpenAPI Spec

[ddobric]

Hi all,

I'm trying to create the tool based on the Open API specification. First of all, it does not work. Independent on this I have many equations.

Cannot Create the Tool

When trying to create the tool, the following error occurs:

I have no idea what this error means.

I'm using the following spec.

{
  "swagger": "3.0.1",
  "info": {
    "title": "Daenet.EmployeeService.Service",
    "version": "1.0"
  },
  "paths":
  {     
    "/api/Project/query": {
      "post": {
        "tags": [
          "Project"
        ],
        "operationId": "QueryListOfProject",
        "consumes": [
          "application/json",
          "text/json",
          "application/*+json"
        ],
        "produces": [
          "text/plain",
          "application/json",
          "text/json"
        ],
        "parameters": [
          {
            "in": "header",
            "name": "ImpersonatingUser"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "allOf": [
                {
                  "$ref": "#/definitions/QueryProject"
                }
              ]
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/Project"
              }
            }
          }
        }
      }
    }
  },
  
  "definitions": {
    "ApprovalState": {
      "enum": [
        "Accepted",
        "Declined",
        "Pending",
        "None"
      ],
      "type": "string"
    },
    "Department": {
      "type": "object",
      "properties": {
        "id": {
          "format": "int64",
          "type": "integer"
        },
        "name": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "color": {
          "type": "string"
        },
        "createdBy": {
          "type": "string"
        },
        "createdAt": {
          "format": "date-time",
          "type": "string"
        },
        "changedBy": {
          "type": "string"
        },
        "changedAt": {
          "format": "date-time",
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "GlobalWorkItem": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        },
        "displayName": {
          "type": "string"
        },
        "ownerDisplayName": {
          "type": "string"
        },
        "type": {
          "allOf": [
            {
              "$ref": "#/definitions/GlobalWorkItemType"
            }
          ]
        },
        "approvalState": {
          "allOf": [
            {
              "$ref": "#/definitions/ApprovalState"
            }
          ]
        },
        "changedAt": {
          "format": "date-time",
          "type": "string"
        },
        "createdAt": {
          "format": "date-time",
          "type": "string"
        },
        "changedBy": {
          "type": "string"
        },
        "createdBy": {
          "type": "string"
        },
        "start": {
          "format": "date-time",
          "type": "string"
        },
        "end": {
          "format": "date-time",
          "type": "string"
        },
        "id": {
          "format": "int64",
          "type": "integer"
        },
        "ownerId": {
          "format": "int64",
          "type": "integer"
        },
        "dateFrom": {
          "type": "string"
        },
        "dateTo": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "GlobalWorkItemQuery": {
      "type": "object",
      "properties": {
        "types": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/GlobalWorkItemType"
          }
        },
        "users": {
          "type": "array",
          "items": {
            "format": "int64",
            "type": "integer"
          }
        },
        "from": {
          "format": "date-time",
          "type": "string"
        },
        "to": {
          "format": "date-time",
          "type": "string"
        },
        "approvalState": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/ApprovalState"
          }
        }
      },
      "additionalProperties": false
    },
    "GlobalWorkItemType": {
      "enum": [
        "Vacation",
        "Illness",
        "Holiday",
        "CalculationItem"
      ],
      "type": "string"
    },
    "PipelineSlot": {
      "type": "object",
      "properties": {
        "id": {
          "format": "int64",
          "type": "integer"
        },
        "title": {
          "type": "string"
        },
        "subTitle": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "location": {
          "type": "string"
        },
        "projectID": {
          "format": "int64",
          "type": "integer"
        },
        "start": {
          "format": "date-time",
          "type": "string"
        },
        "end": {
          "format": "date-time",
          "type": "string"
        },
        "personHours": {
          "format": "double",
          "type": "number"
        },
        "personDays": {
          "format": "double",
          "type": "number"
        },
        "changedAt": {
          "format": "date-time",
          "type": "string"
        },
        "createdBy": {
          "type": "string"
        },
        "createdAt": {
          "format": "date-time",
          "type": "string"
        },
        "owner": {
          "type": "string"
        },
        "changedBy": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "PipelineState": {
      "type": "object",
      "properties": {
        "fromDateTime": {
          "format": "date-time",
          "type": "string"
        },
        "toDateTime": {
          "format": "date-time",
          "type": "string"
        },
        "workingHours": {
          "format": "int32",
          "type": "integer"
        },
        "noneWorkingHours": {
          "format": "int32",
          "type": "integer"
        },
        "hours": {
          "format": "int32",
          "type": "integer"
        },
        "days": {
          "format": "double",
          "type": "number"
        },
        "commitedHours": {
          "format": "int32",
          "type": "integer"
        },
        "projects": {
          "type": "array",
          "items": {
            "format": "int64",
            "type": "integer"
          }
        },
        "pipelineSlots": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/PipelineSlot"
          }
        },
        "changedBy": {
          "type": "string"
        },
        "changedAt": {
          "format": "date-time",
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "Project": {
      "type": "object",
      "properties": {
        "parentProject": {
          "format": "int64",
          "type": "integer"
        },
        "name": {
          "type": "string"
        },
        "displayName": {
          "type": "string"
        },
        "id": {
          "format": "int64",
          "type": "integer"
        },
        "description": {
          "type": "string"
        },
        "color": {
          "type": "string"
        },
        "createdAt": {
          "format": "date-time",
          "type": "string"
        },
        "createdBy": {
          "type": "string"
        },
        "changedAt": {
          "format": "date-time",
          "type": "string"
        },
        "changedBy": {
          "type": "string"
        },
        "validTo": {
          "format": "date-time",
          "type": "string"
        },
        "validFrom": {
          "format": "date-time",
          "type": "string"
        },
        "extSysID1": {
          "type": "string"
        },
        "extSysID2": {
          "type": "string"
        },
        "extSysName1": {
          "type": "string"
        },
        "extSysName2": {
          "type": "string"
        },
        "workActivities": {
          "type": "array",
          "items": {
            "format": "int32",
            "type": "integer"
          }
        }
      },
      "additionalProperties": false
    },
    "ProjectLocation": {
      "type": "object",
      "properties": {
        "id": {
          "format": "int64",
          "type": "integer"
        },
        "name": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "color": {
          "type": "string"
        },
        "createdBy": {
          "type": "string"
        },
        "createdAt": {
          "format": "date-time",
          "type": "string"
        },
        "changedBy": {
          "type": "string"
        },
        "changedAt": {
          "format": "date-time",
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "PublicHoliday": {
      "type": "object",
      "properties": {
        "id": {
          "format": "int32",
          "type": "integer"
        },
        "description": {
          "type": "string"
        },
        "country": {
          "type": "string"
        },
        "state": {
          "type": "string"
        },
        "city": {
          "type": "string"
        },
        "date": {
          "format": "date-time",
          "type": "string"
        },
        "createdAt": {
          "format": "date-time",
          "type": "string"
        },
        "createdBy": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "QueryDepartment": {
      "type": "object",
      "properties": {
        "nameContains": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "QueryLocation": {
      "type": "object",
      "properties": {
        "nameContains": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "QueryProject": {
      "type": "object",
      "properties": {
        "nameContains": {
          "type": "string"
        },
        "parentID": {
          "format": "int32",
          "type": "integer"
        }
      },
      "additionalProperties": false
    },
    "QueryPublicHoliday": {
      "type": "object",
      "properties": {
        "userId": {
          "format": "int32",
          "type": "integer"
        },
        "from": {
          "format": "date-time",
          "type": "string"
        },
        "to": {
          "format": "date-time",
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "QuerySlot": {
      "type": "object",
      "properties": {
        "users": {
          "type": "array",
          "items": {
            "format": "int64",
            "type": "integer"
          }
        },
        "projects": {
          "type": "array",
          "items": {
            "format": "int64",
            "type": "integer"
          }
        },
        "fromDateTime": {
          "format": "date-time",
          "type": "string"
        },
        "toDateTime": {
          "format": "date-time",
          "type": "string"
        },
        "owner": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "QueryUserProjectRole": {
      "type": "object",
      "properties": {
        "projectID": {
          "format": "int64",
          "type": "integer"
        },
        "userName": {
          "type": "string"
        },
        "roleID": {
          "format": "int32",
          "type": "integer"
        }
      },
      "additionalProperties": false
    },
    "QueryWorkSheet": {
      "type": "object",
      "properties": {
        "users": {
          "type": "array",
          "items": {
            "format": "int64",
            "type": "integer"
          }
        },
        "projects": {
          "type": "array",
          "items": {
            "format": "int64",
            "type": "integer"
          }
        },
        "fromDate": {
          "format": "date-time",
          "type": "string"
        },
        "toDate": {
          "format": "date-time",
          "type": "string"
        },
        "crmId": {
          "format": "uuid",
          "type": "string"
        },
        "splitToMultiplePages": {
          "type": "boolean"
        },
        "workActivity": {
          "format": "int32",
          "type": "integer"
        },
        "action": {
          "format": "int32",
          "type": "integer"
        },
        "fromOffset": {
          "format": "int32",
          "type": "integer"
        },
        "toOffset": {
          "format": "int32",
          "type": "integer"
        },
        "excludeTimes": {
          "type": "boolean"
        },
        "includeVacation": {
          "type": "boolean"
        }
      },
      "additionalProperties": false
    },
    "Role": {
      "type": "object",
      "properties": {
        "id": {
          "format": "int32",
          "type": "integer"
        },
        "projectId": {
          "format": "int32",
          "type": "integer"
        },
        "projectName": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "description": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "ScheduleState": {
      "type": "object",
      "properties": {
        "fromDateTime": {
          "format": "date-time",
          "type": "string"
        },
        "toDateTime": {
          "format": "date-time",
          "type": "string"
        },
        "workingHours": {
          "format": "int32",
          "type": "integer"
        },
        "noneWorkingHours": {
          "format": "int32",
          "type": "integer"
        },
        "hours": {
          "format": "int32",
          "type": "integer"
        },
        "days": {
          "format": "double",
          "type": "number"
        },
        "commitedHours": {
          "format": "int32",
          "type": "integer"
        },
        "projects": {
          "type": "array",
          "items": {
            "format": "int64",
            "type": "integer"
          }
        },
        "pipelineSlots": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/PipelineSlot"
          }
        },
        "changedBy": {
          "type": "string"
        },
        "changedAt": {
          "format": "date-time",
          "type": "string"
        },
        "scheduledSlots": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/ScheduledSlot"
          }
        }
      },
      "additionalProperties": false
    },
    "ScheduledSlot": {
      "type": "object",
      "properties": {
        "id": {
          "format": "int64",
          "type": "integer"
        },
        "title": {
          "type": "string"
        },
        "subTitle": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "location": {
          "type": "string"
        },
        "projectID": {
          "format": "int64",
          "type": "integer"
        },
        "start": {
          "format": "date-time",
          "type": "string"
        },
        "end": {
          "format": "date-time",
          "type": "string"
        },
        "personHours": {
          "format": "double",
          "type": "number"
        },
        "personDays": {
          "format": "double",
          "type": "number"
        },
        "extRef1": {
          "type": "string"
        },
        "extRef2": {
          "type": "string"
        },
        "extRef3": {
          "type": "string"
        },
        "changedAt": {
          "format": "date-time",
          "type": "string"
        },
        "createdBy": {
          "type": "string"
        },
        "createdAt": {
          "format": "date-time",
          "type": "string"
        },
        "changedBy": {
          "type": "string"
        },
        "pipelineSlotId": {
          "format": "int64",
          "type": "integer"
        }
      },
      "additionalProperties": false
    },
    "Token": {
      "type": "object",
      "properties": {
        "id": {
          "format": "int64",
          "type": "integer"
        },
        "currentUser": {
          "allOf": [
            {
              "$ref": "#/definitions/User"
            }
          ]
        },
        "userImageUrl": {
          "type": "string"
        },
        "roles": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "additionalProperties": false
    },
    "User": {
      "type": "object",
      "properties": {
        "id": {
          "format": "int64",
          "type": "integer"
        },
        "name": {
          "type": "string"
        },
        "displayName": {
          "type": "string"
        },
        "imagePath": {
          "type": "string"
        },
        "externalAuthProviderId": {
          "type": "string"
        },
        "externalAuthId": {
          "type": "string"
        },
        "paidHolidays": {
          "format": "int32",
          "type": "integer"
        },
        "email": {
          "type": "string"
        },
        "country": {
          "type": "string"
        },
        "state": {
          "type": "string"
        },
        "city": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "UserProjectRole": {
      "type": "object",
      "properties": {
        "roleID": {
          "format": "int32",
          "type": "integer"
        },
        "projectID": {
          "format": "int64",
          "type": "integer"
        },
        "userName": {
          "type": "string"
        },
        "id": {
          "format": "int32",
          "type": "integer"
        },
        "userID": {
          "format": "int64",
          "type": "integer"
        }
      },
      "additionalProperties": false
    },
    "UserVacationInfo": {
      "type": "object",
      "properties": {
        "availableVacationDays": {
          "format": "int32",
          "type": "integer"
        },
        "remainingVacationDays": {
          "format": "int32",
          "type": "integer"
        },
        "pendingDays": {
          "format": "int32",
          "type": "integer"
        },
        "vacationPerYear": {
          "format": "int32",
          "type": "integer"
        }
      },
      "additionalProperties": false
    },
    "WorkActivity": {
      "type": "object",
      "properties": {
        "id": {
          "format": "int32",
          "type": "integer"
        },
        "displayName": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "extSysName1": {
          "type": "string"
        },
        "extSysName2": {
          "type": "string"
        },
        "extSysID1": {
          "type": "string"
        },
        "extSysID2": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "WorkActivityQuery": {
      "type": "object",
      "properties": {
        "id": {
          "format": "int32",
          "type": "integer"
        },
        "displayName": {
          "type": "string"
        },
        "extSysID1": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "extSysID2": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "WorkItem": {
      "type": "object",
      "properties": {
        "id": {
          "format": "int64",
          "type": "integer"
        },
        "title": {
          "type": "string"
        },
        "subTitle": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "location": {
          "type": "string"
        },
        "department": {
          "type": "string"
        },
        "projectId": {
          "format": "int64",
          "type": "integer"
        },
        "start": {
          "format": "date-time",
          "type": "string"
        },
        "end": {
          "format": "date-time",
          "type": "string"
        },
        "personHours": {
          "format": "double",
          "type": "number"
        },
        "personDays": {
          "format": "double",
          "type": "number"
        },
        "changedAt": {
          "format": "date-time",
          "type": "string"
        },
        "createdBy": {
          "type": "string"
        },
        "createdAt": {
          "format": "date-time",
          "type": "string"
        },
        "pause": {
          "format": "double",
          "type": "number"
        },
        "changedBy": {
          "type": "string"
        },
        "ownerId": {
          "format": "int64",
          "type": "integer"
        },
        "ownerDisplayName": {
          "type": "string"
        },
        "role": {
          "type": "string"
        },
        "extSysName1": {
          "type": "string"
        },
        "extSysName2": {
          "type": "string"
        },
        "extSysId1": {
          "type": "string"
        },
        "extSysId2": {
          "type": "string"
        },
        "calculationItemId": {
          "format": "uuid",
          "type": "string"
        },
        "isDeleted": {
          "type": "boolean"
        },
        "workActivity": {
          "format": "int32",
          "type": "integer"
        },
        "travelTime": {
          "format": "double",
          "type": "number"
        }
      },
      "additionalProperties": false
    },
    "WorkItemQuery": {
      "type": "object",
      "properties": {
        "users": {
          "type": "array",
          "items": {
            "format": "int64",
            "type": "integer"
          }
        },
        "projects": {
          "type": "array",
          "items": {
            "format": "int64",
            "type": "integer"
          }
        },
        "fromDate": {
          "format": "date-time",
          "type": "string"
        },
        "toDate": {
          "format": "date-time",
          "type": "string"
        },
        "crmId": {
          "format": "uuid",
          "type": "string"
        },
        "splitToMultiplePages": {
          "type": "boolean"
        },
        "workActivity": {
          "format": "int32",
          "type": "integer"
        }
      },
      "additionalProperties": false
    }
  },
  "securityDefinitions": {
    "Bearer": {
      "type": "apiKey",
      "name": "Authorization",
      "in": "header",
      "description": "JWT Authorization header using the Bearer scheme. Example: \"Authorization: Bearer {token}\""
    },
    "oauth2": {
      "type": "oauth2",
      "flow": "implicit",
      "authorizationUrl": "https://login.microsoftonline.com/b1f2074d-dc55-43dc-be8e-9311da2845b5/oauth2/v2.0/authorize",
      "scopes": {
        "api://7207fe2d-27eb-4baf-9641-e3d16c5191d4/user_impersonation": "Access application on user behalf"
      }
    },
    "ApiKey": {
      "type": "apiKey",
      "name": "ApiKey",
      "in": "header",
      "description": "Please provide the key in the value field bellow."
    }
  },
  "security": [
    {
      "Bearer": [ ]
    },
    {
      "oauth2": [ ]
    },
    {
      "ApiKey": [ ]
    }
  ]
}

What is the Concept behind Open API ?

When working with REST Service we typically have many REST Service Operations and get the Open API specification that includes all of them. When embedding the Open API spec into the Foundry it is not clear what should we append here?

1. The scheme of the single Operation, that will be used from the model as a function or
2. All of operations within Open API spec.

If 1), then I see it very difficult to make the scheme of the single operation (function) from the Open API scheme that contains all operations of the given REST service.
If 2) , how the Model in the foundry grab the description of the correct function? And how the model will deal with possible 50-100 operations defined in the Open API spec?

My issue above is related to both cases.

Thanks in advance

[lindazqli]

hi @ddobric could you please remove both OAuth2 and Bearer in security definitions and security?

[lindazqli]

you can refer to the doc here: https://learn.microsoft.com/en-us/azure/ai-services/agents/how-to/tools/openapi-spec?tabs=python&pivots=overview

[ddobric]

@lindazqli , thanks for the feedback. I will try it.
However, I see this as a workaround. Manipulating specifications has been a no-go since 2005 (WSDL).
Most APIs we work with in enterprise software development are not built by the same team, department, or even company.

I think the Foundry MUST BE able to understand the swagger as it is.