Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(rulesets): add oas3-server-variables rule #2526

Merged
merged 12 commits into from
Aug 29, 2023
Merged

feat(rulesets): add oas3-server-variables rule #2526

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
5aebd49
feat(rulesets): add openapi-server-variables rule
P0lip Aug 21, 2023
89f2fb2
chore(rulesets): drop String.prototype.replaceAll
P0lip Aug 22, 2023
ac5ac71
chore(repo): remove yarn from deps
P0lip Aug 22, 2023
18ba260
refactor(rulesets): beautify applyUrlVariables
P0lip Aug 22, 2023
66462eb
feat(rulesets): validate link objects
P0lip Aug 22, 2023
07c8663
chore(rulesets): remove as const
P0lip Aug 22, 2023
38988a5
chore(rulesets): rename to oas3-server-variables
P0lip Aug 25, 2023
2e29fc2
docs(repo): adds docs for oas3-server-variables
mnaumanali94 Aug 29, 2023
6a553a9
docs(repo): fix linting issues
mnaumanali94 Aug 29, 2023
43f7aa3
chore(rulesets): description name
P0lip Aug 29, 2023
f5753ad
chore(rulesets): message name
P0lip Aug 29, 2023
ec3e51d
docs(repo): update url
mnaumanali94 Aug 29, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 5 additions & 6 deletions packages/rulesets/src/asyncapi/functions/asyncApi2ChannelParameters.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
import { createRulesetFunction } from '@stoplight/spectral-core';

import { parseUrlVariables } from './utils/parseUrlVariables';
import { getMissingProps } from './utils/getMissingProps';
import { getRedundantProps } from './utils/getRedundantProps';

import type { IFunctionResult } from '@stoplight/spectral-core';
import { parseUrlVariables } from '../../shared/functions/serverVariables/utils/parseUrlVariables';
import { getMissingProps } from '../../shared/utils/getMissingProps';
import { getRedundantProps } from '../../shared/utils/getRedundantProps';

export default createRulesetFunction<{ parameters: Record<string, unknown> }, null>(
{
Expand All @@ -26,7 +25,7 @@ export default createRulesetFunction<{ parameters: Record<string, unknown> }, nu
const parameters = parseUrlVariables(path);
if (parameters.length === 0) return;

const missingParameters = getMissingProps(parameters, targetVal.parameters);
const missingParameters = getMissingProps(parameters, Object.keys(targetVal.parameters));
if (missingParameters.length) {
results.push({
message: `Not all channel's parameters are described with "parameters" object. Missed: ${missingParameters.join(
Expand All @@ -36,7 +35,7 @@ export default createRulesetFunction<{ parameters: Record<string, unknown> }, nu
});
}

const redundantParameters = getRedundantProps(parameters, targetVal.parameters);
const redundantParameters = getRedundantProps(parameters, Object.keys(targetVal.parameters));
if (redundantParameters.length) {
redundantParameters.forEach(param => {
results.push({
Expand Down
53 changes: 0 additions & 53 deletions packages/rulesets/src/asyncapi/functions/asyncApi2ServerVariables.ts
View file
Open in desktop

This file was deleted.

6 changes: 0 additions & 6 deletions packages/rulesets/src/asyncapi/functions/utils/getMissingProps.ts
View file
Open in desktop

This file was deleted.

6 changes: 0 additions & 6 deletions packages/rulesets/src/asyncapi/functions/utils/getRedundantProps.ts
View file
Open in desktop

This file was deleted.

4 changes: 2 additions & 2 deletions packages/rulesets/src/asyncapi/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ import asyncApi2MessageIdUniqueness from './functions/asyncApi2MessageIdUniquene
import asyncApi2OperationIdUniqueness from './functions/asyncApi2OperationIdUniqueness';
import asyncApi2SchemaValidation from './functions/asyncApi2SchemaValidation';
import asyncApi2PayloadValidation from './functions/asyncApi2PayloadValidation';
import asyncApi2ServerVariables from './functions/asyncApi2ServerVariables';
import serverVariables from '../shared/functions/serverVariables';
import { uniquenessTags } from '../shared/functions';
import asyncApi2Security from './functions/asyncApi2Security';
import { latestVersion } from './functions/utils/specs';
Expand Down Expand Up @@ -370,7 +370,7 @@ export default {
recommended: true,
given: ['$.servers.*', '$.components.servers.*'],
then: {
function: asyncApi2ServerVariables,
function: serverVariables,
},
},
'asyncapi-server-no-empty-variable': {
Expand Down
Loading