Pageable endpoints with missing schema information
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 35/100
Research direction
Start by reproducing the supplied beta MSGraph endpoint from the OpenAPI generation flow and inspect how its empty 2XX response and x-ms-pageable metadata are emitted. Check the related Kiota discussion for the endpoint's pageable status. Done means the generated description has the intended response information, or the endpoint is no longer marked pageable if that is confirmed as the correct behavior.
Written by the indexing model from the issue text.
Description
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
- Dominant language
- C#
- Stars
- 240
- Forks
- 70
- Avg merge
- 7h 59m
- Merged PRs (30d)
- 13
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from microsoft/OpenAPI.NET.OData
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
microsoft/OpenAPI.NET.OData#661 ·
-
Difficulty 3/5 1-2 days Newbie friendliness 58/100
microsoft/OpenAPI.NET.OData#852 ·
-
Difficulty 4/5 3-5 days Newbie friendliness 45/100
microsoft/OpenAPI.NET.OData#833 ·
-
status:needs-more-information
Difficulty 4/5 3-5 days Newbie friendliness 42/100
microsoft/OpenAPI.NET.OData#723 · 1 comment · 1 reaction ·
-
Difficulty 3/5 1-2 days Newbie friendliness 45/100
microsoft/OpenAPI.NET.OData#720 ·
All issues in microsoft/OpenAPI.NET.OData
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
nightscout/nocturne#1379 ·
-
priority-0
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
Difficulty 1/5 Under an hour Newbie friendliness 78/100
StackExchange/StackExchange.Redis#3249 ·
-
[Feat] 조합 영역 구분선 개선 Open
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
documentation
Difficulty 2/5 1-3 hours Newbie friendliness 72/100