docusaurus-theme-openapi-docs 0.0.0-538 → 0.0.0-542

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 (10) hide show
  1. package/lib/theme/SchemaItem/index.js +16 -3
  2. package/lib/theme/SchemaItem/styles.module.css +5 -0
  3. package/lib/theme/styles.css +1 -0
  4. package/lib-next/theme/SchemaItem/index.js +16 -3
  5. package/lib-next/theme/SchemaItem/styles.module.css +5 -0
  6. package/lib-next/theme/styles.css +1 -0
  7. package/package.json +3 -3
  8. package/src/theme/SchemaItem/index.js +16 -3
  9. package/src/theme/SchemaItem/styles.module.css +5 -0
  10. package/src/theme/styles.css +1 -0
package/lib/theme/SchemaItem/index.js CHANGED
@@ -23,11 +23,19 @@ function SchemaItem({
23
23
  name,
24
24
  qualifierMessage,
25
25
  required,
26
- deprecated,
27
- schemaDescription,
28
26
  schemaName,
29
- defaultValue,
27
+ schema,
30
28
  }) {
29
+ let deprecated;
30
+ let schemaDescription;
31
+ let defaultValue;
32
+ let nullable;
33
+ if (schema) {
34
+ deprecated = schema.deprecated;
35
+ schemaDescription = schema.description;
36
+ defaultValue = schema.default;
37
+ nullable = schema.nullable;
38
+ }
31
39
  const renderRequired = guard(
32
40
  Array.isArray(required) ? required.includes(name) : required,
33
41
  () => <strong className={styles.required}> required</strong>
@@ -37,6 +45,10 @@ function SchemaItem({
37
45
  <strong className={styles.deprecated}> deprecated</strong>
38
46
  ));
39
47
 
48
+ const renderNullable = guard(nullable, () => (
49
+ <strong className={styles.nullable}> nullable</strong>
50
+ ));
51
+
40
52
  const renderSchemaDescription = guard(schemaDescription, (description) => (
41
53
  <div>
42
54
  <ReactMarkdown
@@ -80,6 +92,7 @@ function SchemaItem({
80
92
  <div>
81
93
  <strong className={deprecated && styles.strikethrough}>{name}</strong>
82
94
  <span className={styles.schemaName}> {schemaName}</span>
95
+ {renderNullable}
83
96
  {!deprecated && renderRequired}
84
97
  {renderDeprecated}
85
98
  {renderQualifierMessage}
package/lib/theme/SchemaItem/styles.module.css CHANGED
@@ -28,6 +28,11 @@
28
28
  color: var(--openapi-deprecated);
29
29
  }
30
30
 
31
+ .nullable {
32
+ font-size: var(--ifm-code-font-size);
33
+ color: var(--openapi-nullable);
34
+ }
35
+
31
36
  .strikethrough {
32
37
  text-decoration: line-through;
33
38
  }
package/lib/theme/styles.css CHANGED
@@ -8,6 +8,7 @@
8
8
  :root {
9
9
  --openapi-required: var(--ifm-color-danger);
10
10
  --openapi-deprecated: var(--ifm-color-warning);
11
+ --openapi-nullable: var(--ifm-color-info);
11
12
  --openapi-code-blue: var(--ifm-color-info);
12
13
  --openapi-code-red: var(--ifm-color-danger);
13
14
  --openapi-code-orange: var(--ifm-color-warning);
package/lib-next/theme/SchemaItem/index.js CHANGED
@@ -23,11 +23,19 @@ function SchemaItem({
23
23
  name,
24
24
  qualifierMessage,
25
25
  required,
26
- deprecated,
27
- schemaDescription,
28
26
  schemaName,
29
- defaultValue,
27
+ schema,
30
28
  }) {
29
+ let deprecated;
30
+ let schemaDescription;
31
+ let defaultValue;
32
+ let nullable;
33
+ if (schema) {
34
+ deprecated = schema.deprecated;
35
+ schemaDescription = schema.description;
36
+ defaultValue = schema.default;
37
+ nullable = schema.nullable;
38
+ }
31
39
  const renderRequired = guard(
32
40
  Array.isArray(required) ? required.includes(name) : required,
33
41
  () => <strong className={styles.required}> required</strong>
@@ -37,6 +45,10 @@ function SchemaItem({
37
45
  <strong className={styles.deprecated}> deprecated</strong>
38
46
  ));
39
47
 
48
+ const renderNullable = guard(nullable, () => (
49
+ <strong className={styles.nullable}> nullable</strong>
50
+ ));
51
+
40
52
  const renderSchemaDescription = guard(schemaDescription, (description) => (
41
53
  <div>
42
54
  <ReactMarkdown
@@ -80,6 +92,7 @@ function SchemaItem({
80
92
  <div>
81
93
  <strong className={deprecated && styles.strikethrough}>{name}</strong>
82
94
  <span className={styles.schemaName}> {schemaName}</span>
95
+ {renderNullable}
83
96
  {!deprecated && renderRequired}
84
97
  {renderDeprecated}
85
98
  {renderQualifierMessage}
package/lib-next/theme/SchemaItem/styles.module.css CHANGED
@@ -28,6 +28,11 @@
28
28
  color: var(--openapi-deprecated);
29
29
  }
30
30
 
31
+ .nullable {
32
+ font-size: var(--ifm-code-font-size);
33
+ color: var(--openapi-nullable);
34
+ }
35
+
31
36
  .strikethrough {
32
37
  text-decoration: line-through;
33
38
  }
package/lib-next/theme/styles.css CHANGED
@@ -8,6 +8,7 @@
8
8
  :root {
9
9
  --openapi-required: var(--ifm-color-danger);
10
10
  --openapi-deprecated: var(--ifm-color-warning);
11
+ --openapi-nullable: var(--ifm-color-info);
11
12
  --openapi-code-blue: var(--ifm-color-info);
12
13
  --openapi-code-red: var(--ifm-color-danger);
13
14
  --openapi-code-orange: var(--ifm-color-warning);
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "docusaurus-theme-openapi-docs",
3
3
  "description": "OpenAPI theme for Docusaurus.",
4
- "version": "0.0.0-538",
4
+ "version": "0.0.0-542",
5
5
  "license": "MIT",
6
6
  "keywords": [
7
7
  "openapi",
@@ -51,7 +51,7 @@
51
51
  "buffer": "^6.0.3",
52
52
  "clsx": "^1.1.1",
53
53
  "crypto-js": "^4.1.1",
54
- "docusaurus-plugin-openapi-docs": "0.0.0-538",
54
+ "docusaurus-plugin-openapi-docs": "0.0.0-542",
55
55
  "file-saver": "^2.0.5",
56
56
  "immer": "^9.0.7",
57
57
  "lodash": "^4.17.20",
@@ -73,5 +73,5 @@
73
73
  "engines": {
74
74
  "node": ">=14"
75
75
  },
76
- "gitHead": "b41efd36cc98bda143d56af606dc71781999cabd"
76
+ "gitHead": "f8f22a69b03f070a5952c504156bd668edf9be34"
77
77
  }
package/src/theme/SchemaItem/index.js CHANGED
@@ -23,11 +23,19 @@ function SchemaItem({
23
23
  name,
24
24
  qualifierMessage,
25
25
  required,
26
- deprecated,
27
- schemaDescription,
28
26
  schemaName,
29
- defaultValue,
27
+ schema,
30
28
  }) {
29
+ let deprecated;
30
+ let schemaDescription;
31
+ let defaultValue;
32
+ let nullable;
33
+ if (schema) {
34
+ deprecated = schema.deprecated;
35
+ schemaDescription = schema.description;
36
+ defaultValue = schema.default;
37
+ nullable = schema.nullable;
38
+ }
31
39
  const renderRequired = guard(
32
40
  Array.isArray(required) ? required.includes(name) : required,
33
41
  () => <strong className={styles.required}> required</strong>
@@ -37,6 +45,10 @@ function SchemaItem({
37
45
  <strong className={styles.deprecated}> deprecated</strong>
38
46
  ));
39
47
 
48
+ const renderNullable = guard(nullable, () => (
49
+ <strong className={styles.nullable}> nullable</strong>
50
+ ));
51
+
40
52
  const renderSchemaDescription = guard(schemaDescription, (description) => (
41
53
  <div>
42
54
  <ReactMarkdown
@@ -80,6 +92,7 @@ function SchemaItem({
80
92
  <div>
81
93
  <strong className={deprecated && styles.strikethrough}>{name}</strong>
82
94
  <span className={styles.schemaName}> {schemaName}</span>
95
+ {renderNullable}
83
96
  {!deprecated && renderRequired}
84
97
  {renderDeprecated}
85
98
  {renderQualifierMessage}
package/src/theme/SchemaItem/styles.module.css CHANGED
@@ -28,6 +28,11 @@
28
28
  color: var(--openapi-deprecated);
29
29
  }
30
30
 
31
+ .nullable {
32
+ font-size: var(--ifm-code-font-size);
33
+ color: var(--openapi-nullable);
34
+ }
35
+
31
36
  .strikethrough {
32
37
  text-decoration: line-through;
33
38
  }
package/src/theme/styles.css CHANGED
@@ -8,6 +8,7 @@
8
8
  :root {
9
9
  --openapi-required: var(--ifm-color-danger);
10
10
  --openapi-deprecated: var(--ifm-color-warning);
11
+ --openapi-nullable: var(--ifm-color-info);
11
12
  --openapi-code-blue: var(--ifm-color-info);
12
13
  --openapi-code-red: var(--ifm-color-danger);
13
14
  --openapi-code-orange: var(--ifm-color-warning);