microsoft / microsoft/OpenAPI.NET.OData
Pageable endpoints with missing schema information
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- C#
- Sterne
- 240
- Forks
- 70
- Ø Merge
- 7 Std. 59 Min.
- Gemergte PRs (30 T.)
- 13
Beschreibung
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
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginnen Sie damit, den bereitgestellten beta-MSGraph-Endpunkt aus dem OpenAPI-Generierungsablauf zu reproduzieren, und prüfen Sie, wie dessen leere 2XX-Antwort und x-ms-pageable-Metadaten ausgegeben werden. Prüfen Sie die zugehörige Kiota-Diskussion auf den pageable-Status des Endpunkts. Als erledigt gilt die Aufgabe, wenn die generierte Beschreibung die vorgesehenen Antwortinformationen enthält oder der Endpunkt nicht mehr als pageable markiert ist, sofern bestätigt wird, dass dies das korrekte Verhalten ist.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- csharp, openapi
- Bereich
- api
- Issue-Typ
- Bug
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 1-2 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 35/100