-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
f9a4174
commit 297138f
Showing
1 changed file
with
14 additions
and
13 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 |