Skip to content

Commit 1deacfb

Browse files
committed
fix(openapi): stop describing CreateProjectRequest.database next to a $ref (#1344)
Synced from sferarc/pgbeam@08071bd
1 parent 031b219 commit 1deacfb

4 files changed

Lines changed: 7 additions & 8 deletions

File tree

openapi.json

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8401,7 +8401,7 @@
84018401
},
84028402
"CreateProjectRequest": {
84038403
"type": "object",
8404-
"description": "Request body for creating a project and its primary database.",
8404+
"description": "Request body for creating a project and its primary database, which are created atomically.",
84058405
"required": [
84068406
"name",
84078407
"org_id",
@@ -8458,8 +8458,7 @@
84588458
"default": false
84598459
},
84608460
"database": {
8461-
"$ref": "#/components/schemas/CreateDatabaseRequest",
8462-
"description": "Primary database. Created atomically with the project."
8461+
"$ref": "#/components/schemas/CreateDatabaseRequest"
84638462
}
84648463
}
84658464
},

openapi.yaml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6031,7 +6031,7 @@ components:
60316031
example: eu
60326032
CreateProjectRequest:
60336033
type: object
6034-
description: Request body for creating a project and its primary database.
6034+
description: Request body for creating a project and its primary database, which are created atomically.
60356035
required:
60366036
- name
60376037
- org_id
@@ -6081,7 +6081,6 @@ components:
60816081
default: false
60826082
database:
60836083
$ref: '#/components/schemas/CreateDatabaseRequest'
6084-
description: Primary database. Created atomically with the project.
60856084
CreateProjectResponse:
60866085
type: object
60876086
description: Response returned after creating a project and its primary database.

spec/components/schemas/CreateProjectRequest.yaml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
type: object
2-
description: Request body for creating a project and its primary database.
2+
description: >-
3+
Request body for creating a project and its primary database, which are
4+
created atomically.
35
required:
46
- name
57
- org_id
@@ -49,4 +51,3 @@ properties:
4951
default: false
5052
database:
5153
$ref: ./CreateDatabaseRequest.yaml
52-
description: Primary database. Created atomically with the project.

src/spec.gen.ts

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)