apiuikit 1.5.3 → 1.6.0

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 CHANGED
@@ -74,25 +74,25 @@ export default function App() {
74
74
  Prefer your own layout over the full widget? Render one section on its own by passing it a `document`:
75
75
 
76
76
  ```tsx
77
- import { Operations } from "apiuikit";
77
+ import { AsyncAPIOperations } from "apiuikit";
78
78
  import doc from "./asyncapi.json";
79
79
 
80
80
  export default function OperationsPage() {
81
- return <Operations document={doc} />;
81
+ return <AsyncAPIOperations document={doc} />;
82
82
  }
83
83
  ```
84
84
 
85
- `Servers`, `Operations`, `Messages`, `Schemas`, and `Info` all work this way (OpenAPI equivalents: `OpenAPIServers`, `OpenAPIEndpoints`, `OpenAPISchemas`, `OpenAPIInfo`). To arrange several of them together, wrap them in `AsyncAPIProvider` (or `OpenAPIProvider`) instead so the document is resolved once and shared:
85
+ `AsyncAPIServers`, `AsyncAPIOperations`, `AsyncAPIMessages`, `AsyncAPISchemas`, and `AsyncAPIInfo` all work this way (OpenAPI equivalents: `OpenAPIServers`, `OpenAPIEndpoints`, `OpenAPISchemas`, `OpenAPIInfo`). To arrange several of them together, wrap them in `AsyncAPIProvider` (or `OpenAPIProvider`) instead so the document is resolved once and shared:
86
86
 
87
87
  ```tsx
88
- import { AsyncAPIProvider, Servers, Operations, Schemas } from "apiuikit";
88
+ import { AsyncAPIProvider, AsyncAPIServers, AsyncAPIOperations, AsyncAPISchemas } from "apiuikit";
89
89
 
90
90
  export default function CustomLayout() {
91
91
  return (
92
92
  <AsyncAPIProvider document={doc}>
93
- <Servers />
94
- <Operations />
95
- <Schemas />
93
+ <AsyncAPIServers />
94
+ <AsyncAPIOperations />
95
+ <AsyncAPISchemas />
96
96
  </AsyncAPIProvider>
97
97
  );
98
98
  }
@@ -102,7 +102,7 @@ See the full usage docs for props, configuration options, and more:
102
102
 
103
103
  - [Without Parser](./docs/usage/no-parser.md) (`AsyncAPI` component)
104
104
  - [With Parser](./docs/usage/with-parser.md) (`AsyncAPIRenderer` component, `parseAndRender` utility)
105
- - [Composable Sections](./docs/usage/sections.md) (`Servers`, `Operations`, `Messages`, `Schemas`, `Info`, `AsyncAPIProvider`)
105
+ - [Composable Sections](./docs/usage/sections.md) (`AsyncAPIServers`, `AsyncAPIOperations`, `AsyncAPIMessages`, `AsyncAPISchemas`, `AsyncAPIInfo`, `AsyncAPIProvider`)
106
106
  - [Configuration](./docs/configuration/config.md) (`ConfigInterface`: theme, show flags, sidebar, sidePanel, etc.)
107
107
  - [Web Components](./docs/usage/with-webcomponents.md) (`<apiuikit-asyncapi>`, `<apiuikit-asyncapi-renderer>`, use apiuikit from any framework)
108
108
  - [Markdown export](./docs/usage/markdown-export.md) (making your docs AI-readable: `config.markdown.url`, `documentToMarkdown`, `documentToLlmsTxt`)