diff --git a/README.md b/README.md index c62e9cc5130a5c6db522d9cd78bc20bd00ba60fd..a68702266abe93f363a8b328ebc98b2bdab51d98 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,10 @@ Usage To use the now running ICG docker container we can call the available REST API. -The API is available at http://localhost:5000/docs. You can try here the endpoint behavior (see input_file_example/nginx/parameters.json as an example body). +The API is available at http://localhost:5000/docs. You can try here the endpoint behavior: + +- POST /infrastructure/files generates iac compress folder from json intermediate representation (see input_file_example/nginx/parameters.json as an example body). +- POST /iac/files generates iac compress folder from doml model (ex. nginx-openstack_v2.domlx) Otherwise, send a POST request at this endpoint with the indicated json body (see input_file_example/nginx/parameters.json as an example body) it will respond with a .tar.gz file containing all the required IaC files: