web-arena-x / webarena

Code repo for "WebArena: A Realistic Web Environment for Building Autonomous Agents"
https://webarena.dev
Apache License 2.0
672 stars 100 forks source link

Accessing Backing Database for Website Environments #155

Open dayvidwang opened 1 month ago

dayvidwang commented 1 month ago

Hello WebArena team,

I'm interested in building on the WebArena environment and as part of this it would be helpful to be able to inspect the backing database for each website environment by running SQL queries against them. Do you have any guidance on how I could do this for the environments in WebArena?

shuyanzhou commented 1 month ago

Hi,

This can be a site-by-site situation since each site has its own implementations. You can access each Docker container to inspect the database schema and execute SQL queries within them.

For regular data access (e.g., access the issues/repos in GitLab, orders in the shopping site), the recommended way is to use their APIs. For example, here are the APIs for GitLab.

dayvidwang commented 1 month ago

Thanks for the pointers on using the REST API, that's definitely a good resource for the GitLab environment. However I am having trouble finding documentation on the available APIs for the other environments like the OneStopShop, CMS, and Postmill environments. Do you know where I could find those resources?

shuyanzhou commented 1 month ago

Onestopshop and CMS are backed by Adobe Magento 2: https://developer.adobe.com/commerce/webapi/rest/quick-reference/ Postmill requires dealing with the database directly: https://gitlab.com/postmill/Postmill/-/wikis/database-setup @frankxu2004 correct me if I am wrong.