OAS 3.1 deprecated example field in the Schema Object.

[ashsummer]

Is there an existing issue that is already proposing this?

• I have searched the existing issues

Is your feature request related to a problem? Please describe it

Starting from OAS 3.1, the example field inside the Schema Object has been deprecated. doc

Since #3031, the example field for ApiProperty has been moved inside the Schema Object as shown below.

          {
            "name": "isFault",
            "required": false,
            "in": "query",
            "schema": {
              "example": "true",
              "type": "boolean"
            }
          },

Describe the solution you'd like

I think that we need to make the example field go under the property, just like before.

          {
            "name": "isFault",
            "required": false,
            "in": "query",
            "example": "true",
            "schema": {
              "type": "boolean"
            }
          },

Teachability, documentation, adoption, migration strategy

No response

What is the motivation / use case for changing the behavior?

I believe so compatibility will be maintained across OAS 3.0, OAS 3.1, and later versions.

[chloe-codes1]

I completely agree with this issue and would love to see it addressed. Maintaining compatibility across OAS 3.0, OAS 3.1, and future versions is crucial for ensuring a smooth transition and avoiding unnecessary breaking changes. Moving the example field back under the property, as it was before, seems like the best solution.

Looking forward to further discussions and potential updates on this. Thanks for bringing this up!