Bug: Can not use examples element in reponse of post or get method

[nashthaiphung]

Expected Behaviour

After run get_openapi_json_schema() which will auto generate examples in response of 404.

Current Behaviour

In Amazon Bedrock Agents, I want to create multiple example JSON for a HTTP response. But when I add examples element in Post or Get method, it is renamed to "example" (non suffix 's') in JSON Schema

@app.post(
    "/check_data",
    responses={
        404: {
            "description": "Data not found or don't match ",
            "content": {
                "application/json": {
                    "schema": ResErrorBody.model_json_schema(), 
                    "examples": {
                        "PolicyNotFoundCase1": {
                            "summary": "error case 1",
                            "description": "404 case 1.",
                            "value": {
                                  "error-code": "ERROR-404-NOT-FOUND",
                                  "message": "01",
                              }
                        },
                       "PolicyNotFoundCase2": {
                            "summary": "error case 2",
                            "description": "404 case 2.",
                            "value": {
                                  "error-code": "ERROR-404-NOT-FOUND",
                                  "message": "01",
                                  "tool-name": "test"
                              }
                        }
                    }
                }
            }
        },
        422: {
            "description": "Validation Error"
            # ... 
        }
    }
)

Code snippet

@app.post(
    "/check_data",
    responses={
        404: {
            "description": "Data not found or don't match ",
            "content": {
                "application/json": {
                    "schema": ResErrorBody.model_json_schema(), 
                    "examples": {
                        "PolicyNotFoundCase1": {
                            "summary": "error case 1",
                            "description": "404 case 1.",
                            "value": {
                                  "error-code": "ERROR-404-NOT-FOUND",
                                  "message": "01",
                              }
                        },
                       "PolicyNotFoundCase2": {
                            "summary": "error case 2",
                            "description": "404 case 2.",
                            "value": {
                                  "error-code": "ERROR-404-NOT-FOUND",
                                  "message": "01",
                                  "tool-name": "test"
                              }
                        }
                    }
                }
            }
        }
    }
)

Possible Solution

No response

Steps to Reproduce

In Amazon Bedrock Agents, white code to create a OpenAPI-based Actions with POST or GET method

Powertools for AWS Lambda (Python) version

3.20.0

AWS Lambda function runtime

3.9

Packaging format used

Lambda Layers

Debugging logs

[boring-cyborg]

Thanks for opening your first issue here! We'll come back to you as soon as we can.
In the meantime, check out the #python channel on our Powertools for AWS Lambda Discord: Invite link

[hjgraca]

Hi @nashthaiphung we appreciate taking the time to open the issue. We will have a look at it and @leandrodamascena will reply to you as soon as we can repro the issue

[leandrodamascena]

Hi @nashthaiphung, you mentioned that you're using the Bedrock Agents resolver, which is why you see example instead of examples.

The BedrockAgents service only supports the OpenAPI 3.0.x specification, and we need to do some transformation here to convert from OpenAPI 3.1.x to OpenAPI 3.0.0 (Pydantic only supports OpenAPI 3.1.0).

But to be honest, I think we are incorrectly changing the keywork examples to example, because examples is supported in OpenAPI version 3.0.0.

I need to run some tests and I'll update this issue when I have more news.

Thanks for opening this.

[powertools-for-aws-oss-automation]

Warning

This issue is now closed. Please be mindful that future comments are hard for our team to see.
If you need more assistance, please either reopen the issue, or open a new issue referencing this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.