@apiwiz/apiwiz-catalog-library 2.0.40 → 2.0.42

package/README.md

@@ -150,8 +150,42 @@ interface ApiwizCatalogProps {
 | `swaggerData`    | `object`              | OAS JSON object (for Catalog)    |
 | `selectedMethod` | `string`              | Selected HTTP method (e.g., "GET")   |
 | `selectedPath`   | `string`              | Selected API endpoint path           |
+| `enableDevTools` | `boolean`             | When `true` in `EXTERNAL` mode, shows a floating panel to switch OAS presets, operations, theme, and left panel |
 | `bottomBar`      | `React.ReactElement \| React.ComponentType` | Bottom bar component to render at the end of center content |
 
+### OpenAPI version support
+
+The catalog supports **OAS 2.0**, **3.0**, and **3.1** specs. Version is detected from the `swagger` / `openapi` field in `swaggerData`. For backend API calls (`DEV_PORTAL`, `CORE_UI`), OAS 3.1 is sent as `oas: 3.0` for compatibility.
+
+### Local testing (`npm run serve`)
+
+Open `/reference` to use the built-in testing harness with a floating **wrench** icon. Use it to switch between:
+
+- **OAS 2.0** — [`src/Samples/petstore-v2.json`](src/Samples/petstore-v2.json) (Enterprise Commerce API)
+- **OAS 3.0** — [`src/Samples/extreme-openapi-3.0.json`](src/Samples/extreme-openapi-3.0.json) (Extreme Enterprise Platform stress-test spec)
+- **OAS 3.1** — [`src/Samples/extreme-openapi-3.1.json`](src/Samples/extreme-openapi-3.1.json) (Extreme Enterprise Platform torture-test spec)
+
+You can also change operations, theme, and left panel layout from the same panel.
+
+### `CatalogDevTools` (optional export)
+
+```jsx
+import { CatalogDevTools, APP_THEME_OPTION } from '@apiwiz/apiwiz-catalog-library';
+
+<CatalogDevTools
+  value={{
+    swaggerData,
+    selectedMethod,
+    selectedPath,
+    appTheme: APP_THEME_OPTION.LIGHT,
+    enableLeftPanel: true,
+  }}
+  onChange={setConfig}
+/>
+```
+
+Or pass `enableDevTools` on `ApiwizCatalog` / `APIReference` in `EXTERNAL` mode to embed the panel automatically.
+
 ---
 
 ## 🧱 Constants