Skip to content

Please write api breaking changes about adk api_server create_session api in the release note (between 1.3.0 and 1.4.1) #1564

Open
@soundTricker

Description

@soundTricker

** Please make sure you read the contribution guide and file the issues in the right place. **
Contribution guide.

Describe the bug
There is breaking changes about adk api_server's create_session api between 1.3.0 and 1.4.1``1.4.2.

The 1.3.0 create session api's request body schema is blow.

{
    "requestBody": {
        "content": {
            "application/json": {
                "schema": {
                    "anyOf": [
                        {
                            "type": "object",
                            "additionalProperties": true
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "title": "State"
                }
            }
        }
    }
}

it can post the session state in request body directly.

But after version 1.4.1, the request body schema is changed to below.

{
    "requestBody": {
        "content": {
            "application/json": {
                "schema": {
                    "properties": {
                        "state": {
                            "anyOf": [
                                {
                                    "additionalProperties": true,
                                    "type": "object"
                                },
                                {
                                    "type": "null"
                                }
                            ],
                            "title": "State"
                        },
                        "events": {
                            "anyOf": [
                                {
                                    "items": {
                                        "$ref": "#/components/schemas/Event-Input"
                                    },
                                    "type": "array"
                                },
                                {
                                    "type": "null"
                                }
                            ],
                            "title": "Events"
                        }
                    },
                    "type": "object",
                    "title": "Body_create_session_apps__app_name__users__user_id__sessions_post"
                }
            }
        }
    }
}

it needs the state property like {"state": {}} to set the session state.

To Reproduce
Install adk-python version 1.4.1.

Expected behavior

Please write the breaking changes in release note to save resolving the issue on updating the versions.

Metadata

Metadata

Assignees

Labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions