Skip to content

Fix stale generated REST API docs and add event-gateway doc generation #3174

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
renuka-fernando merged 3 commits into from
Aug 7, 2026
Merged

Fix stale generated REST API docs and add event-gateway doc generation #3174

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
31b5c11
Fix stale generated REST API docs and add event-gateway doc generation
ashera96 Aug 7, 2026
ec55da3
Use a unique temp file in the event-gateway apidocs target
ashera96 Aug 7, 2026
3a281fd
Quote tool and output paths in the event-gateway apidocs target
ashera96 Aug 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 45 additions & 0 deletions docs/rest-apis/event-gateway/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@

<h1 id="event-gateway-controller-management-api">Event Gateway Controller Management API v1.0.0</h1>

REST API for managing WebSub and WebBroker API configurations in the
WSO2 API Platform event-gateway-controller.

Base URLs:
* <a href="https://localhost:9090/api/management/v1">https://localhost:9090/api/management/v1</a>
* <a href="https://event-gateway-controller:9090/api/management/v1">https://event-gateway-controller:9090/api/management/v1</a>

## Table of Contents

### [Authentication](authentication.md)

### [WebSub API Management](websub-api-management.md)

- [Create a new WebSubAPI](websub-api-management.md#create-a-new-websubapi)
- [List all WebSubAPIs](websub-api-management.md#list-all-websubapis)
- [Create a new API key for a WebSub API](websub-api-management.md#create-a-new-api-key-for-a-websub-api)
- [Get the list of API keys for a WebSub API](websub-api-management.md#get-the-list-of-api-keys-for-a-websub-api)
- [Regenerate API key for a WebSub API](websub-api-management.md#regenerate-api-key-for-a-websub-api)
- [Update an API key for a WebSub API](websub-api-management.md#update-an-api-key-for-a-websub-api)
- [Revoke an API key for a WebSub API](websub-api-management.md#revoke-an-api-key-for-a-websub-api)
- [Generate a new HMAC secret for a WebSub API](websub-api-management.md#generate-a-new-hmac-secret-for-a-websub-api)
- [List HMAC secrets for a WebSub API](websub-api-management.md#list-hmac-secrets-for-a-websub-api)
- [Regenerate (rotate) a WebSub API HMAC secret](websub-api-management.md#regenerate-rotate-a-websub-api-hmac-secret)
- [Delete a WebSub API HMAC secret](websub-api-management.md#delete-a-websub-api-hmac-secret)
- [Get WebSubAPI by id](websub-api-management.md#get-websubapi-by-id)
- [Update an existing WebSubAPI](websub-api-management.md#update-an-existing-websubapi)
- [Delete a WebSubAPI](websub-api-management.md#delete-a-websubapi)

### [WebBroker API Management](webbroker-api-management.md)

- [Create a new WebBrokerAPI](webbroker-api-management.md#create-a-new-webbrokerapi)
- [List all WebBrokerAPIs](webbroker-api-management.md#list-all-webbrokerapis)
- [Get WebBrokerAPI by id](webbroker-api-management.md#get-webbrokerapi-by-id)
- [Delete a WebBrokerAPI](webbroker-api-management.md#delete-a-webbrokerapi)
- [Create a new API key for a WebBroker API](webbroker-api-management.md#create-a-new-api-key-for-a-webbroker-api)
- [Get the list of API keys for a WebBroker API](webbroker-api-management.md#get-the-list-of-api-keys-for-a-webbroker-api)
- [Regenerate API key for a WebBroker API](webbroker-api-management.md#regenerate-api-key-for-a-webbroker-api)
- [Update an API key for a WebBroker API](webbroker-api-management.md#update-an-api-key-for-a-webbroker-api)
- [Revoke an API key for a WebBroker API](webbroker-api-management.md#revoke-an-api-key-for-a-webbroker-api)

### [Schemas](schemas.md)

3 changes: 3 additions & 0 deletions docs/rest-apis/event-gateway/authentication.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Authentication

- HTTP Authentication, scheme: basic
Loading
Loading