Skip to content

Commit 68bb15b

Browse files
committed
docs: update OpenAPI specs to v4.1.0 and fix README links
- Update dblab_openapi.yaml version from 4.0.0 to 4.1.0 - Add /metrics endpoint to OpenAPI spec - Update dblab_server_swagger.yaml version from 3.5.0 to 4.1.0 - Fix external docs URL to point to postgres.ai/docs - Update demo server description - Fix README branching howto link (was TBD placeholder) https://claude.ai/code/session_011sPDgBjzL2N2X6jiYyoTjQ
1 parent 7631aab commit 68bb15b

File tree

3 files changed

+24
-8
lines changed

3 files changed

+24
-8
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -172,9 +172,9 @@ For proposals, bug reports, and participation in development, see our [Contribut
172172
- [How to install and initialize Database Lab CLI](https://postgres.ai/docs/how-to-guides/cli/cli-install-init)
173173
- [How to manage DBLab](https://postgres.ai/docs/how-to-guides/administration)
174174
- [How to work with clones](https://postgres.ai/docs/how-to-guides/cloning)
175-
- [How to work with branches](XXXXXXX) – TBD
176-
- [How to integrate DBLab with GitHub Actions](XXXXXXX) – TBD
177-
- [How to integrate DBLab with GitLab CI/CD](XXXXXXX) – TBD
175+
- [How to work with branches](https://postgres.ai/docs/dblab-howtos/branching)
176+
- How to integrate DBLab with GitHub Actions – TBD
177+
- How to integrate DBLab with GitLab CI/CD – TBD
178178

179179
You can find more in the ["How-to guides" section](https://postgres.ai/docs/how-to-guides) of the documentation.
180180

engine/api/swagger-spec/dblab_openapi.yaml

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,14 +16,14 @@ info:
1616
license:
1717
name: Apache 2.0
1818
url: https://github.com/postgres-ai/database-lab-engine/blob/dle-4-0/LICENSE
19-
version: 4.0.0
19+
version: 4.1.0
2020
externalDocs:
2121
description: DBLab Docs
22-
url: https://gitlab.com/postgres-ai/docs/tree/master/docs/database-lab
22+
url: https://postgres.ai/docs/database-lab
2323

2424
servers:
2525
- url: "https://demo.dblab.dev/api"
26-
description: "DBLab 4.0 demo server (with DB branching support); token: 'demo-token'"
26+
description: "DBLab demo server (with DB branching support); token: 'demo-token'"
2727
x-examples:
2828
Verification-Token: "demo-token"
2929
- url: "https://demo.aws.postgres.ai:446/api"
@@ -1255,6 +1255,22 @@ paths:
12551255
example:
12561256
code: "UNAUTHORIZED"
12571257
message: "Check your verification token."
1258+
/metrics:
1259+
get:
1260+
tags:
1261+
- Instance
1262+
summary: Prometheus metrics
1263+
description: "Returns Prometheus-formatted metrics for monitoring the DBLab instance.
1264+
Includes metrics for instance status, disk usage, clones, snapshots, branches,
1265+
sync status, and more. This endpoint does not require the 'Verification-Token' header."
1266+
operationId: metrics
1267+
responses:
1268+
200:
1269+
description: Prometheus metrics in text format
1270+
content:
1271+
text/plain:
1272+
schema:
1273+
type: string
12581274
/observation/start:
12591275
post:
12601276
tags:

engine/api/swagger-spec/dblab_server_swagger.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,10 @@ info:
1515
license:
1616
name: AGPL v3 / Database Lab License
1717
url: https://github.com/postgres-ai/database-lab-engine/blob/master/LICENSE
18-
version: 3.5.0
18+
version: 4.1.0
1919
externalDocs:
2020
description: DBLab Docs
21-
url: https://gitlab.com/postgres-ai/docs/tree/master/docs/database-lab
21+
url: https://postgres.ai/docs/database-lab
2222

2323
servers:
2424
- url: "https://demo.dblab.dev/api"

0 commit comments

Comments
 (0)