Skip to content

Commit ab0d164

Browse files
ceviixxceviixx
committed
New endpoints added
1 parent 37e9ecc commit ab0d164

File tree

6 files changed

+763
-57
lines changed

6 files changed

+763
-57
lines changed

‎.gitignore‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
11
dist
22
node_modules
33
package-lock.json
4-
.DS_Store
4+
.DS_Store
5+
arazzo.test.yaml
6+
arazzo.test.gen.yaml
7+
test.result.json

‎README.md‎

Lines changed: 19 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -8,21 +8,28 @@ This repo maintains an OpenAPI spec that tracks changes in Umami and publishes d
88
\
99
[![Umami version](https://img.shields.io/badge/Umami-3.0.0-6f42c1?style=flat-square)](https://umami.is/)
1010
![Pages deployed](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fapi.github.com%2Frepos%2Fceviixx%2Fumami-api-docs%2Factions%2Fworkflows%2Fdeploy-docs.yml%2Fruns%3Fper_page%3D1&query=$.workflow_runs[0].updated_at&label=Pages%20deployed&color=6f42c1&style=flat-square&cacheSeconds=300)
11-
´
1211

13-
---
1412

15-
### Endpoints not complete
1613

17-
- POST [/auth/login:](openapi/openapi.yaml#L47):
18-
- response
19-
- example
20-
- schema
14+
### Script usage
15+
- `npm run start`
16+
Start live server
17+
- `npm run build`
18+
Build bundle.yaml in dist
19+
- `npm run build:docs`
20+
Create the html page based on template
21+
- `npm run test`
22+
Run lint test and check openapi
23+
- `npm run arazzo:build`
24+
Generate arazzo test file
25+
- `npm run arazzo:test -- --input api-key={YOUR_API_KEY}`
26+
Run the arazzo respect tests with your creadentials
2127

22-
- POST [/auth/verify:](openapi/openapi.yaml#L71):
23-
- response
24-
- example
25-
- schema
28+
29+
30+
---
31+
32+
### Endpoints not complete
2633

2734
- GET [/websites/{id}/session-data/properties:](openapi/openapi.yaml#L758):
2835
- response
@@ -77,27 +84,17 @@ This repo maintains an OpenAPI spec that tracks changes in Umami and publishes d
7784
- POST [/links/{id}:](openapi/openapi.yaml#L2038):
7885
- response
7986
- example
87+
- schema
8088

8189

8290
---
8391

8492

8593
### Only endpoint setup but config missing
8694

87-
- POST [/invite:](openapi/openapi.yaml#L2709):
8895
- POST [/teams/{id}/users/{id}:](openapi/openapi.yaml#L2671):
8996
- DELETE [/teams/{id}/users/{id}:](openapi/openapi.yaml#L2671):
9097
- POST [/teams/join:](openapi/openapi.yaml#L2658):
91-
- DELETE [/teams/{id}:](openapi/openapi.yaml#L2602):
92-
- POST [/teams/{id}:](openapi/openapi.yaml#L2602):
93-
- GET [/teams/{id}:](openapi/openapi.yaml#L2602):
94-
- POST [/teams:](openapi/openapi.yaml#L2578):
95-
- GET [/teams:](openapi/openapi.yaml#L2578):
96-
- POST [/websites/{id}/reset:](openapi/openapi.yaml#L2558):
97-
- DELETE [/websites/{id}:](openapi/openapi.yaml#L2502):
98-
- POST [/websites/{id}:](openapi/openapi.yaml#L2502):
99-
- GET [/websites/{id}:](openapi/openapi.yaml#L2502):
100-
- POST [/websites:](openapi/openapi.yaml#L2394):
10198
- DELETE [/websites/{id}/segments/:cohort_id:](openapi/openapi.yaml#L2338):
10299
- POST [/websites/{id}/segments/:cohort_id:](openapi/openapi.yaml#L2338):
103100
- GET [/websites/{id}/segments/:cohort_id:](openapi/openapi.yaml#L2338):

‎docs/index.html‎

Lines changed: 26 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,32 @@
11
<!DOCTYPE html>
22
<html>
3-
<head>
4-
<meta charset="utf-8">
5-
<title>umami API docs</title>
6-
<!-- needed for adaptive design -->
7-
<meta name="viewport" content="width=device-width, initial-scale=1">
8-
<link rel="icon" type="image/png" href="favicon.png">
93

10-
<!--
4+
<head>
5+
<meta charset="utf-8">
6+
<title>umami API docs</title>
7+
<!-- needed for adaptive design -->
8+
<meta name="viewport" content="width=device-width, initial-scale=1">
9+
<link rel="icon" type="image/png" href="favicon.png">
10+
11+
<!--
1112
ReDoc uses font options from the parent element
1213
So override default browser styles
1314
-->
14-
<style>
15-
body {
16-
margin: 0;
17-
padding: 0;
18-
}
19-
</style>
20-
{{{redocHead}}}
21-
</head>
22-
<body>
23-
{{{redocHTML}}}
24-
</body>
25-
</html>
15+
<style>
16+
body {
17+
margin: 0;
18+
padding: 0;
19+
}
20+
21+
[data-role="search:results"] {
22+
background: #ffffff;
23+
}
24+
</style>
25+
{{{redocHead}}}
26+
</head>
27+
28+
<body>
29+
{{{redocHTML}}}
30+
</body>
31+
32+
</html>

0 commit comments

Comments
 (0)