test(oas3): add server variables object validation #440
Conversation
|
|
||
| // if you define a variable that is not in URL it warns (and the variable is discarded). | ||
| variablesKeys.forEach((key) => { | ||
| if (urlVariables.indexOf(key) === -1) { |
There was a problem hiding this comment.
| if (urlVariables.indexOf(key) === -1) { | |
| if (!urlVariables.includes(key)) { |
| variablesKeys.forEach((key) => { | ||
| if (urlVariables.indexOf(key) === -1) { | ||
| parseResult.push(createWarning(context.namespace, | ||
| `Server variable '${key}' is not present in the URL and will be discarted`, variables)); |
There was a problem hiding this comment.
| `Server variable '${key}' is not present in the URL and will be discarted`, variables)); | |
| `Server variable '${key}' is not present in the URL and will be ignored`, variables)); |
discarted has a typo, but instead I think "ignored" sounds a little better here. What do you think?
There was a problem hiding this comment.
I can put ignored, however, as the variable is taken away, discarded may make the idea clearer?
There was a problem hiding this comment.
anyway it has been replaced
| const name = 'Server Object'; | ||
| const requiredKeys = ['url']; | ||
|
|
||
| const validateVariableInURL = (context, object) => { |
There was a problem hiding this comment.
| const validateVariableInURL = (context, object) => { | |
| const validateVariablesInURL = (context, object) => { |
I'd make variable plural in the method name as we're validating a set of variables not singular variable.
There was a problem hiding this comment.
good, change on next commit
| .map(x => x.replace(/[{}]/g, '')); | ||
|
|
||
| // if you define a variable that is not in URL it warns (and the variable is discarded). | ||
| variablesKeys.forEach((key) => { |
There was a problem hiding this comment.
| variablesKeys.forEach((key) => { | |
| variables.keys().forEach((key) => { |
There's a method for this already so you can delete the above const variablesKeys = variables.content.map(variable => variable.key.toValue());.
| urlVariables.forEach((key) => { | ||
| if (!variables.hasKey(key)) { | ||
| parseResult.push(createWarning(context.namespace, | ||
| `URL variable '${key}' is missing within the server variables`, variables)); |
There was a problem hiding this comment.
| `URL variable '${key}' is missing within the server variables`, variables)); | |
| `URL variable '${key}' is missing within the server variables`, object.get('url'))); |
I think we want to use the URL here to create the warning, because the source map for the warning should originate from the URL which contains the variable which isn't defined.
marcofriso
force-pushed
the
marco/server-variables-validation
branch
from
4dccd1c to
a39f634
Compare
|
@kylef merge? |
2 participants
Closes APIARY-6482