Pageable endpoints with missing schema information

Abierto

#496 abierto el 21/2/2024 0 comentarios 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: 35/100

Tipo de issue: Error
Claridad: Bastante claro
Estado de actividad: Estancado
Stack tecnológico: csharp, openapi
Área: api

Línea de trabajo

Comienza reproduciendo el endpoint beta de MSGraph proporcionado a partir del flujo de generación de OpenAPI e inspecciona cómo se emiten su respuesta 2XX vacía y los metadatos x-ms-pageable. Comprueba en la discusión relacionada de Kiota el estado pageable del endpoint. Se considera terminado cuando la descripción generada contiene la información de respuesta prevista, o cuando el endpoint ya no está marcado como pageable si se confirma que ese es el comportamiento correcto.

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

Descripción

type:bug

The current OpenAPI file for the beta MSGraph endpoint results in descriptions with empty response information for some endpoints. An example is shown below.

Assemblies affected

Which assemblies and versions are known to be affected? 1.0.9.0

Expected result

For endpoints that have paging information (x-ms-pageable), the response shape should be known for kiota to generate paging code. @baywet also says that this endpoint isn't actually pageable. See https://github.com/microsoft/kiota/issues/4207#issuecomment-1956755281

Actual result

Failing snippet


openapi: 3.0.1
# ...
paths:
  '/identity/authenticationEventsFlows/{authenticationEventsFlow-id}/graph.externalUsersSelfServiceSignUpEventsFlow/onAttributeCollection/graph.onAttributeCollectionExternalUsersSelfServiceSignUp':
    description: Casts the previous resource to onAttributeCollectionExternalUsersSelfServiceSignUp.
    get:
      tags:
        - identity.authenticationEventsFlow
      summary: Get the items of type microsoft.graph.onAttributeCollectionExternalUsersSelfServiceSignUp in the microsoft.graph.onAttributeCollectionHandler collection
      operationId: identity.authenticationEventsFlows.GetOnAttributeCollection.AsOnAttributeCollectionExternalUsersSelfServiceSignUp
      responses:
        2XX: { }
      x-ms-pageable:
        nextLinkName: '@odata.nextLink'
        operationName: listMore
    parameters:
      - name: authenticationEventsFlow-id
        in: path
        description: The unique identifier of authenticationEventsFlow
        required: true
        schema:
          type: string
        x-ms-docs-key-type: authenticationEventsFlow