oas 19.0.2 → 19.0.3

package/CHANGELOG.md

@@ -1,3 +1,9 @@
+## <small>19.0.3 (2022-10-27)</small>
+
+* fix: various compatibility issues with `api` codegen (#700) ([01a6554](https://github.com/readmeio/oas/commit/01a6554)), closes [#700](https://github.com/readmeio/oas/issues/700)
+
+
+
 ## <small>19.0.2 (2022-10-26)</small>
 
 * fix: quirks with discriminators and the `transformer` JSON Schema option (#698) ([b84c57f](https://github.com/readmeio/oas/commit/b84c57f)), closes [#698](https://github.com/readmeio/oas/issues/698)

package/dist/index.js

@@ -636,6 +636,10 @@ var Oas = /** @class */ (function () {
          */
         var paths = {};
         Object.keys(this.api.paths ? this.api.paths : []).forEach(function (path) {
+            // If this is a specification extension then we should ignore it.
+            if (path.startsWith('x-')) {
+                return;
+            }
             paths[path] = {};
             // Though this library is generally unaware of `$ref` pointers we're making a singular
             // exception with this accessor out of convenience.

package/dist/operation/get-parameters-as-json-schema.js

@@ -288,7 +288,9 @@ function getParametersAsJSONSchema(operation, api, opts) {
                 // Parameter descriptions don't exist in `current.schema` so `constructSchema` will never
                 // have access to it.
                 if (current.description) {
-                    schema.description = current.description;
+                    if (!(0, openapi_to_json_schema_1.isPrimitive)(schema)) {
+                        schema.description = current.description;
+                    }
                 }
                 prev[current.name] = schema;
                 if (current.required) {

package/dist/operation.js

@@ -325,16 +325,22 @@ var Operation = /** @class */ (function () {
             if (this.hasOperationId()) {
                 operationId = sanitize(operationId);
             }
+            // Never start with a number.
+            operationId = operationId.replace(/^[0-9]/g, function (match) { return "_".concat(match); });
+            // Ensure that the first character of an `operationId` is always lowercase.
+            operationId = operationId.charAt(0).toLowerCase() + operationId.slice(1);
             // If the generated `operationId` already starts with the method (eg. `getPets`) we don't want
             // to double it up into `getGetPets`.
             if (operationId.startsWith(method)) {
                 return operationId;
             }
-            // If this operation already has an operationId and we just cleaned it up then we shouldn't
+            // If this operation already has an `operationId` and we just cleaned it up then we shouldn't
             // prefix it with an HTTP method.
             if (this.hasOperationId()) {
                 return operationId;
             }
+            // Because we're merging the `operationId` into an HTTP method we need to reset the first
+            // character of it back to lowercase so end up with `getBuster`, not `getbuster`.
             operationId = operationId.charAt(0).toUpperCase() + operationId.slice(1);
             return "".concat(method).concat(operationId);
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "oas",
-  "version": "19.0.2",
+  "version": "19.0.3",
   "description": "Working with OpenAPI definitions is hard. This makes it easier.",
   "license": "MIT",
   "author": "ReadMe <support@readme.io> (https://readme.com)",

package/src/index.ts

@@ -670,6 +670,11 @@ export default class Oas {
     const paths: Record<string, Record<RMOAS.HttpMethods, Operation | Webhook>> = {};
 
     Object.keys(this.api.paths ? this.api.paths : []).forEach(path => {
+      // If this is a specification extension then we should ignore it.
+      if (path.startsWith('x-')) {
+        return;
+      }
+
       paths[path] = {} as Record<RMOAS.HttpMethods, Operation | Webhook>;
 
       // Though this library is generally unaware of `$ref` pointers we're making a singular

package/src/operation/get-parameters-as-json-schema.ts

@@ -310,7 +310,9 @@ export default function getParametersAsJSONSchema(
           // Parameter descriptions don't exist in `current.schema` so `constructSchema` will never
           // have access to it.
           if (current.description) {
-            schema.description = current.description;
+            if (!isPrimitive(schema)) {
+              schema.description = current.description;
+            }
           }
 
           prev[current.name] = schema;

package/src/operation.ts

@@ -360,18 +360,26 @@ export default class Operation {
         operationId = sanitize(operationId);
       }
 
+      // Never start with a number.
+      operationId = operationId.replace(/^[0-9]/g, match => `_${match}`);
+
+      // Ensure that the first character of an `operationId` is always lowercase.
+      operationId = operationId.charAt(0).toLowerCase() + operationId.slice(1);
+
       // If the generated `operationId` already starts with the method (eg. `getPets`) we don't want
       // to double it up into `getGetPets`.
       if (operationId.startsWith(method)) {
         return operationId;
       }
 
-      // If this operation already has an operationId and we just cleaned it up then we shouldn't
+      // If this operation already has an `operationId` and we just cleaned it up then we shouldn't
       // prefix it with an HTTP method.
       if (this.hasOperationId()) {
         return operationId;
       }
 
+      // Because we're merging the `operationId` into an HTTP method we need to reset the first
+      // character of it back to lowercase so end up with `getBuster`, not `getbuster`.
       operationId = operationId.charAt(0).toUpperCase() + operationId.slice(1);
       return `${method}${operationId}`;
     } else if (this.hasOperationId()) {