basic

Create/update a simulation environment

put/simulation-environments/{env_name}

Request

Base URL
/api/v0 (relative, and the document was published on a file host, not at the API’s origin)
Auth
HTTP basic
TypeScript
https://skmtc.dev/amz-racing/apis/rosbag-bazaar-api/docs/simulation-environments/:env_name/put.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

env_namestring required

Name of the simulation environment

Query parameters

block_on_existingboolean

Only create a new one, block if one already exists

Request body

detail_typestring required

namestring required

module_namestring required

rosbag_storestring

configobject required

Configuration of the simulation environment.

example_configstring required

Example simulation configuration shown in the simulation overview

Example request

{
  "rosbag_store": "s3-sim-bags",
  "detail_type": "SimulationEnvironmentSummary",
  "name": "2018-repo-simulation",
  "module_name": "rbb_tools.simenvs.scse"
}

Response

Returns the simulation environment