feat(functions): annotate internal options (#1991)

stoplightio · Dec 10, 2021 · 259698f · 259698f
1 parent 0daac81
commit 259698f
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 13 deletions.
diff --git a/.yarn/install-state.gz b/.yarn/install-state.gz
diff --git a/packages/functions/package.json b/packages/functions/package.json
@@ -23,12 +23,12 @@
   },
   "dependencies": {
     "@stoplight/better-ajv-errors": "1.0.1",
-    "@stoplight/json": "3.17.0",
-    "@stoplight/spectral-core": "^1.1.0",
+    "@stoplight/json": "~3.17.1",
+    "@stoplight/spectral-core": "^1.7.0",
     "@stoplight/spectral-formats": "^1.0.0",
-    "@stoplight/spectral-runtime": "*",
+    "@stoplight/spectral-runtime": "^1.1.0",
     "@stoplight/types": "12.3.0",
-    "ajv": "~8.6.3",
+    "ajv": "^8.6.3",
     "ajv-draft-04": "~1.0.0",
     "ajv-errors": "~3.0.0",
     "ajv-formats": "~2.1.0",

diff --git a/packages/functions/src/optionSchemas.ts b/packages/functions/src/optionSchemas.ts
@@ -115,6 +115,7 @@ export const optionSchemas: Record<string, CustomFunctionOptionsSchema> = {
               },
             },
             required: ['test', 'flags'],
+            'x-internal': true,
           },
         ],
         errorMessage: `"pattern" function and its "match" option must be string or RegExp instance`,
@@ -135,6 +136,7 @@ export const optionSchemas: Record<string, CustomFunctionOptionsSchema> = {
               },
             },
             required: ['test', 'flags'],
+            'x-internal': true,
           },
         ],
         errorMessage: `"pattern" function and its "notMatch" option must be string or RegExp instance`,
@@ -166,7 +168,9 @@ export const optionSchemas: Record<string, CustomFunctionOptionsSchema> = {
         default: false,
         description: 'Returns all errors when true; otherwise only returns the first error.',
       },
-      prepareResults: true,
+      prepareResults: {
+        'x-internal': true,
+      },
     },
     required: ['schema'],
     type: 'object',

diff --git a/yarn.lock b/yarn.lock
@@ -1948,7 +1948,7 @@ __metadata:
   languageName: node
   linkType: hard
 
-"@stoplight/json@npm:3.17.0, @stoplight/json@npm:^3.15.0, @stoplight/json@npm:^3.17.0":
+"@stoplight/json@npm:3.17.0, @stoplight/json@npm:^3.15.0, @stoplight/json@npm:^3.17.0, @stoplight/json@npm:~3.17.1":
   version: 3.17.0
   resolution: "@stoplight/json@npm:3.17.0"
   dependencies:
@@ -2023,7 +2023,7 @@ __metadata:
   languageName: unknown
   linkType: soft
 
-"@stoplight/spectral-core@>=1, @stoplight/spectral-core@^1.1.0, @stoplight/spectral-core@^1.3.0, @stoplight/spectral-core@^1.5.1, @stoplight/spectral-core@workspace:packages/core":
+"@stoplight/spectral-core@>=1, @stoplight/spectral-core@^1.1.0, @stoplight/spectral-core@^1.3.0, @stoplight/spectral-core@^1.5.1, @stoplight/spectral-core@^1.7.0, @stoplight/spectral-core@workspace:packages/core":
   version: 0.0.0-use.local
   resolution: "@stoplight/spectral-core@workspace:packages/core"
   dependencies:
@@ -2074,13 +2074,13 @@ __metadata:
   resolution: "@stoplight/spectral-functions@workspace:packages/functions"
   dependencies:
     "@stoplight/better-ajv-errors": 1.0.1
-    "@stoplight/json": 3.17.0
-    "@stoplight/spectral-core": ^1.1.0
+    "@stoplight/json": ~3.17.1
+    "@stoplight/spectral-core": ^1.7.0
     "@stoplight/spectral-formats": ^1.0.0
     "@stoplight/spectral-parsers": "*"
-    "@stoplight/spectral-runtime": "*"
+    "@stoplight/spectral-runtime": ^1.1.0
     "@stoplight/types": 12.3.0
-    ajv: ~8.6.3
+    ajv: ^8.6.3
     ajv-draft-04: ~1.0.0
     ajv-errors: ~3.0.0
     ajv-formats: ~2.1.0
@@ -2184,7 +2184,7 @@ __metadata:
   languageName: unknown
   linkType: soft
 
-"@stoplight/spectral-runtime@*, @stoplight/spectral-runtime@^1.0.0, @stoplight/spectral-runtime@^1.1.0, @stoplight/spectral-runtime@workspace:packages/runtime":
+"@stoplight/spectral-runtime@^1.0.0, @stoplight/spectral-runtime@^1.1.0, @stoplight/spectral-runtime@workspace:packages/runtime":
   version: 0.0.0-use.local
   resolution: "@stoplight/spectral-runtime@workspace:packages/runtime"
   dependencies:
@@ -2842,7 +2842,7 @@ __metadata:
   languageName: node
   linkType: hard
 
-"ajv@npm:^8.0.0, ajv@npm:^8.0.1, ajv@npm:^8.6.0, ajv@npm:~8.6.0, ajv@npm:~8.6.3":
+"ajv@npm:^8.0.0, ajv@npm:^8.0.1, ajv@npm:^8.6.0, ajv@npm:^8.6.3, ajv@npm:~8.6.0":
   version: 8.6.3
   resolution: "ajv@npm:8.6.3"
   dependencies: