Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

[Bug]: Kiota generation is weird because of the OpenAPI scheme

Abierto
#3,632 1 comentario 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
3/5
Tiempo estimado
1-2 días
Aptitud para principiantes
48/100
Tipo de issue
Error
Claridad
Bastante claro
Estado de actividad
Tranquilo
Stack tecnológico
csharp, openapi

Línea de trabajo

Reproduce el problema con el esquema de respuesta OpenAPI proporcionado y Kiota 1.6.77; después, rastrea los tipos de respuesta C# generados y el código fuente que construye esta operación OpenAPI. Compara las sobrecargas generadas con el esquema de colección explícito propuesto; se considera terminado cuando la respuesta está representada por el modelo tipado previsto y ya no incluye el método duplicado obsoleto.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

bug cri triage
What happened?

For a simple orders table, I get this path in the OpenAPI document

"/Order": {
    "get": {
      "tags": [
        "Order"
      ],
      "description": "Returns entities.",
      "parameters": [
        {
          "name": "X-MS-API-ROLE",
          "in": "header",
          "schema": {
            "type": "string"
          }
        },
        {
          "name": "Authorization",
          "in": "header",
          "schema": {
            "type": "string"
          }
        },
        {
          "name": "$select",
          "in": "query",
          "description": "A comma separated list of fields to return in the response.",
          "schema": {
            "type": "string"
          }
        },
        {
          "name": "$filter",
          "in": "query",
          "description": "An OData expression (an expression that returns a boolean value) using the entity's fields to retrieve a subset of the results.",
          "schema": {
            "type": "string"
          }
        },
        {
          "name": "$orderby",
          "in": "query",
          "description": "Uses a comma-separated list of expressions to sort response items. Add 'desc' for descending order, otherwise it's ascending by default.",
          "schema": {
            "type": "string"
          }
        },
        {
          "name": "$first",
          "in": "query",
          "description": "An integer value that specifies the number of items to return. Default is 100.",
          "schema": {
            "type": "integer"
          }
        },
        {
          "name": "$after",
          "in": "query",
          "description": "An opaque string that specifies the cursor position after which results should be returned.",
          "schema": {
            "type": "string"
          }
        }
      ],
      "responses": {
        "400": {
          "description": "BadRequest"
        },
        "401": {
          "description": "Unauthorized"
        },
        "403": {
          "description": "Forbidden"
        },
        "404": {
          "description": "NotFound"
        },
        "200": {
          "description": "OK",
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "value": {
                    "type": "array",
                    "items": {
                      "$ref": "#/components/schemas/Order"
                    }
                  },
                  "nextLink": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "post": {
      "tags": [
        "Order"
      ],
      "description": "Create entity.",
      "parameters": [
        {
          "name": "X-MS-API-ROLE",
          "in": "header",
          "schema": {
            "type": "string"
          }
        },
        {
          "name": "Authorization",
          "in": "header",
          "schema": {
            "type": "string"
          }
        }
      ],
      "requestBody": {
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/Order_NoAutoPK"
            }
          }
        },
        "required": true
      },
      "responses": {
        "400": {
          "description": "BadRequest"
        },
        "401": {
          "description": "Unauthorized"
        },
        "403": {
          "description": "Forbidden"
        },
        "404": {
          "description": "NotFound"
        },
        "201": {
          "description": "Created",
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "value": {
                    "type": "array",
                    "items": {
                      "$ref": "#/components/schemas/Order"
                    }
                  }
                }
              }
            }
          }
        },
        "409": {
          "description": "Conflict"
        }
      }
    }
  }

Then I run Kiota in the document and I get the following

[Obsolete("This method is obsolete. Use GetAsOrderGetResponseAsync instead.")]
public async Task<global::TestSimple.Client.Order.OrderResponse?> GetAsync(Action<RequestConfiguration<global::TestSimple.Client.Order.OrderRequestBuilder.OrderRequestBuilderGetQueryParameters>>? requestConfiguration = default, CancellationToken cancellationToken = default) { /*stuff*/}

public async Task<global::TestSimple.Client.Order.OrderGetResponse?> GetAsOrderGetResponseAsync(Action<RequestConfiguration<global::TestSimple.Client.Order.OrderRequestBuilder.OrderRequestBuilderGetQueryParameters>>? requestConfiguration = default, CancellationToken cancellationToken = default) { /* stuff */}

From what I understood, this is a problem on the generated OpenAPI Specification that is not enough typed (the object should be an explicit object like "OrderCollection"

"200": {
  "description": "OK",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "value": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Order"
            }
          },
          "nextLink": {
            "type": "string"
          }
        }
      }
    }
  }
}
Version

1.6.77

What database are you using?

Azure SQL

What hosting model are you using?

Custom Docker host

Which API approach are you accessing DAB through?

REST

Relevant log output

Code of Conduct
  • I agree to follow this project's Code of Conduct
Lenguaje dominante
C#
Estrellas
1.5k
Forks
372
Merge medio
9 d 1 h
PR fusionados (30 d)
13

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de Azure/data-api-builder

Todos los issues de Azure/data-api-builder

Issues similares

Más issues de C#

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.