Pageable endpoints with missing schema information

Ouverte

#496 ouverte le 21/2/2024 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Évaluation

Difficulté: 3/5
Temps estimé: 1-2 jours
Accessibilité débutants: 35/100

Type d'issue: Bug
Clarté: Plutôt claire
Activité: À l'abandon
Stack technique: csharp, openapi
Domaine: api

Piste de recherche

Commencez par reproduire le endpoint beta MSGraph fourni à partir du flux de génération OpenAPI et examinez comment sa réponse 2XX vide et ses métadonnées x-ms-pageable sont émises. Consultez la discussion Kiota associée pour vérifier le statut pageable du endpoint. Le travail est terminé lorsque la description générée contient les informations de réponse attendues, ou lorsque l’endpoint n’est plus marqué comme pageable s’il est confirmé qu’il s’agit du comportement correct.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

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

Additional detail

Langage dominant: C#
Étoiles: 240
Forks: 70
Merge moyen: 7 h 59 min
PR mergées (30 j): 13

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

Lisez l'issue en entier, puis le guide de contribution du projet.
Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
Forkez le dépôt et travaillez sur une branche.
Ouvrez une pull request qui référence le numéro de l'issue.