Skip to content

Improve documentation #4

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Improve documentation #4

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,11 @@ You will need the following tools installed locally
- **Maven 3.8+**
- **Git**

Ths project has the following external dependency. This artifact must be installed to your Maven repo to build the projec successfully.
Ths project has the following external dependency. This artifact must be installed to your Maven repo to build the project successfully.
- **com.solace.ep.asyncapi:asyncapi-importer-core**

## Steps to build the project
Alternatively, you can find the latest release in the GitHub repository and download the jar file.
Alternatively, you can find the [latest release](https://github.com/SolaceLabs/asyncapi-importer-rest/tags) in the GitHub repository and download the jar file.

This project has a dependency on **asyncapi-importer-core** artifact, which can be built from a module contained in the [Solace AsyncAPI Importer for Event Portal](https://github.com/SolaceLabs/sol-ep-asyncapi-importer "Open project on GitHub") project.

Expand Down Expand Up @@ -89,7 +89,7 @@ A simple HTTP GET request can be performed to verify that the service is active.
The purpose of this operation is to verify that the token being used is valid. This is a convenience method; it is not required to verify a token before attempting to call the import method. The context for this operation is `/importer/validate-token` and the HTTP verb is `POST`.

### EP Token Request Body ###
The request body is a simple JSON message with a single field: `epToken`. `epToken` **must be Base64 encoded** in the message body.
The request body is a simple JSON message with a single field: `epToken`. Check the [Docs](https://docs.solace.com/Cloud/ght_api_tokens.htm#creating-an-api-token) to see how to generate a token. `epToken` **must be Base64 encoded** in the message body.

#### Sample JSON Request body for EP Token verification
```json
Expand All @@ -104,7 +104,7 @@ There are two parameters on the URL: **Solace Cloud API Region and URL Override*
- `urlOverride`=https://your.override.url

## 3. Query Application Domains
Returns a list of application domains, including application domain ID and the name. Either the name or the domain ID may be used to execute an import operation. (An Event Portal Application Domain must be specified as the target for an AsyncApi import operation)
Returns a list of application domains, including application domain ID and the name. Either the name or the domain ID may be used to execute an import operation. (An Event Portal Application Domain must be specified as the target for an AsyncApi import operation). The context for this operation is `/importer/appdomains` and the HTTP verb is `POST`.

### Application Domain Query Request Parameters
The parameters used for this operation are identical to those used for the EP Token Validation (see above).
Expand Down