diff --git a/src/lib/openapi/spec/health-overview-schema.ts b/src/lib/openapi/spec/health-overview-schema.ts index ad1605c109..f0bbaebea2 100644 --- a/src/lib/openapi/spec/health-overview-schema.ts +++ b/src/lib/openapi/spec/health-overview-schema.ts @@ -36,9 +36,8 @@ export const healthOverviewSchema = { type: 'string', enum: ['open', 'protected'], example: 'open', - nullable: true, description: - 'A mode of the project affecting what actions are possible in this project. During a rollout of project modes this feature can be optional or `null`', + "The project's [collaboration mode](https://docs.getunleash.io/reference/project-collaboration-mode). Determines whether non-project members can submit change requests or not.", }, members: { type: 'number', diff --git a/src/lib/openapi/spec/project-overview-schema.ts b/src/lib/openapi/spec/project-overview-schema.ts index 118725d586..fc0b57f86e 100644 --- a/src/lib/openapi/spec/project-overview-schema.ts +++ b/src/lib/openapi/spec/project-overview-schema.ts @@ -48,7 +48,7 @@ export const projectOverviewSchema = { enum: ['open', 'protected'], example: 'open', description: - 'A mode of the project affecting what actions are possible in this project', + "The project's [collaboration mode](https://docs.getunleash.io/reference/project-collaboration-mode). Determines whether non-project members can submit change requests or not.", }, members: { type: 'number', diff --git a/src/lib/openapi/spec/project-schema.ts b/src/lib/openapi/spec/project-schema.ts index 836f1be211..12a667287d 100644 --- a/src/lib/openapi/spec/project-schema.ts +++ b/src/lib/openapi/spec/project-schema.ts @@ -60,7 +60,7 @@ export const projectSchema = { enum: ['open', 'protected'], example: 'open', description: - 'A mode of the project affecting what actions are possible in this project', + "The project's [collaboration mode](https://docs.getunleash.io/reference/project-collaboration-mode). Determines whether non-project members can submit change requests or not.", }, defaultStickiness: { type: 'string', diff --git a/src/test/e2e/api/openapi/__snapshots__/openapi.e2e.test.ts.snap b/src/test/e2e/api/openapi/__snapshots__/openapi.e2e.test.ts.snap index 0cacad95ed..b7c204b360 100644 --- a/src/test/e2e/api/openapi/__snapshots__/openapi.e2e.test.ts.snap +++ b/src/test/e2e/api/openapi/__snapshots__/openapi.e2e.test.ts.snap @@ -1878,13 +1878,12 @@ exports[`should serve the OpenAPI spec 1`] = ` "type": "number", }, "mode": { - "description": "A mode of the project affecting what actions are possible in this project. During a rollout of project modes this feature can be optional or \`null\`", + "description": "The project's [collaboration mode](https://docs.getunleash.io/reference/project-collaboration-mode). Determines whether non-project members can submit change requests or not.", "enum": [ "open", "protected", ], "example": "open", - "nullable": true, "type": "string", }, "name": { @@ -1952,13 +1951,12 @@ exports[`should serve the OpenAPI spec 1`] = ` "type": "number", }, "mode": { - "description": "A mode of the project affecting what actions are possible in this project. During a rollout of project modes this feature can be optional or \`null\`", + "description": "The project's [collaboration mode](https://docs.getunleash.io/reference/project-collaboration-mode). Determines whether non-project members can submit change requests or not.", "enum": [ "open", "protected", ], "example": "open", - "nullable": true, "type": "string", }, "name": { @@ -2832,7 +2830,7 @@ exports[`should serve the OpenAPI spec 1`] = ` "type": "number", }, "mode": { - "description": "A mode of the project affecting what actions are possible in this project", + "description": "The project's [collaboration mode](https://docs.getunleash.io/reference/project-collaboration-mode). Determines whether non-project members can submit change requests or not.", "enum": [ "open", "protected", @@ -2917,7 +2915,7 @@ exports[`should serve the OpenAPI spec 1`] = ` "type": "number", }, "mode": { - "description": "A mode of the project affecting what actions are possible in this project", + "description": "The project's [collaboration mode](https://docs.getunleash.io/reference/project-collaboration-mode). Determines whether non-project members can submit change requests or not.", "enum": [ "open", "protected",