docusaurus-plugin-openapi-docs 4.3.4 → 4.3.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. package/lib/markdown/schema.js +6 -6
  2. package/lib/markdown/schema.test.js +10 -0
  3. package/package.json +2 -2
  4. package/src/markdown/schema.test.ts +12 -0
  5. package/src/markdown/schema.ts +6 -6
package/lib/markdown/schema.js CHANGED
@@ -93,8 +93,8 @@ function getQualifierMessage(schema) {
93
93
  }
94
94
  qualifierGroups.push(lengthQualifier);
95
95
  }
96
- if (schema.minimum ||
97
- schema.maximum ||
96
+ if (schema.minimum != null ||
97
+ schema.maximum != null ||
98
98
  typeof schema.exclusiveMinimum === "number" ||
99
99
  typeof schema.exclusiveMaximum === "number") {
100
100
  let minmaxQualifier = "";
@@ -103,19 +103,19 @@ function getQualifierMessage(schema) {
103
103
  if (typeof schema.exclusiveMinimum === "number") {
104
104
  minimum = `\`> ${schema.exclusiveMinimum}\``;
105
105
  }
106
- else if (schema.minimum && !schema.exclusiveMinimum) {
106
+ else if (schema.minimum != null && !schema.exclusiveMinimum) {
107
107
  minimum = `\`>= ${schema.minimum}\``;
108
108
  }
109
- else if (schema.minimum && schema.exclusiveMinimum === true) {
109
+ else if (schema.minimum != null && schema.exclusiveMinimum === true) {
110
110
  minimum = `\`> ${schema.minimum}\``;
111
111
  }
112
112
  if (typeof schema.exclusiveMaximum === "number") {
113
113
  maximum = `\`< ${schema.exclusiveMaximum}\``;
114
114
  }
115
- else if (schema.maximum && !schema.exclusiveMaximum) {
115
+ else if (schema.maximum != null && !schema.exclusiveMaximum) {
116
116
  maximum = `\`<= ${schema.maximum}\``;
117
117
  }
118
- else if (schema.maximum && schema.exclusiveMaximum === true) {
118
+ else if (schema.maximum != null && schema.exclusiveMaximum === true) {
119
119
  maximum = `\`< ${schema.maximum}\``;
120
120
  }
121
121
  if (minimum && !maximum) {
package/lib/markdown/schema.test.js CHANGED
@@ -106,6 +106,16 @@ describe("getQualifierMessage", () => {
106
106
  const actual = (0, schema_1.getQualifierMessage)({ minimum: 1, maximum: 40 });
107
107
  expect(actual).toBe(expected);
108
108
  });
109
+ it("should render 0 minimum and maximum", () => {
110
+ const expected = "**Possible values:** `>= 0` and `<= 40`";
111
+ const actual = (0, schema_1.getQualifierMessage)({ minimum: 0, maximum: 40 });
112
+ expect(actual).toBe(expected);
113
+ });
114
+ it("should render minimum and 0 maximum", () => {
115
+ const expected = "**Possible values:** `>= -10` and `<= 0`";
116
+ const actual = (0, schema_1.getQualifierMessage)({ minimum: -10, maximum: 0 });
117
+ expect(actual).toBe(expected);
118
+ });
109
119
  it("should render boolean exclusiveMinimum and maximum", () => {
110
120
  const expected = "**Possible values:** `> 1` and `<= 40`";
111
121
  const actual = (0, schema_1.getQualifierMessage)({
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "docusaurus-plugin-openapi-docs",
3
3
  "description": "OpenAPI plugin for Docusaurus.",
4
- "version": "4.3.4",
4
+ "version": "4.3.5",
5
5
  "license": "MIT",
6
6
  "keywords": [
7
7
  "openapi",
@@ -65,5 +65,5 @@
65
65
  "engines": {
66
66
  "node": ">=14"
67
67
  },
68
- "gitHead": "2c732880a5508e292c49b83cbc01f6030aef4dfe"
68
+ "gitHead": "6b5c10430f8ae45faff3a01ca13b485a77d0742a"
69
69
  }
package/src/markdown/schema.test.ts CHANGED
@@ -124,6 +124,18 @@ describe("getQualifierMessage", () => {
124
124
  expect(actual).toBe(expected);
125
125
  });
126
126
 
127
+ it("should render 0 minimum and maximum", () => {
128
+ const expected = "**Possible values:** `>= 0` and `<= 40`";
129
+ const actual = getQualifierMessage({ minimum: 0, maximum: 40 });
130
+ expect(actual).toBe(expected);
131
+ });
132
+
133
+ it("should render minimum and 0 maximum", () => {
134
+ const expected = "**Possible values:** `>= -10` and `<= 0`";
135
+ const actual = getQualifierMessage({ minimum: -10, maximum: 0 });
136
+ expect(actual).toBe(expected);
137
+ });
138
+
127
139
  it("should render boolean exclusiveMinimum and maximum", () => {
128
140
  const expected = "**Possible values:** `> 1` and `<= 40`";
129
141
  const actual = getQualifierMessage({
package/src/markdown/schema.ts CHANGED
@@ -116,8 +116,8 @@ export function getQualifierMessage(schema?: SchemaObject): string | undefined {
116
116
  }
117
117
 
118
118
  if (
119
- schema.minimum ||
120
- schema.maximum ||
119
+ schema.minimum != null ||
120
+ schema.maximum != null ||
121
121
  typeof schema.exclusiveMinimum === "number" ||
122
122
  typeof schema.exclusiveMaximum === "number"
123
123
  ) {
@@ -126,16 +126,16 @@ export function getQualifierMessage(schema?: SchemaObject): string | undefined {
126
126
  let maximum;
127
127
  if (typeof schema.exclusiveMinimum === "number") {
128
128
  minimum = `\`> ${schema.exclusiveMinimum}\``;
129
- } else if (schema.minimum && !schema.exclusiveMinimum) {
129
+ } else if (schema.minimum != null && !schema.exclusiveMinimum) {
130
130
  minimum = `\`>= ${schema.minimum}\``;
131
- } else if (schema.minimum && schema.exclusiveMinimum === true) {
131
+ } else if (schema.minimum != null && schema.exclusiveMinimum === true) {
132
132
  minimum = `\`> ${schema.minimum}\``;
133
133
  }
134
134
  if (typeof schema.exclusiveMaximum === "number") {
135
135
  maximum = `\`< ${schema.exclusiveMaximum}\``;
136
- } else if (schema.maximum && !schema.exclusiveMaximum) {
136
+ } else if (schema.maximum != null && !schema.exclusiveMaximum) {
137
137
  maximum = `\`<= ${schema.maximum}\``;
138
- } else if (schema.maximum && schema.exclusiveMaximum === true) {
138
+ } else if (schema.maximum != null && schema.exclusiveMaximum === true) {
139
139
  maximum = `\`< ${schema.maximum}\``;
140
140
  }
141
141