Object Example

The Object Example widget in Theneo's web editor is a versatile tool that enhances the documentation of API objects. It provides a structured and interactive way to present and explain the different components of an API object. Here's how you can use this widget effectively:

Adding an Object Example

1. Position your cursor where you want to insert the object example in your documentation.
2. Type /object example to bring up the widget menu and select the Object Example widget.
3. A new tab will be created where you can define your object example.

Working with Object Examples

• Code View: This view allows you to input raw JSON or other supported formats directly. The editor will parse and display the data in an organized and readable format.
• Form View: Here, you can add more detailed information about each field of your object, such as whether the field is required, provide descriptions, and set additional properties like minimum or maximum values.

Managing Multiple Object Examples

• You can create multiple tabs for different object examples as needed, allowing you to document various objects within the same context.
• Switch between tabs to manage or view different examples.

Supported Languages

The Object Example widget supports the same languages as the code block highlight feature, providing consistency in how code and objects are presented throughout your documentation.

Extended Use Case

This widget is just another way Theneo empowers you to create comprehensive and user-friendly documentation, making complex API objects understandable at a glance.