Remove ref links & update tests

functions/acceptableAuth.js

@@ -46,7 +46,7 @@ export default function (input) {
  if (invalidScheme) {
  return [
  {
- message: 'My API authenticates requests using access tokens; NOT username/passwords. (https://developer.cisco.com/docs/api-insights/#!api-guidelines-analyzer)',
+ message: 'My API authenticates requests using access tokens; NOT username/passwords.',
  },
  ];
  }

functions/acceptableAuth.spec.js

@@ -48,7 +48,7 @@ describe('acceptableAuth', () => {
 
  expect(res).toEqual([
  {
- message: 'My API authenticates requests using access tokens; NOT username/passwords. (https://developer.cisco.com/docs/api-insights/#!api-guidelines-analyzer)',
+ message: 'My API authenticates requests using access tokens; NOT username/passwords.',
  },
  ]);
  });
@@ -68,7 +68,7 @@ describe('acceptableAuth', () => {
 
  expect(res).toEqual([
  {
- message: 'My API authenticates requests using access tokens; NOT username/passwords. (https://developer.cisco.com/docs/api-insights/#!api-guidelines-analyzer)',
+ message: 'My API authenticates requests using access tokens; NOT username/passwords.',
  },
  ]);
  });
@@ -79,7 +79,7 @@ describe('acceptableAuth', () => {
 
  expect(res).toEqual([
  {
- message: 'My API authenticates requests using access tokens; NOT username/passwords. (https://developer.cisco.com/docs/api-insights/#!api-guidelines-analyzer)',
+ message: 'My API authenticates requests using access tokens; NOT username/passwords.',
  },
  ]);
  });

functions/checkForMaxParameterLinkHeaderLikely.spec.js

@@ -23,11 +23,11 @@ const path = [
  '/test',
 ];
 const maxQueryMessage = {
- message: 'When returning a paginated collection, include a "max" query parameter (https://developer.cisco.com/docs/api-insights/#!api-guidelines-analyzer)',
+ message: 'When returning a paginated collection, include a "max" query parameter',
  path: [...path],
 };
 const linkHeaderMessage = {
- message: 'When returning a paginated collection, include a "Link" header in the response (https://developer.cisco.com/docs/api-insights/#!api-guidelines-analyzer)',
+ message: 'When returning a paginated collection, include a "Link" header in the response',
  path: [
  ...path,
  'responses',

functions/checkForMaxParameterLinkHeaderPossible.spec.js

@@ -23,15 +23,15 @@ const path = [
  '/test',
 ];
 const maxQueryMessage = {
- message: 'When returning a paginated collection, include a "max" query parameter (https://developer.cisco.com/docs/api-insights/#!api-guidelines-analyzer)',
+ message: 'When returning a paginated collection, include a "max" query parameter',
  path: [...path],
 };
 const offsetQueryMessage = {
- message: 'When supporting offset-based pagination, operations include a "offset" query parameter (https://developer.cisco.com/docs/api-insights/#!api-guidelines-analyzer)',
+ message: 'When supporting offset-based pagination, operations include a "offset" query parameter',
  path: [...path],
 };
 const linkHeaderMessage = {
- message: 'When returning a paginated collection, include a "Link" header in the response (https://developer.cisco.com/docs/api-insights/#!api-guidelines-analyzer)',
+ message: 'When returning a paginated collection, include a "Link" header in the response',
  path: [
  ...path,
  'responses',

functions/checkPathBasedVersioning.js

@@ -51,7 +51,7 @@ export default function (input, opts) {
  if (!(defaultVersioning || paths || onlyMajor)) {
  return [
  {
- message: 'API uses path-based versioning. (https://developer.cisco.com/docs/api-insights/#!api-guidelines-analyzer)',
+ message: 'API uses path-based versioning.',
  },
  ];
  }
@@ -60,7 +60,7 @@ export default function (input, opts) {
  if ((defaultVersioning || paths) && onlyMajor) {
  return [
  {
- message: 'API shows only major version numbers on the path; not the revision numbers. (https://developer.cisco.com/docs/api-insights/#!api-guidelines-analyzer)',
+ message: 'API shows only major version numbers on the path; not the revision numbers.',
  },
  ];
  }

functions/checkPathBasedVersioning.spec.js

@@ -17,8 +17,8 @@
  */
 
 import checkPathBasedVersioning from './checkPathBasedVersioning.js';
-const hasVersionErrorMsg = 'API uses path-based versioning. (https://developer.cisco.com/docs/api-insights/#!api-guidelines-analyzer)';
-const onlyMajorErrorMsg = 'API shows only major version numbers on the path; not the revision numbers. (https://developer.cisco.com/docs/api-insights/#!api-guidelines-analyzer)';
+const hasVersionErrorMsg = 'API uses path-based versioning.';
+const onlyMajorErrorMsg = 'API shows only major version numbers on the path; not the revision numbers.';
 
 describe('checkPathBasedVersioning', () => {
  test('should check version in servers - oas3', () => {

functions/checkRFC5322RegexCompliance.js

@@ -43,7 +43,7 @@ export default function (input) {
  if (!regex.exec(sample)) {
  return [
  {
- message: `The regex pattern used does not pass basic linting sample checks - should have matched case ${ sample } (https://developer.cisco.com/docs/api-insights/#!api-guidelines-analyzer)`,
+ message: `The regex pattern used does not pass basic linting sample checks - should have matched case ${ sample }`,
  },
  ];
  }
@@ -54,15 +54,15 @@ export default function (input) {
  if (regex.exec(sample)) {
  return [
  {
- message: `The regex pattern used does not pass basic linting sample checks - should not have matched case ${ sample } (${ msg }) (https://developer.cisco.com/docs/api-insights/#!api-guidelines-analyzer)`,
+ message: `The regex pattern used does not pass basic linting sample checks - should not have matched case ${ sample } (${ msg })`,
  },
  ];
  }
  }
  } catch (err) {
  return [
  {
- message: 'Failed to parse regex (https://developer.cisco.com/docs/api-insights/#!api-guidelines-analyzer)',
+ message: 'Failed to parse regex',
  },
  ];
  }

functions/checkRFC5322RegexCompliance.spec.js

@@ -28,7 +28,7 @@ describe('checkRFC5322RegexCompliance', () => {
 
  expect(res).toEqual([
  {
- message: 'The regex pattern used does not pass basic linting sample checks - should not have matched case Thu 8 Apr 2021 19:06:27 GMT (Comma required after Day of Week) (https://developer.cisco.com/docs/api-insights/#!api-guidelines-analyzer)',
+ message: 'The regex pattern used does not pass basic linting sample checks - should not have matched case Thu 8 Apr 2021 19:06:27 GMT (Comma required after Day of Week)',
  },
  ]);
  });

functions/correctResponseRange.js

@@ -55,7 +55,7 @@ export default function (input, opts) {
  if (errStatusCodes.length) {
  return [
  {
- message: `Status Code(s) [${ errStatusCodes.toString() }] must be in the ${ rangeString } ranges: (https://developer.cisco.com/docs/api-insights/#!api-guidelines-analyzer)`,
+ message: `Status Code(s) [${ errStatusCodes.toString() }] must be in the ${ rangeString } ranges`,
  },
  ];
  }

functions/correctResponseRange.spec.js

@@ -59,7 +59,7 @@ describe('correctResponseRange', () => {
 
  expect(res).toEqual([
  {
- message: 'Status Code(s) [99,100,782] must be in the 2xx/3xx/4xx/5xx ranges: (https://developer.cisco.com/docs/api-insights/#!api-guidelines-analyzer)',
+ message: 'Status Code(s) [99,100,782] must be in the 2xx/3xx/4xx/5xx ranges',
  },
  ]);
  });

functions/hasErrorMessage.js

@@ -42,7 +42,7 @@ export default function (input, opts, context) {
  if (!errorMessage) {
  return [
  {
- message: 'Error representations include a useful human-readable message. (https://developer.cisco.com/docs/api-insights/#!api-guidelines-analyzer)',
+ message: 'Error representations include a useful human-readable message.',
  },
  ];
  }

functions/hasErrorMessage.spec.js

@@ -129,7 +129,7 @@ describe('hasErrorMessage', () => {
 
  expect(res).toEqual([
  {
- message: 'Error representations include a useful human-readable message. (https://developer.cisco.com/docs/api-insights/#!api-guidelines-analyzer)',
+ message: 'Error representations include a useful human-readable message.',
  },
  ]);
  });

functions/hasRecommendedStatusCodes.js

@@ -86,7 +86,7 @@ export default function (input, opts) {
  if (!acceptableCodes.includes(`${ input }`)) {
  return [
  {
- message: `${ input } is not an acceptable response code for ${ method.toUpperCase() }. My API responds with recommended HTTP status codes in the 2xx/3xx/4xx/5xx ranges (https://developer.cisco.com/docs/api-insights/#!api-guidelines-analyzer)`,
+ message: `${ input } is not an acceptable response code for ${ method.toUpperCase() }. My API responds with recommended HTTP status codes in the 2xx/3xx/4xx/5xx ranges`,
  },
  ];
  }

functions/hasRecommendedStatusCodes.spec.js

@@ -80,7 +80,7 @@ describe('hasRecommendedStatusCodes', () => {
  for (const res of badCodes) {
  expect(hasRecommendedStatusCodes(res, { method: 'get' })).toEqual([
  {
- message: `${ res } is not an acceptable response code for GET. My API responds with recommended HTTP status codes in the 2xx/3xx/4xx/5xx ranges (https://developer.cisco.com/docs/api-insights/#!api-guidelines-analyzer)`,
+ message: `${ res } is not an acceptable response code for GET. My API responds with recommended HTTP status codes in the 2xx/3xx/4xx/5xx ranges`,
  },
  ]);
  }
@@ -96,7 +96,7 @@ describe('hasRecommendedStatusCodes', () => {
  for (const res of badCodes) {
  expect(hasRecommendedStatusCodes(res, { method: 'get' })).toEqual([
  {
- message: `${ res } is not an acceptable response code for GET. My API responds with recommended HTTP status codes in the 2xx/3xx/4xx/5xx ranges (https://developer.cisco.com/docs/api-insights/#!api-guidelines-analyzer)`,
+ message: `${ res } is not an acceptable response code for GET. My API responds with recommended HTTP status codes in the 2xx/3xx/4xx/5xx ranges`,
  },
  ]);
  }
@@ -116,7 +116,7 @@ describe('hasRecommendedStatusCodes', () => {
  for (const res of badCodes) {
  expect(hasRecommendedStatusCodes(res, { method: 'post' })).toEqual([
  {
- message: `${ res } is not an acceptable response code for POST. My API responds with recommended HTTP status codes in the 2xx/3xx/4xx/5xx ranges (https://developer.cisco.com/docs/api-insights/#!api-guidelines-analyzer)`,
+ message: `${ res } is not an acceptable response code for POST. My API responds with recommended HTTP status codes in the 2xx/3xx/4xx/5xx ranges`,
  },
  ]);
  }
@@ -136,7 +136,7 @@ describe('hasRecommendedStatusCodes', () => {
  for (const res of badCodes) {
  expect(hasRecommendedStatusCodes(res, { method: 'put' })).toEqual([
  {
- message: `${ res } is not an acceptable response code for PUT. My API responds with recommended HTTP status codes in the 2xx/3xx/4xx/5xx ranges (https://developer.cisco.com/docs/api-insights/#!api-guidelines-analyzer)`,
+ message: `${ res } is not an acceptable response code for PUT. My API responds with recommended HTTP status codes in the 2xx/3xx/4xx/5xx ranges`,
  },
  ]);
  }
@@ -159,7 +159,7 @@ describe('hasRecommendedStatusCodes', () => {
  for (const res of badCodes) {
  expect(hasRecommendedStatusCodes(res, { method: 'patch' })).toEqual([
  {
- message: `${ res } is not an acceptable response code for PATCH. My API responds with recommended HTTP status codes in the 2xx/3xx/4xx/5xx ranges (https://developer.cisco.com/docs/api-insights/#!api-guidelines-analyzer)`,
+ message: `${ res } is not an acceptable response code for PATCH. My API responds with recommended HTTP status codes in the 2xx/3xx/4xx/5xx ranges`,
  },
  ]);
  }
@@ -182,7 +182,7 @@ describe('hasRecommendedStatusCodes', () => {
  for (const res of badCodes) {
  expect(hasRecommendedStatusCodes(res, { method: 'delete' })).toEqual([
  {
- message: `${ res } is not an acceptable response code for DELETE. My API responds with recommended HTTP status codes in the 2xx/3xx/4xx/5xx ranges (https://developer.cisco.com/docs/api-insights/#!api-guidelines-analyzer)`,
+ message: `${ res } is not an acceptable response code for DELETE. My API responds with recommended HTTP status codes in the 2xx/3xx/4xx/5xx ranges`,
  },
  ]);
  }

functions/noCrudVerbs.js

@@ -27,7 +27,7 @@ export default function (input) {
  if (foundVerb) {
  return [
  {
- message: 'Standard CRUD lifecycle operations map to HTTP verbs; Functional resources are used when non-standard CRUD are needed (https://developer.cisco.com/docs/api-insights/#!api-guidelines-analyzer)',
+ message: 'Standard CRUD lifecycle operations map to HTTP verbs; Functional resources are used when non-standard CRUD are needed',
  },
  ];
  }

functions/resourcePasCamelCase.js

@@ -67,7 +67,7 @@ export default function (input, opts) {
  if (_node && !isPascalOrCamelCase(_node)) {
  // user will have to iteratively resolve issues in the same string
  result.push({
- message: `${ _node } must be PasCamelCase: (https://developer.cisco.com/docs/api-insights/#!api-guidelines-analyzer)`,
+ message: `${ _node } must be PasCamelCase`,
  });
  }
  }

functions/resourcePasCamelCase.spec.js

@@ -69,28 +69,28 @@ describe('resourcePasCamelCase', () => {
 
  expect(res).toEqual([
  {
- message: '30DaysCount must be PasCamelCase: (https://developer.cisco.com/docs/api-insights/#!api-guidelines-analyzer)',
+ message: '30DaysCount must be PasCamelCase',
  },
  ]);
 
  res = resourcePasCamelCase('30LessThan60DaysCount');
  expect(res).toEqual([
  {
- message: '30LessThan60DaysCount must be PasCamelCase: (https://developer.cisco.com/docs/api-insights/#!api-guidelines-analyzer)',
+ message: '30LessThan60DaysCount must be PasCamelCase',
  },
  ]);
 
  res = resourcePasCamelCase('60LessThan90DaysCount');
  expect(res).toEqual([
  {
- message: '60LessThan90DaysCount must be PasCamelCase: (https://developer.cisco.com/docs/api-insights/#!api-guidelines-analyzer)',
+ message: '60LessThan90DaysCount must be PasCamelCase',
  },
  ]);
 
  res = resourcePasCamelCase('90DaysCount');
  expect(res).toEqual([
  {
- message: '90DaysCount must be PasCamelCase: (https://developer.cisco.com/docs/api-insights/#!api-guidelines-analyzer)',
+ message: '90DaysCount must be PasCamelCase',
  },
  ]);
  });
@@ -100,21 +100,21 @@ describe('resourcePasCamelCase', () => {
 
  expect(res).toEqual([
  {
- message: 'THISISALLCAPS must be PasCamelCase: (https://developer.cisco.com/docs/api-insights/#!api-guidelines-analyzer)',
+ message: 'THISISALLCAPS must be PasCamelCase',
  },
  ]);
 
  res = resourcePasCamelCase('this_is_snake_case');
  expect(res).toEqual([
  {
- message: 'this_is_snake_case must be PasCamelCase: (https://developer.cisco.com/docs/api-insights/#!api-guidelines-analyzer)',
+ message: 'this_is_snake_case must be PasCamelCase',
  },
  ]);
 
  res = resourcePasCamelCase('THISHastoBePasCamelCase?!1');
  expect(res).toEqual([
  {
- message: 'THISHastoBePasCamelCase?!1 must be PasCamelCase: (https://developer.cisco.com/docs/api-insights/#!api-guidelines-analyzer)',
+ message: 'THISHastoBePasCamelCase?!1 must be PasCamelCase',
  },
  ]);
  });

test/authenticate-requests.spec.js

@@ -38,7 +38,7 @@ describe(ruleName, () => {
  expect(res).toEqual([
  {
  code: ruleName,
- message: 'API.REST.SECURITY.03: My API authenticates and authorizes all requests (https://developer.cisco.com/docs/api-insights/#!api-guidelines-analyzer)',
+ message: 'API.REST.SECURITY.03: My API authenticates and authorizes all requests; "get.security" property must be truthy',
  path: [
  'paths',
  '/test',
@@ -58,7 +58,7 @@ describe(ruleName, () => {
  },
  {
  code: ruleName,
- message: 'API.REST.SECURITY.03: My API authenticates and authorizes all requests (https://developer.cisco.com/docs/api-insights/#!api-guidelines-analyzer)',
+ message: 'API.REST.SECURITY.03: My API authenticates and authorizes all requests; "post.security" property must be truthy',
  path: [
  'paths',
  '/test',
@@ -78,7 +78,7 @@ describe(ruleName, () => {
  },
  {
  code: ruleName,
- message: 'API.REST.SECURITY.03: My API authenticates and authorizes all requests (https://developer.cisco.com/docs/api-insights/#!api-guidelines-analyzer)',
+ message: 'API.REST.SECURITY.03: My API authenticates and authorizes all requests; "put.security" property must be truthy',
  path: [
  'paths',
  '/test',
@@ -98,7 +98,7 @@ describe(ruleName, () => {
  },
  {
  code: ruleName,
- message: 'API.REST.SECURITY.03: My API authenticates and authorizes all requests (https://developer.cisco.com/docs/api-insights/#!api-guidelines-analyzer)',
+ message: 'API.REST.SECURITY.03: My API authenticates and authorizes all requests; "delete.security" property must be truthy',
  path: [
  'paths',
  '/test',
@@ -118,7 +118,7 @@ describe(ruleName, () => {
  },
  {
  code: ruleName,
- message: 'API.REST.SECURITY.03: My API authenticates and authorizes all requests (https://developer.cisco.com/docs/api-insights/#!api-guidelines-analyzer)',
+ message: 'API.REST.SECURITY.03: My API authenticates and authorizes all requests; "options.security" property must be truthy',
  path: [
  'paths',
  '/test',

test/date-response-header-format-pattern-requirement.spec.js

@@ -36,7 +36,7 @@ describe(ruleName, () => {
  expect(res).toEqual([
  {
  code: ruleName,
- message: 'All \'Date\' response headers should use a custom pattern match for RFC 5322. date-time or other given formats should not be used (https://developer.cisco.com/docs/api-insights/#!api-guidelines-analyzer)',
+ message: 'All responses include a \'Date\' header in the GMT timezone and RFC 5322 format.; "schema.pattern" property must be truthy',
  path: [
  'paths',
  '/test',
@@ -61,7 +61,7 @@ describe(ruleName, () => {
  },
  {
  code: ruleName,
- message: 'All \'Date\' response headers should use a custom pattern match for RFC 5322. date-time or other given formats should not be used (https://developer.cisco.com/docs/api-insights/#!api-guidelines-analyzer)',
+ message: 'All responses include a \'Date\' header in the GMT timezone and RFC 5322 format.; "format" property must be falsy',
  path: [
  'paths',
  '/test',
@@ -87,7 +87,7 @@ describe(ruleName, () => {
  },
  {
  code: ruleName,
- message: 'All \'Date\' response headers should use a custom pattern match for RFC 5322. date-time or other given formats should not be used (https://developer.cisco.com/docs/api-insights/#!api-guidelines-analyzer)',
+ message: 'All responses include a \'Date\' header in the GMT timezone and RFC 5322 format.; "schema.pattern" property must be truthy',
  path: [
  'paths',
  '/anotherTest',

test/date-response-header-regex-check.spec.js

@@ -36,7 +36,7 @@ describe(ruleName, () => {
  expect(res).toEqual([
  {
  code: ruleName,
- message: 'The regex pattern used does not pass basic linting sample checks - should not have matched case Thu 8 Apr 2021 19:06:27 GMT (Comma required after Day of Week) (https://developer.cisco.com/docs/api-insights/#!api-guidelines-analyzer)',
+ message: 'All responses include a \'Date\' header in the GMT timezone and RFC 5322 format.; The regex pattern used does not pass basic linting sample checks - should not have matched case Thu 8 Apr 2021 19:06:27 GMT (Comma required after Day of Week)',
  path: [
  'paths',
  '/test',