Update wiki Home page for rest-openapi-sink
parent
0d349d908a
commit
34729ccc6b
37
Home.md
37
Home.md
@ -1,21 +1,30 @@
|
|||||||
# Deploy the Project on CamelX Platform
|
# REST OpenAPI Sink
|
||||||
|
|
||||||
Deploy on CamelX Platform in three steps
|
Load an OpenAPI specification from a URI and call an operation on a HTTP service. The request that is generated respects the rules given in the OpenAPI specification (for example, path parameters and Content-Type).
|
||||||
|
|
||||||
## Step 1: Create a release
|
## Metadata
|
||||||
From the project space, click on **"Create a release"**
|
|
||||||
|
|
||||||
The new version is automatically available in the list
|
| Property | Value |
|
||||||
|
|----------|-------|
|
||||||
|
| Type | sink |
|
||||||
|
| Group | HTTP |
|
||||||
|
| Namespace | HTTP |
|
||||||
|
| Support Level | Stable |
|
||||||
|
| Provider | Apache Software Foundation |
|
||||||
|
|
||||||
## Step 2: Deploy
|
## Properties
|
||||||
Click on **"Deploy"**
|
|
||||||
|
|
||||||
- **Version:** Select the desired release
|
| Name | Type | Required | Default | Description |
|
||||||
- **Environment:** Choose `Development`, `Staging`, or `Production`
|
|------|------|----------|---------|-------------|
|
||||||
- **Configuration:** Select the configuration source
|
| `specification` | string | ✓ | | The URI to the OpenApi specification file. |
|
||||||
- **Resources:** Set CPU and Memory
|
| `operation` | string | ✓ | | The operation to call. |
|
||||||
|
| `host` | string | | | The host to use for calling the REST service. Overrides the value found in the OpenAPI specification. The format is https://hostname:port. |
|
||||||
|
| `basePath` | string | | | The API base path. Overrides the value present in the OpenAPI specification. |
|
||||||
|
| `clientRequestValidation` | boolean | | `false` | Whether to enable validation of the client request to check if the incoming request is valid according to the OpenAPI specification. |
|
||||||
|
|
||||||
## Step 3: Expose
|
## Dependencies
|
||||||
Enable **"Expose"**
|
|
||||||
|
|
||||||
Choose an **API Gateway** (Internal, Public, etc.)
|
- `camel:rest-openapi`
|
||||||
|
- `camel:http`
|
||||||
|
- `camel:kamelet`
|
||||||
|
- `camel:core`
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user