Here is the detailed plan to support multiple custom headers in mcpgateway:

UI Changes (mcpgateway/templates/admin.html):
- Current: The "Add New Gateway" form has single input fields for auth_header_key and auth_header_value under the "Custom Headers" authentication type.
- Change: Replace these two inputs with a dynamic list of header key-value pairs. Add "Add Header" and "Remove Header" buttons to allow users to add multiple headers. On form submission, serialize these headers as an array of objects (e.g., [{"key": "...", "value": "..."}]).
- Additional: Update JavaScript handling form submission (in mcpgateway/static/admin.js) to support this new structure.
API Changes (mcpgateway/admin.py):
- Current: The admin_add_gateway and admin_edit_gateway endpoints accept auth_header_key and auth_header_value as single string form fields.
- Change: Modify these endpoints to accept a JSON string or list of header objects for custom headers instead of single key-value pairs. Parse this JSON into a list of headers.
- Example: Replace auth_header_key and auth_header_value with a single auth_headers JSON field representing multiple headers.
Backend Changes (mcpgateway/services/gateway_service.py):
- Current: The GatewayCreate and GatewayUpdate schemas and the register_gateway and update_gateway methods handle auth_header_key and auth_header_value as single values.
- Change: Update the gateway schemas to replace auth_header_key and auth_header_value with a single field auth_headers that is a list of key-value pairs or a dictionary.
- Modify register_gateway and update_gateway methods to handle multiple headers, storing them in auth_value or a new field accordingly.
- Update the _initialize_gateway method and any other relevant logic to apply all custom headers when connecting to the gateway.
Database Changes:
- Current: The database stores auth_header_key and auth_header_value as separate columns or fields.
- Change: Migrate to storing multiple headers, either by:
  - Adding a JSON column auth_headers to store an array or dictionary of headers, or
  - Creating a new related table for headers linked to gateways.
- Write migration scripts to convert existing single header data into the new format.
Testing:
- Update and add tests in tests/playwright/test_admin_ui.py, tests/playwright/test_api_endpoints.py, and tests/playwright/test_api_integration.py to cover multiple headers in UI, API, and backend.
- Test edge cases such as empty headers, duplicate keys, and invalid inputs.
Documentation:
- Update relevant documentation files to describe the new multiple headers feature.

[BUG][UI]: Unable to add multiple headers when adding gateway #526

Description

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions