docusaurus-theme-openapi-docs 1.5.0 → 1.5.2

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.
@@ -30,6 +30,8 @@ function colorForMethod(method) {
30
30
  return "warning";
31
31
  case "head":
32
32
  return "secondary";
33
+ case "event":
34
+ return "secondary";
33
35
  default:
34
36
  return undefined;
35
37
  }
@@ -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}
@@ -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
  }
@@ -241,11 +241,11 @@ function SchemaTabsComponent(props) {
241
241
  (tabItem) => tabItem.props.value === defaultValue
242
242
  )[0],
243
243
  {
244
- className: "margin-vert--md",
244
+ className: styles.marginVertical,
245
245
  }
246
246
  )
247
247
  ) : (
248
- <div className="margin-vert--md">
248
+ <div className={styles.marginVertical}>
249
249
  {children.map((tabItem, i) =>
250
250
  cloneElement(tabItem, {
251
251
  key: i,
@@ -103,3 +103,8 @@
103
103
  width: 100%;
104
104
  }
105
105
  }
106
+
107
+ .marginVertical {
108
+ margin-top: 1rem !important;
109
+ margin-bottom: unset !important;
110
+ }
@@ -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);
@@ -77,10 +78,14 @@
77
78
 
78
79
  .theme-api-markdown details li {
79
80
  list-style: none;
80
- padding-bottom: 5px;
81
81
  padding-top: 5px;
82
82
  }
83
83
 
84
+ .theme-api-markdown .tabs__item {
85
+ padding-bottom: unset;
86
+ padding-top: unset;
87
+ }
88
+
84
89
  .theme-api-markdown details > div > div {
85
90
  padding-top: unset !important;
86
91
  border-top: unset !important;
@@ -244,6 +249,8 @@
244
249
  color: var(--ifm-color-success);
245
250
  padding-left: 1.4rem;
246
251
  padding-right: 1.4rem;
252
+ padding-top: 1rem !important;
253
+ padding-bottom: 1rem !important;
247
254
  }
248
255
 
249
256
  .code__tab--python.tabs__item--active {
@@ -268,6 +275,8 @@
268
275
  color: var(--ifm-color-info);
269
276
  padding-left: 1.4rem;
270
277
  padding-right: 1.4rem;
278
+ padding-top: 1rem !important;
279
+ padding-bottom: 1rem !important;
271
280
  }
272
281
 
273
282
  .code__tab--go.tabs__item--active {
@@ -292,6 +301,8 @@
292
301
  color: var(--ifm-color-warning);
293
302
  padding-left: 1.4rem;
294
303
  padding-right: 1.4rem;
304
+ padding-top: 1rem !important;
305
+ padding-bottom: 1rem !important;
295
306
  }
296
307
 
297
308
  .code__tab--javascript.tabs__item--active {
@@ -316,6 +327,8 @@
316
327
  color: var(--ifm-color-danger);
317
328
  padding-left: 1.4rem;
318
329
  padding-right: 1.4rem;
330
+ padding-top: 1rem !important;
331
+ padding-bottom: 1rem !important;
319
332
  }
320
333
 
321
334
  .code__tab--bash.tabs__item--active {
@@ -340,6 +353,8 @@
340
353
  color: var(--ifm-color-danger);
341
354
  padding-left: 1.4rem;
342
355
  padding-right: 1.4rem;
356
+ padding-top: 1rem !important;
357
+ padding-bottom: 1rem !important;
343
358
  }
344
359
 
345
360
  .code__tab--ruby.tabs__item--active {
@@ -364,6 +379,8 @@
364
379
  color: var(--ifm-color-gray-500);
365
380
  padding-left: 1.4rem;
366
381
  padding-right: 1.4rem;
382
+ padding-top: 1rem !important;
383
+ padding-bottom: 1rem !important;
367
384
  }
368
385
 
369
386
  .code__tab--csharp.tabs__item--active {
@@ -388,6 +405,8 @@
388
405
  color: var(--ifm-color-success);
389
406
  padding-left: 1.4rem;
390
407
  padding-right: 1.4rem;
408
+ padding-top: 1rem !important;
409
+ padding-bottom: 1rem !important;
391
410
  }
392
411
 
393
412
  .code__tab--nodejs.tabs__item--active {
@@ -412,6 +431,8 @@
412
431
  color: var(--ifm-color-gray-500);
413
432
  padding-left: 1.4rem;
414
433
  padding-right: 1.4rem;
434
+ padding-top: 1rem !important;
435
+ padding-bottom: 1rem !important;
415
436
  }
416
437
 
417
438
  .code__tab--php.tabs__item--active {
@@ -23,6 +23,8 @@ function colorForMethod(method) {
23
23
  return "warning";
24
24
  case "head":
25
25
  return "secondary";
26
+ case "event":
27
+ return "secondary";
26
28
  default:
27
29
  return undefined;
28
30
  }
@@ -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}
@@ -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
  }
@@ -241,11 +241,11 @@ function SchemaTabsComponent(props) {
241
241
  (tabItem) => tabItem.props.value === defaultValue
242
242
  )[0],
243
243
  {
244
- className: "margin-vert--md",
244
+ className: styles.marginVertical,
245
245
  }
246
246
  )
