https://github.com/warrenbuckley/examine-peek

Peek inside the Examine Index for a given content node. An Umbraco package for V14+ (aka Belissima)
https://github.com/warrenbuckley/examine-peek

umbraco umbraco-package umbraco-v14

Last synced: 3 months ago
JSON representation

Peek inside the Examine Index for a given content node. An Umbraco package for V14+ (aka Belissima)

• Host: GitHub
• URL: https://github.com/warrenbuckley/examine-peek
• Owner: warrenbuckley
• License: mit
• Created: 2024-03-06T20:28:16.000Z (11 months ago)
• Default Branch: main
• Last Pushed: 2024-08-20T18:35:19.000Z (5 months ago)
• Last Synced: 2024-09-14T10:10:31.606Z (4 months ago)
• Topics: umbraco, umbraco-package, umbraco-v14
• Language: TypeScript
• Homepage: https://hackmakedo.com
• Size: 387 KB
• Stars: 3
• Watchers: 2
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Examine Peek 



## What is Examine Peek ?

It is a simple package to help view a specific [Umbraco](https://docs.umbraco.com/) content node and see its stored values in the [Umbraco External Examine index](https://docs.umbraco.com/umbraco-cms/reference/searching/examine) and was a good first use case of learning how to build a simple Umbraco package for V14.

![Examine Peek Entity Action in Umbraco V14+](https://raw.githubusercontent.com/warrenbuckley/Examine-Peek/main/.github/ExaminePeek.Screenshot.png)

### Why?

Well if you use Examine and are storing custom fields and values against your content node in the Umbraco External index, you may wish to quickly view and debug what is stored in the Examine index.

This saves you browsing to the Settings -> Examine dashboard and performing a search query to find the exact document you wish to view

### How do I use it?

After installation then all Umbraco content nodes will add a new `Context Action` on the right click of the tree or the actions menu.

### Open API specification

You can view the Open API definition at this URL `https://localhost:44365/umbraco/swagger/ExaminePeek/swagger.json`

Alternatively you can browse the Open API definitions in your Umbraco site, including the `Examine Peek Package API` definition using the Swagger UI by visiting this url `https://localhost:44365/umbraco/swagger`

This allows you to try out the API requests directly in the browser and see the responses, ideal for debugging or consuming the API in an alternative way