Skip to content

Commit b352feb

Browse files
authored
chore: refresh openapi definition (#1209)
## 🧰 Changes refreshes our openapi doc for changes i have in store in RM-12356. grabbed from [here](https://docs.readme.com/main/openapi/readme-api-v2-beta.json). ## 🧬 QA & Testing do tests still pass?
1 parent 048a6aa commit b352feb

File tree

1 file changed

+32
-3
lines changed

1 file changed

+32
-3
lines changed

src/lib/types/openapiDoc.ts

+32-3
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ const document = {
1515
version: '2.0.0-beta',
1616
title: 'ReadMe API v2 🦉 (BETA)',
1717
// @ts-expect-error custom extension
18-
'x-readme-deploy': '5.309.0',
18+
'x-readme-deploy': '5.319.0',
1919
termsOfService: 'https://readme.com/tos',
2020
contact: {
2121
name: 'API Support',
@@ -3221,8 +3221,8 @@ const document = {
32213221
type: 'object',
32223222
properties: {
32233223
jwt_secret: { type: 'string' },
3224-
login_url: { type: 'string', format: 'uri', nullable: true },
3225-
logout_url: { type: 'string', format: 'uri', nullable: true },
3224+
login_url: { type: 'string', nullable: true },
3225+
logout_url: { type: 'string', nullable: true },
32263226
},
32273227
required: ['jwt_secret', 'login_url', 'logout_url'],
32283228
additionalProperties: false,
@@ -3768,6 +3768,34 @@ const document = {
37683768
connection: {
37693769
type: 'object',
37703770
properties: {
3771+
repository: {
3772+
type: 'object',
3773+
properties: {
3774+
provider_type: {
3775+
type: 'string',
3776+
enum: ['github', 'github_enterprise_server'],
3777+
description: 'The type of provider for the repository.',
3778+
},
3779+
name: {
3780+
type: 'string',
3781+
description: 'The name of the repository (e.g., `repo-with-content`).',
3782+
},
3783+
full_name: {
3784+
type: 'string',
3785+
description:
3786+
'The full name of the repository (e.g., `owner-org/repo-with-content`).',
3787+
},
3788+
url: {
3789+
type: 'string',
3790+
format: 'uri',
3791+
description:
3792+
'The URL of the repository (e.g., `https://github.com/owner-org/repo-with-content`).',
3793+
},
3794+
},
3795+
required: ['provider_type', 'name', 'full_name', 'url'],
3796+
additionalProperties: false,
3797+
nullable: true,
3798+
},
37713799
status: {
37723800
type: 'string',
37733801
enum: ['active', 'inactive', 'none'],
@@ -3776,6 +3804,7 @@ const document = {
37763804
'Indicates if the project has a bi-directional sync connection set up. Below is the meaning of each possible value:\n- `active` - the project has an external repository connected and the connection to the repository is active.\n- `inactive` - the project has an external repository connected but the connection to the repository is inactive.\n- `none` - the project is not connected to an external repository.',
37773805
},
37783806
},
3807+
required: ['repository'],
37793808
additionalProperties: false,
37803809
},
37813810
},

0 commit comments

Comments
 (0)