247
247
  ) : (
248
- <div className="margin-vert--md">
248
+ <div className={styles.marginVertical}>
249
249
  {children.map((tabItem, i) =>
250
250
  cloneElement(tabItem, {
251
251
  key: i,
@@ -103,3 +103,8 @@
103
103
  width: 100%;
104
104
  }
105
105
  }
106
+
107
+ .marginVertical {
108
+ margin-top: 1rem !important;
109
+ margin-bottom: unset !important;
110
+ }
@@ -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);
@@ -77,10 +78,14 @@
77
78
 
78
79
  .theme-api-markdown details li {
79
80
  list-style: none;
80
- padding-bottom: 5px;
81
81
  padding-top: 5px;
82
82
  }
83
83
 
84
+ .theme-api-markdown .tabs__item {
85
+ padding-bottom: unset;
86
+ padding-top: unset;
87
+ }
88
+
84
89
  .theme-api-markdown details > div > div {
85
90
  padding-top: unset !important;
86
91
  border-top: unset !important;
@@ -244,6 +249,8 @@
244
249
  color: var(--ifm-color-success);
245
250
  padding-left: 1.4rem;
246
251
  padding-right: 1.4rem;
252
+ padding-top: 1rem !important;
253
+ padding-bottom: 1rem !important;
247
254
  }
248
255
 
249
256
  .code__tab--python.tabs__item--active {
@@ -268,6 +275,8 @@
268
275
  color: var(--ifm-color-info);
269
276
  padding-left: 1.4rem;
270
277
  padding-right: 1.4rem;
278
+ padding-top: 1rem !important;
279
+ padding-bottom: 1rem !important;
271
280
  }
272
281
 
273
282
  .code__tab--go.tabs__item--active {
@@ -292,6 +301,8 @@
292
301
  color: var(--ifm-color-warning);
293
302
  padding-left: 1.4rem;
294
303
  padding-right: 1.4rem;
304
+ padding-top: 1rem !important;
305
+ padding-bottom: 1rem !important;
295
306
  }
296
307
 
297
308
  .code__tab--javascript.tabs__item--active {
@@ -316,6 +327,8 @@
316
327
  color: var(--ifm-color-danger);
317
328
  padding-left: 1.4rem;
318
329
  padding-right: 1.4rem;
330
+ padding-top: 1rem !important;
331
+ padding-bottom: 1rem !important;
319
332
  }
320
333
 
321
334
  .code__tab--bash.tabs__item--active {
@@ -340,6 +353,8 @@
340
353
  color: var(--ifm-color-danger);
341
354
  padding-left: 1.4rem;
342
355
  padding-right: 1.4rem;
356
+ padding-top: 1rem !important;
357
+ padding-bottom: 1rem !important;
343
358
  }
344
359
 
345
360
  .code__tab--ruby.tabs__item--active {
@@ -364,6 +379,8 @@
364
379
  color: var(--ifm-color-gray-500);
365
380
  padding-left: 1.4rem;
366
381
  padding-right: 1.4rem;
382
+ padding-top: 1rem !important;
383
+ padding-bottom: 1rem !important;
367
384
  }
368
385
 
369
386
  .code__tab--csharp.tabs__item--active {
@@ -388,6 +405,8 @@
388
405
  color: var(--ifm-color-success);
389
406
  padding-left: 1.4rem;
390
407
  padding-right: 1.4rem;
408
+ padding-top: 1rem !important;
409
+ padding-bottom: 1rem !important;
391
410
  }
392
411
 
393
412
  .code__tab--nodejs.tabs__item--active {
@@ -412,6 +431,8 @@
412
431
  color: var(--ifm-color-gray-500);
413
432
  padding-left: 1.4rem;
414
433
  padding-right: 1.4rem;
434
+ padding-top: 1rem !important;
435
+ padding-bottom: 1rem !important;
415
436
  }
416
437
 
417
438
  .code__tab--php.tabs__item--active {
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": "1.5.0",
4
+ "version": "1.5.2",
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": "^1.5.0",
54
+ "docusaurus-plugin-openapi-docs": "^1.5.2",
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": "7ed68875703f5481aaf58f936ce58feea36e6596"
76
+ "gitHead": "fa3096190356c0161a8e255b9950857a7b131eef"
77
77
  }
@@ -25,6 +25,8 @@ function colorForMethod(method: string) {
25
25
  return "warning";
26
26
  case "head":
27
27
  return "secondary";
28
+ case "event":
29
+ return "secondary";
28
30
  default:
29
31
  return undefined;
30
32
  }
@@ -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}
@@ -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
  }
