diff --git a/README.md b/README.md index e330dae..c85d596 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,14 @@ -# BlueConic OpenAPI -The OpenAPI definitions for the BlueConic v2 REST API. - -# Using latest published OpenAPI specification -* Open https://rest.apidoc.blueconic.com - -# Using actual OpenAPI specification of a given BlueConic tenant -* Open https://rest.apidoc.blueconic.com/?hostname=mytenantname.blueconic.net -* Open https://rest.apidoc.blueconic.com/?hostname=localhost - -# Running it on a local machine -* Run `npx http-server` -* Open http://localhost:8080?hostname=localhost +# BlueConic OpenAPI Specification +This repository contains the OpenAPI specification for the BlueConic REST API v2. + + # Using the latest published OpenAPI specification + * Open https://rest.apidoc.blueconic.com + + # Using the OpenAPI specification of a given BlueConic tenant + * Open https://rest.apidoc.blueconic.com/?hostname=mytenantname.blueconic.net + + # Running the OpenAPI specification on a local machine + * Clone the repository and `cd` to the repository location + * Run `npx http-server` + * Open http://localhost:8080?hostname=localhost + * CORS configuration of BlueConic needs to be adjusted to the the localhost origin