Skip to content

Commit

Permalink
Merge remote-tracking branch 'origin/main'
Browse files Browse the repository at this point in the history
  • Loading branch information
CADawg committed Mar 4, 2024
2 parents e4cbe78 + e490606 commit ad579a5
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,9 @@ This script also builds the UI before a release. Alternatively, you can download
To run the project, execute the executable built by the build script:

```bash
./ConfigDN
./ConfigDN serve
```

ConfigDN will then be available at:
- http://localhost:8090/ - UI
- http://localhost:8090/_/ - Admin UI (Make sure you visit this before making it public as the first person to visit it will be made an admin)
- http://localhost:8090/_/ - Admin UI (Make sure you visit this before making it public as the first person to visit it will be made an admin)
35 changes: 35 additions & 0 deletions docs/api_docs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
### Please note that until ConfigDN 1.0 releases, breaking API changes might occur in small version changes. We will try to keep these docs up to date

```
BASE_API = https://cdn.configdn.com/public_api/v1/
Authorization = ABCXYZ
```

To get your auth token, you can vist the web UI, and the API key will be displayed at the bottom.



#### Get Config

GET: `$BASE_API + "/get_config/" `

Headers: `Authorization : $Authorization `


Response:

```json

"s": true,
"d": {
"flag1": {
"v": "abcxyz"
},
"flag2": {
"v": ["abcxyz"]
}

}
```

The response JSON's `d` value holds all the data. `flag1` is an example flag, and the value of it is held within `v`. `flag2` in this example has an array for it's value.

0 comments on commit ad579a5

Please sign in to comment.