@@ -241,11 +241,11 @@ function SchemaTabsComponent(props) {
241
241
  (tabItem) => tabItem.props.value === defaultValue
242
242
  )[0],
243
243
  {
244
- className: "margin-vert--md",
244
+ className: styles.marginVertical,
245
245
  }
246
246
  )
247
247
  ) : (
248
- <div className="margin-vert--md">
248
+ <div className={styles.marginVertical}>
249
249
  {children.map((tabItem, i) =>
250
250
  cloneElement(tabItem, {
251
251
  key: i,
@@ -103,3 +103,8 @@
103
103
  width: 100%;
104
104
  }
105
105
  }
106
+
107
+ .marginVertical {
108
+ margin-top: 1rem !important;
109
+ margin-bottom: unset !important;
110
+ }
@@ -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);
@@ -77,10 +78,14 @@
77
78
 
78
79
  .theme-api-markdown details li {
79
80
  list-style: none;
80
- padding-bottom: 5px;
81
81
  padding-top: 5px;
82
82
  }
83
83
 
84
+ .theme-api-markdown .tabs__item {
85
+ padding-bottom: unset;
86
+ padding-top: unset;
87
+ }
88
+
84
89
  .theme-api-markdown details > div > div {
85
90
  padding-top: unset !important;
86
91
  border-top: unset !important;
@@ -244,6 +249,8 @@
244
249
  color: var(--ifm-color-success);
245
250
  padding-left: 1.4rem;
246
251
  padding-right: 1.4rem;
252
+ padding-top: 1rem !important;
253
+ padding-bottom: 1rem !important;
247
254
  }
248
255
 
249
256
  .code__tab--python.tabs__item--active {
@@ -268,6 +275,8 @@
268
275
  color: var(--ifm-color-info);
269
276
  padding-left: 1.4rem;
270
277
  padding-right: 1.4rem;
278
+ padding-top: 1rem !important;
279
+ padding-bottom: 1rem !important;
271
280
  }
272
281
 
273
282
  .code__tab--go.tabs__item--active {
@@ -292,6 +301,8 @@
292
301
  color: var(--ifm-color-warning);
293
302
  padding-left: 1.4rem;
294
303
  padding-right: 1.4rem;
304
+ padding-top: 1rem !important;
305
+ padding-bottom: 1rem !important;
295
306
  }
296
307
 
297
308
  .code__tab--javascript.tabs__item--active {
@@ -316,6 +327,8 @@
316
327
  color: var(--ifm-color-danger);
317
328
  padding-left: 1.4rem;
318
329
  padding-right: 1.4rem;
330
+ padding-top: 1rem !important;
331
+ padding-bottom: 1rem !important;
319
332
  }
320
333
 
321
334
  .code__tab--bash.tabs__item--active {
@@ -340,6 +353,8 @@
340
353
  color: var(--ifm-color-danger);
341
354
  padding-left: 1.4rem;
342
355
  padding-right: 1.4rem;
356
+ padding-top: 1rem !important;
357
+ padding-bottom: 1rem !important;
343
358
  }
344
359
 
345
360
  .code__tab--ruby.tabs__item--active {
@@ -364,6 +379,8 @@
364
379
  color: var(--ifm-color-gray-500);
365
380
  padding-left: 1.4rem;
366
381
  padding-right: 1.4rem;
382
+ padding-top: 1rem !important;
383
+ padding-bottom: 1rem !important;
367
384
  }
368
385
 
369
386
  .code__tab--csharp.tabs__item--active {
@@ -388,6 +405,8 @@
388
405
  color: var(--ifm-color-success);
389
406
  padding-left: 1.4rem;
390
407
  padding-right: 1.4rem;
408
+ padding-top: 1rem !important;
409
+ padding-bottom: 1rem !important;
391
410
  }
392
411
 
393
412
  .code__tab--nodejs.tabs__item--active {
@@ -412,6 +431,8 @@
412
431
  color: var(--ifm-color-gray-500);
413
432
  padding-left: 1.4rem;
414
433
  padding-right: 1.4rem;
434
+ padding-top: 1rem !important;
435
+ padding-bottom: 1rem !important;
415
436
  }
416
437
 
417
438
  .code__tab--php.tabs__item--active {