Mirrors/unleash.unleash
1
0
Fork 0
mirror of https://github.com/Unleash/unleash.git synced 2025-01-25 00:07:47 +01:00
Code Issues Projects Releases Wiki Activity

OpenAPI: add operation tests: require summaries and descriptions (#4377)

Browse Source 
This PR adds an e2e test to the OpenAPI tests that checks that all
openapi operations have both summaries and descriptions. It also fixes
the few schemas that were missing one or the other.
This commit is contained in:
Thomas Heartman 2023-08-01 15:58:15 +02:00 committed by GitHub
parent b8ab43543f
commit 452b5a6748
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
7 changed files with 47 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
src/lib/routes/admin-api/archive.ts
View File

@ -42,6 +42,9 @@ export default class ArchiveController extends Controller {
middleware: [
openApiService.validPath({
tags: ['Archive'],
summary: 'Get archived features',
description:
'Retrieve a list of all [archived feature toggles](https://docs.getunleash.io/reference/archived-toggles).',
operationId: 'getArchivedFeatures',
responses: {
200: createResponseSchema('featuresSchema'),
@ -62,6 +65,9 @@ export default class ArchiveController extends Controller {
openApiService.validPath({
tags: ['Archive'],
operationId: 'getArchivedFeaturesByProjectId',
summary: 'Get archived features in project',
description:
'Retrieves a list of archived features that belong to the provided project.',
responses: {
200: createResponseSchema('featuresSchema'),
...getStandardResponses(401, 403),

5
src/lib/routes/admin-api/client-metrics.ts
View File

@ -59,8 +59,9 @@ class ClientMetricsController extends Controller {
openApiService.validPath({
operationId: 'getRawFeatureMetrics',
tags: ['Metrics'],
summary:
'Feature usage metrics for the last 48 hours, grouped by hour',
summary: 'Get feature metrics',
description:
'Get usage metrics for a specific feature for the last 48 hours, grouped by hour',
responses: {
200: createResponseSchema('featureMetricsSchema'),
...getStandardResponses(401, 403, 404),

1
src/lib/routes/admin-api/project/environments.ts
View File

@ -99,6 +99,7 @@ export default class EnvironmentsController extends Controller {
openApiService.validPath({
tags: ['Projects'],
operationId: 'addDefaultStrategyToProjectEnvironment',
summary: 'Set environment-default strategy',
description:
'Adds a default strategy for this environment. Unleash will use this strategy by default when enabling a toggle. Use the wild card "*" for `:environment` to add to all environments. ',
requestBody: createRequestSchema(

4
src/lib/routes/admin-api/project/project-features.ts
View File

@ -325,8 +325,10 @@ export default class ProjectFeaturesController extends Controller {
middleware: [
openApiService.validPath({
tags: ['Features'],
summary: 'Set the order of strategies on the list',
operationId: 'setStrategySortOrder',
summary: 'Set strategy sort order',
description:
'Set the sort order of the provided list of strategies.',
requestBody: createRequestSchema(
'setStrategySortOrderSchema',
),

3
src/lib/routes/admin-api/public-signup.ts
View File

@ -74,7 +74,8 @@ export class PublicSignupController extends Controller {
middleware: [
openApiService.validPath({
tags: ['Public signup tokens'],
summary: 'Retrieve all existing public signup tokens',
summary: 'Get public signup tokens',
description: 'Retrieves all existing public signup tokens.',
operationId: 'getAllPublicSignupTokens',
responses: {
200: createResponseSchema('publicSignupTokensSchema'),

3
src/lib/routes/public-invite.ts
View File

@ -52,7 +52,8 @@ export class PublicInviteController extends Controller {
openApiService.validPath({
tags: ['Public signup tokens'],
operationId: 'validatePublicSignupToken',
summary: `Check whether a public sign-up token exists, has not expired and is enabled`,
summary: `Validate signup token`,
description: `Check whether the provided public sign-up token exists, has not expired and is enabled`,
responses: {
200: emptyResponse,
...getStandardResponses(400),

30
src/test/e2e/api/openapi/openapi.e2e.test.ts
View File

@ -192,3 +192,33 @@ test('all tags are listed in the root "tags" list', async () => {
}
expect(invalidTags).toStrictEqual({});
});
test('all API operations have summaries and descriptions', async () => {
const { body: spec } = await app.request
.get('/docs/openapi.json')
.expect('Content-Type', /json/)
.expect(200);
const anomalies = Object.entries(spec.paths).flatMap(([path, data]) => {
return Object.entries(data)
.map(([verb, operationDescription]) => {
if (
'summary' in operationDescription &&
'description' in operationDescription
) {
return undefined;
} else {
return [verb, operationDescription.operationId];
}
})
.filter(Boolean)
.map(
([verb, operationId]) =>
`${verb.toUpperCase()} ${path} (operation ID: ${operationId})`,
);
});
// any items left in the anomalies list is missing either a summary, or a
// description, or both.
expect(anomalies).toStrictEqual([]);
});