mirror of
https://github.com/status-im/sn-api.git
synced 2026-08-31 09:41:09 +00:00
Filip Pajic
c1f7af9862
* Add postman collection file * Add open api file * Use json format for OpenAPI collection * add swagger ui route * document the guide for API collections
65 lines
1.2 KiB
JSON
65 lines
1.2 KiB
JSON
{
|
|
"info": {
|
|
"_postman_id": "39c3c8c7-b03f-4b00-ad41-ab19878c87d7",
|
|
"name": "Status Network API - sn-api - V1",
|
|
"description": "This is the OpenAPI documentation of the Status Network API. The service is not intended for public use but for Status company and its products.",
|
|
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
|
|
"_exporter_id": "16309767"
|
|
},
|
|
"item": [
|
|
{
|
|
"name": "status",
|
|
"item": [
|
|
{
|
|
"name": "Server Status",
|
|
"request": {
|
|
"method": "GET",
|
|
"header": [],
|
|
"url": {
|
|
"raw": "{{baseUrl}}/api/v1/status",
|
|
"host": [
|
|
"{{baseUrl}}"
|
|
],
|
|
"path": [
|
|
"api",
|
|
"v1",
|
|
"status"
|
|
]
|
|
},
|
|
"description": "Returns 200 and \"Alive check\" message if the server is running properly"
|
|
},
|
|
"response": []
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"event": [
|
|
{
|
|
"listen": "prerequest",
|
|
"script": {
|
|
"type": "text/javascript",
|
|
"packages": {},
|
|
"exec": [
|
|
""
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"listen": "test",
|
|
"script": {
|
|
"type": "text/javascript",
|
|
"packages": {},
|
|
"exec": [
|
|
""
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"variable": [
|
|
{
|
|
"key": "baseUrl",
|
|
"value": "http://localhost:3001",
|
|
"type": "default"
|
|
}
|
|
]
|
|
} |