@apiwiz/apiwiz-catalog-library 1.0.40 → 1.0.41
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.
- package/README.md +5 -5
- package/build/index.css.map +1 -1
- package/build/index.esm.css.map +1 -1
- package/build/index.esm.js +12 -12
- package/build/index.js +12 -12
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
# 📘 Apiwiz Catalog Library
|
|
2
2
|
|
|
3
3
|
**A React component to render API documentation**
|
|
4
|
-
Supports rendering
|
|
4
|
+
Supports rendering OAS (OpenAPI) or Guide documentation dynamically based on the provided configuration.
|
|
5
5
|
|
|
6
6
|
---
|
|
7
7
|
|
|
8
8
|
## ✨ Features
|
|
9
9
|
|
|
10
|
-
- Switch between **Catalog (
|
|
10
|
+
- Switch between **Catalog (OAS)** and **Guide** view.
|
|
11
11
|
- Supports different **module types** (Core UI, Dev Portal, etc.).
|
|
12
12
|
- Fully themeable with **Light** and **Dark** modes.
|
|
13
13
|
- Simple integration with customizable layout.
|
|
@@ -144,7 +144,7 @@ interface ApiwizCatalogProps {
|
|
|
144
144
|
| Prop | Type | Description |
|
|
145
145
|
|------------------|-----------------------|--------------------------------------|
|
|
146
146
|
| `layoutStyles` | `React.CSSProperties` | Custom inline styles for the layout |
|
|
147
|
-
| `swaggerData` | `object` |
|
|
147
|
+
| `swaggerData` | `object` | OAS JSON object (for Catalog) |
|
|
148
148
|
| `selectedMethod` | `string` | Selected HTTP method (e.g., "GET") |
|
|
149
149
|
| `selectedPath` | `string` | Selected API endpoint path |
|
|
150
150
|
|
|
@@ -176,10 +176,10 @@ export const COMPONENT_TYPE = {
|
|
|
176
176
|
|
|
177
177
|
### `SCREENSHOTS`
|
|
178
178
|
|
|
179
|
-
|
|
180
180
|
|
|
181
181
|
|
|
182
|
-
|
|
183
183
|
|
|
184
184
|
## 📄 License
|
|
185
185
|
|