fix(ls): finalize rules for OpenAPI License object

Refs 20a09d5
swagger-api · Oct 19, 2022 · adb48bf · adb48bf
1 parent be8a96a
commit adb48bf
Show file tree

Hide file tree

Showing 8 changed files with 26 additions and 19 deletions.
diff --git a/packages/apidom-ls/src/config/codes.ts b/packages/apidom-ls/src/config/codes.ts
@@ -813,8 +813,9 @@ enum ApilintCodes {
   OPENAPI3_1_COMPONENTS = 7020000,
   OPENAPI3_1_COMPONENTS_FIELD_PATH_ITEMS_VALUES_TYPE = 7020100,
 
-  OPENAPI3_1_LICENSE_FIELD_IDENTIFIER_TYPE = 7040300,
-  OPENAPI3_1_LICENSE_FIELD_IDENTIFIER_MUTUALLY_EXCLUSIVE = 7040600,
+  OPENAPI3_1_LICENSE = 7030000,
+  OPENAPI3_1_LICENSE_FIELD_IDENTIFIER_TYPE = 7030100,
+  OPENAPI3_1_LICENSE_FIELD_IDENTIFIER_MUTUALLY_EXCLUSIVE,
 
   ADS = 8000000,
   ADS_INFO = 8010000,

diff --git a/packages/apidom-ls/src/config/openapi/license/completion.ts b/packages/apidom-ls/src/config/openapi/license/completion.ts
@@ -63,19 +63,6 @@ const completion: ApidomCompletionItem[] = [
     },
     targetSpecs: [{ namespace: 'openapi', version: '3.1.0' }],
   },
-  {
-    label: 'email',
-    insertText: 'email',
-    kind: 14,
-    format: CompletionFormat.QUOTED,
-    type: CompletionType.PROPERTY,
-    insertTextFormat: 2,
-    documentation: {
-      kind: 'markdown',
-      value:
-        'The email address of the contact person/organization. This MUST be in the form of an email address.',
-    },
-  },
 ];
 
 export default completion;
diff --git a/packages/apidom-ls/src/config/openapi/license/lint/identifier--type.ts b/packages/apidom-ls/src/config/openapi/license/lint/identifier--type.ts
@@ -0,0 +1,17 @@
+import ApilintCodes from '../../../codes';
+import { LinterMeta } from '../../../../apidom-language-types';
+
+const identifierTypeLint: LinterMeta = {
+  code: ApilintCodes.OPENAPI3_1_LICENSE_FIELD_IDENTIFIER_TYPE,
+  source: 'apilint',
+  message: "'identifier' must be a string",
+  severity: 1,
+  linterFunction: 'apilintType',
+  linterParams: ['string'],
+  marker: 'value',
+  target: 'name',
+  data: {},
+  targetSpecs: [{ namespace: 'openapi', version: '3.1.0' }],
+};
+
+export default identifierTypeLint;
diff --git a/packages/apidom-ls/src/config/openapi/license/lint/index.ts b/packages/apidom-ls/src/config/openapi/license/lint/index.ts
@@ -2,12 +2,14 @@ import allowedFields3_0Lint from './allowed-fields-3-0';
 import allowedFields3_1Lint from './allowed-fields-3-1';
 import nameTypeLint from './name--type';
 import nameRequiredLint from './name--required';
+import identifierTypeLint from './identifier--type';
 import identifierMutuallyExclusiveLint from './identifier--mutually-exclusive';
 import urlFormatURILint from './url--format-uri';
 
 const lints = [
   nameTypeLint,
   nameRequiredLint,
+  identifierTypeLint,
   identifierMutuallyExclusiveLint,
   urlFormatURILint,
   allowedFields3_0Lint,

diff --git a/packages/apidom-ls/src/config/openapi/license/lint/name--type.ts b/packages/apidom-ls/src/config/openapi/license/lint/name--type.ts
@@ -2,7 +2,7 @@ import ApilintCodes from '../../../codes';
 import { LinterMeta } from '../../../../apidom-language-types';
 
 const nameTypeLint: LinterMeta = {
-  code: ApilintCodes.OPENAPI3_1_LICENSE_FIELD_IDENTIFIER_TYPE,
+  code: ApilintCodes.OPENAPI3_0_LICENSE_FIELD_NAME_TYPE,
   source: 'apilint',
   message: "'identifier' must be a string",
   severity: 1,

diff --git a/packages/apidom-ls/test/openapi-json.ts b/packages/apidom-ls/test/openapi-json.ts
@@ -485,7 +485,7 @@ describe('apidom-ls', function () {
         source: 'apilint',
       },
       {
-        code: 7040600,
+        code: 7030101,
         message: 'The identifier field and url field are mutually exclusive.',
         range: {
           end: {

diff --git a/packages/apidom-ls/test/openapi-yaml.ts b/packages/apidom-ls/test/openapi-yaml.ts
@@ -622,7 +622,7 @@ describe('apidom-ls-yaml', function () {
         source: 'apilint',
       },
       {
-        code: 7040600,
+        code: 7030101,
         message: 'The identifier field and url field are mutually exclusive.',
         range: {
           end: {

diff --git a/packages/apidom-ls/test/validate.ts b/packages/apidom-ls/test/validate.ts
@@ -2871,7 +2871,7 @@ describe('apidom-ls-validate', function () {
     const result = await languageService.doValidation(doc, validationContext);
     const expected: Diagnostic[] = [
       {
-        code: 7040600,
+        code: 7030101,
         message: 'The identifier field and url field are mutually exclusive.',
         range: {
           end: {