chore: add user-agent field

packages/cli/src/commands/split/index.ts

@@ -259,7 +259,7 @@ function iteratePathItems(
     const pathData = pathItems[pathName] as Oas3PathItem;
 
     if (isRef(pathData)) continue;
-    
+
     for (const method of OPENAPI3_METHOD_NAMES) {
       const methodData = pathData[method];
       const methodDataXCode = methodData?.['x-code-samples'] || methodData?.['x-codeSamples'];

packages/cli/src/index.ts

@@ -29,7 +29,10 @@ yargs
           default: 'stylish' as OutputFormat,
         },
       }),
-    handleStats
+    (argv) => {
+      process.env.REDOCLY_CLI_COMMAND = 'stats';
+      handleStats(argv);
+    }
   )
   .command(
     'split [entrypoint]',
@@ -54,7 +57,10 @@ yargs
           },
         })
         .demandOption('entrypoint'),
-    handleSplit
+    (argv) => {
+      process.env.REDOCLY_CLI_COMMAND = 'split';
+      handleSplit(argv);
+    }
   )
   .command(
     'join [entrypoints...]',
@@ -89,6 +95,7 @@ yargs
           },
         }),
     (argv) => {
+      process.env.REDOCLY_CLI_COMMAND = 'join';
       handleJoin(argv, version);
     }
   )
@@ -127,7 +134,10 @@ yargs
         })
         .implies('batch-id', 'batch-size')
         .implies('batch-size', 'batch-id'),
-    transformPush(handlePush)
+    (argv) => {
+      process.env.REDOCLY_CLI_COMMAND = 'push';
+      transformPush(handlePush)(argv);
+    }
   )
   .command(
     'lint [entrypoints...]',
@@ -167,11 +177,7 @@ yargs
         },
         'lint-config': {
           description: 'Apply severity for linting the config file.',
-          choices: [
-            'warn',
-            'error',
-            'off',
-          ] as ReadonlyArray<RuleSeverity>,
+          choices: ['warn', 'error', 'off'] as ReadonlyArray<RuleSeverity>,
           default: 'warn' as RuleSeverity,
         },
         config: {
@@ -187,6 +193,7 @@ yargs
         },
       }),
     (argv) => {
+      process.env.REDOCLY_CLI_COMMAND = 'lint';
       handleLint(argv, version);
     }
   )
@@ -281,13 +288,17 @@ yargs
           choices: regionChoices,
         },
       }),
-    handleLogin
+    (argv) => {
+      process.env.REDOCLY_CLI_COMMAND = 'login';
+      handleLogin(argv);
+    }
   )
   .command(
     'logout',
     'Clear your stored credentials for the Redocly API registry.',
     (yargs) => yargs,
     async () => {
+      process.env.REDOCLY_CLI_COMMAND = 'logout';
       const client = new RedoclyClient();
       client.logout();
       process.stdout.write('Logged out from the Redocly account. ✋\n');
@@ -334,7 +345,10 @@ yargs
           type: 'string',
         },
       }),
-    previewDocs
+    (argv) => {
+      process.env.REDOCLY_CLI_COMMAND = 'preview-docs';
+      previewDocs(argv);
+    }
   )
   .completion('completion', 'Generate completion script.')
   .demandCommand(1)

packages/core/src/redocly/registry-api.ts

@@ -4,6 +4,8 @@ import { DEFAULT_REGION, DOMAINS } from '../config/config';
 import { isNotEmptyObject } from '../utils';
 const version = require('../../package.json').version;
 
+export const currentCommand = typeof process !== 'undefined' ? process.env?.REDOCLY_CLI_COMMAND || '' : '';
+
 import type { AccessTokens, Region } from '../config/types';
 
 export class RegistryApi {
@@ -23,7 +25,10 @@ export class RegistryApi {
   }
 
   private async request(path = '', options: RequestInit = {}, region?: Region) {
-    const headers = Object.assign({}, options.headers || {}, { 'x-redocly-cli-version': version });
+    const headers = Object.assign({}, options.headers || {}, {
+      'x-redocly-cli-version': version,
+      'user-agent': `redocly-cli / ${version} ${currentCommand}`
+    });
 
     if (!headers.hasOwnProperty('authorization')) {
       throw new Error('Unauthorized');

packages/core/src/rules/ajv.ts

@@ -1,4 +1,4 @@
-import Ajv, { ValidateFunction, ErrorObject } from '@redocly/ajv';
+import Ajv, { ValidateFunction, ErrorObject } from '@redocly/ajv/dist/2019';
 import { Location, escapePointer } from '../ref-utils';
 import { ResolveFn } from '../walk';
 

resources/pets.yaml

@@ -545,6 +545,11 @@ paths:
               requestBody:
                 content:
                   application/json:
+                    example:
+                      {
+                        "orderId": 3,
+                        "test": 3
+                      }
                     schema:
                       type: object
                       properties: