docusaurus-theme-openapi-docs 0.0.0-529 → 0.0.0-530

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.
@@ -23,6 +23,7 @@ function SchemaItem({
23
23
  name,
24
24
  qualifierMessage,
25
25
  required,
26
+ deprecated,
26
27
  schemaDescription,
27
28
  schemaName,
28
29
  defaultValue,
@@ -32,6 +33,10 @@ function SchemaItem({
32
33
  () => <strong className={styles.required}> required</strong>
33
34
  );
34
35
 
36
+ const renderDeprecated = guard(deprecated, () => (
37
+ <strong className={styles.deprecated}> deprecated</strong>
38
+ ));
39
+
35
40
  const renderSchemaDescription = guard(schemaDescription, (description) => (
36
41
  <div>
37
42
  <ReactMarkdown
@@ -73,9 +78,10 @@ function SchemaItem({
73
78
 
74
79
  const schemaContent = (
75
80
  <div>
76
- <strong>{name}</strong>
81
+ <strong className={deprecated && styles.strikethrough}>{name}</strong>
77
82
  <span className={styles.schemaName}> {schemaName}</span>
78
- {renderRequired}
83
+ {!deprecated && renderRequired}
84
+ {renderDeprecated}
79
85
  {renderQualifierMessage}
80
86
  {renderDefaultValue}
81
87
  {renderSchemaDescription}
@@ -22,3 +22,12 @@
22
22
  font-size: var(--ifm-code-font-size);
23
23
  color: var(--openapi-required);
24
24
  }
25
+
26
+ .deprecated {
27
+ font-size: var(--ifm-code-font-size);
28
+ color: var(--openapi-deprecated);
29
+ }
30
+
31
+ .strikethrough {
32
+ text-decoration: line-through;
33
+ }
@@ -7,6 +7,7 @@
7
7
 
8
8
  :root {
9
9
  --openapi-required: var(--ifm-color-danger);
10
+ --openapi-deprecated: var(--ifm-color-warning);
10
11
  --openapi-code-blue: var(--ifm-color-info);
11
12
  --openapi-code-red: var(--ifm-color-danger);
12
13
  --openapi-code-orange: var(--ifm-color-warning);
@@ -23,6 +23,7 @@ function SchemaItem({
23
23
  name,
24
24
  qualifierMessage,
25
25
  required,
26
+ deprecated,
26
27
  schemaDescription,
27
28
  schemaName,
28
29
  defaultValue,
@@ -32,6 +33,10 @@ function SchemaItem({
32
33
  () => <strong className={styles.required}> required</strong>
33
34
  );
34
35
 
36
+ const renderDeprecated = guard(deprecated, () => (
37
+ <strong className={styles.deprecated}> deprecated</strong>
38
+ ));
39
+
35
40
  const renderSchemaDescription = guard(schemaDescription, (description) => (
36
41
  <div>
37
42
  <ReactMarkdown
@@ -73,9 +78,10 @@ function SchemaItem({
73
78
 
74
79
  const schemaContent = (
75
80
  <div>
76
- <strong>{name}</strong>
81
+ <strong className={deprecated && styles.strikethrough}>{name}</strong>
77
82
  <span className={styles.schemaName}> {schemaName}</span>
78
- {renderRequired}
83
+ {!deprecated && renderRequired}
84
+ {renderDeprecated}
79
85
  {renderQualifierMessage}
80
86
  {renderDefaultValue}
81
87
  {renderSchemaDescription}
@@ -22,3 +22,12 @@
22
22
  font-size: var(--ifm-code-font-size);
23
23
  color: var(--openapi-required);
24
24
  }
25
+
26
+ .deprecated {
27
+ font-size: var(--ifm-code-font-size);
28
+ color: var(--openapi-deprecated);
29
+ }
30
+
31
+ .strikethrough {
32
+ text-decoration: line-through;
33
+ }
@@ -7,6 +7,7 @@
7
7
 
8
8
  :root {
9
9
  --openapi-required: var(--ifm-color-danger);
10
+ --openapi-deprecated: var(--ifm-color-warning);
10
11
  --openapi-code-blue: var(--ifm-color-info);
11
12
  --openapi-code-red: var(--ifm-color-danger);
12
13
  --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-529",
4
+ "version": "0.0.0-530",
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-529",
54
+ "docusaurus-plugin-openapi-docs": "0.0.0-530",
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": "f5fc59449765c07686f86df742256acdd2eccb44"
76
+ "gitHead": "a31ab6ddf963c070ad5bcb15edaa6ef50e6cd3b7"
77
77
  }
@@ -23,6 +23,7 @@ function SchemaItem({
23
23
  name,
24
24
  qualifierMessage,
25
25
  required,
26
+ deprecated,
26
27
  schemaDescription,
27
28
  schemaName,
28
29
  defaultValue,
@@ -32,6 +33,10 @@ function SchemaItem({
32
33
  () => <strong className={styles.required}> required</strong>
33
34
  );
34
35
 
36
+ const renderDeprecated = guard(deprecated, () => (
37
+ <strong className={styles.deprecated}> deprecated</strong>
38
+ ));
39
+
35
40
  const renderSchemaDescription = guard(schemaDescription, (description) => (
36
41
  <div>
37
42
  <ReactMarkdown
@@ -73,9 +78,10 @@ function SchemaItem({
73
78
 
74
79
  const schemaContent = (
75
80
  <div>
76
- <strong>{name}</strong>
81
+ <strong className={deprecated && styles.strikethrough}>{name}</strong>
77
82
  <span className={styles.schemaName}> {schemaName}</span>
78
- {renderRequired}
83
+ {!deprecated && renderRequired}
84
+ {renderDeprecated}
79
85
  {renderQualifierMessage}
80
86
  {renderDefaultValue}
81
87
  {renderSchemaDescription}
@@ -22,3 +22,12 @@
22
22
  font-size: var(--ifm-code-font-size);
23
23
  color: var(--openapi-required);
24
24
  }
25
+
26
+ .deprecated {
27
+ font-size: var(--ifm-code-font-size);
28
+ color: var(--openapi-deprecated);
29
+ }
30
+
31
+ .strikethrough {
32
+ text-decoration: line-through;
33
+ }
@@ -7,6 +7,7 @@
7
7
 
8
8
  :root {
9
9
  --openapi-required: var(--ifm-color-danger);
10
+ --openapi-deprecated: var(--ifm-color-warning);
10
11
  --openapi-code-blue: var(--ifm-color-info);
11
12
  --openapi-code-red: var(--ifm-color-danger);
12
13
  --openapi-code-orange: var(--ifm-color-warning);