Pageable endpoints with missing schema information

Aberta

#496 aberta em 21/2/2024 0 comentários 0 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade: 3/5
Tempo estimado: 1-2 dias
Facilidade para iniciantes: 35/100

Tipo de issue: Bug
Clareza: Razoavelmente clara
Status de atividade: Estagnada
Stack de tecnologia: csharp, openapi
Domínio: api

Direção de pesquisa

Comece reproduzindo o endpoint beta do MSGraph fornecido a partir do fluxo de geração do OpenAPI e inspecione como a resposta 2XX vazia e os metadados x-ms-pageable são emitidos. Verifique a discussão relacionada do Kiota para saber o status pageable do endpoint. A tarefa estará concluída quando a descrição gerada tiver as informações de resposta pretendidas ou quando o endpoint não estiver mais marcado como pageable, caso seja confirmado que esse é o comportamento correto.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

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

Linguagem predominante: C#
Estrelas: 240
Forks: 70
Merge médio: 7h 59min
PRs com merge (30d): 13

Guia de contribuição

Abrir o guia de contribuição

Primeiros passos

Leia a issue inteira e depois o guia de contribuição do projeto.
Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
Faça um fork do repositório e trabalhe em uma branch.
Abra um pull request que referencie o número da issue.