Repository navigation
x-ms-dynamic-values schema is dropped when moving from parameters to request body loading openapi for excel connector #706
Description
When loading this definition
foo.txt
This path /drives/{drive}/files/{file}/tables/{table}/items/{id}
The Patch operationId PatchItem somehow loses the reference to the x-ms-dynamic-schema attribute.
The V2 json has Operation.Parameters entry like this:
{
"name": "item",
"in": "body",
"description": "Provide the item properties.",
"required": true,
"schema": {
"$ref": "#/definitions/Item"
},
"x-ms-summary": "Provide the item properties"
},With the /definitions/Item looking like this:
"Item": {
"description": "Table item entity",
"type": "object",
"properties": {
"dynamicProperties": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/Object"
}
}
},
"additionalProperties": {
"$ref": "#/definitions/Object"
},
"x-ms-dynamic-schema": {
"operationId": "GetTable",
...
}
},But the deserialized OpenApiOperation doesn't have any links or references to the x-ms-dynamic-schema data.
- The Parameters doesn't have the "item" property defined (presumbly because it is moved to the RequestBody
- The RequestBody has a definition with x-bodyName "item" but has dropped the "x-ms-dynamic-schema" metadata
- The RequestBody.Content is empty
Reacted by Ivan Labrador
Activity
tomlm commentedon Jan 29, 2022
Another example:
foo2.txt
OperationIds:
darrelmiller commentedon Jan 29, 2022
From what I can see, the schema of the request body is getting lost. It seems to be lost on writing of both v3 and V2, so the issue is likely in reading.
darrelmiller commentedon Jan 29, 2022
The OpenAPIReferenceResolver visitorhttps://github.com/microsoft/OpenAPI.NET/blob/vnext/src/Microsoft.OpenApi/Services/OpenApiReferenceResolver.csis not visiting Schemas in request bodies so the$refis not getting resolved. On the surface this looks like an easy fix.Well, that's not it. Back to the drawing board.
darrelmiller commentedon Jan 30, 2022
Tom Laird-McConnell (@tomlm) That one was a little harder to find than I expected. Here's the snippet of OpenAPI that is relevant.
This operation definition has an empty consumes array which infers the operation doesn't accept any request bodies. Obviously the parameter with "in" body contradicts that. We could use the presence of the body parameter to override, but we would really have to assume the default content type of
application/octet-stream. You can correct the source document by adding theapplication/jsonentry to the consumes and then the content property will be set and the reference to the Item schema will be included in the model.Just a heads up that if you are interacting with models read by the reader, we are going to have some breaking changes coming in our next major version. OpenAPIv3.1 allows some properties to live alongside $ref properties and this is causing us to have to redesign how we resolve references.
darrelmiller commentedon Jan 30, 2022
Perhaps we should report an error if consumes is empty but there is a body parameter. This is very much a v2 problem because structurally you can't make this error in v3.
darrelmiller commentedon Apr 29, 2025
This was fixed probably about a year ago.