Skip to content

Commit

Permalink
removing hash so headers is indented correctly.
Browse files Browse the repository at this point in the history
  • Loading branch information
NoSQLKnowHow committed Sep 25, 2023
1 parent 7c3b254 commit fe42226
Showing 1 changed file with 10 additions and 12 deletions.
22 changes: 10 additions & 12 deletions docs/topics/develop/api-reference/http-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,54 +38,52 @@ To access the Momento HTTP API, use one of the following endpoints in the region

If you do not see a Region you require, let’s talk. Please contact [Support](mailto:[email protected]).

## Topics

### Publish
## Publish

Publishes a message to a topic.

#### Request
### Request

- Path: /topics/{cacheName}/{topicName}
- HTTP Method: POST

##### Body
#### Body

- Content-Type: octet-stream
- The body of the request should contain the binary value to be published to the topic.

##### Path Parameters
#### Path Parameters

| Parameter name | Required? | Type | Description |
|---------------------|-----------|-----------------|---------------------------------------------|
| cacheName | yes | URL-safe string | The name of the cache containing the topic. |
| topicName | yes | URL-safe string | Name of the topic to publish to. |

##### Query Parameters
#### Query Parameters

| Parameter name | Required? | Type | Description |
|---------------------|-----------|---------------------|-----------------------------------------------------------------------------------------------------|
| token | no** | URL-safe string | The Momento auth token, in string format, to be used for authentication/authorization of the request.|

*** You must provide a Momento auth token to be used for authentication/authorization of the request. This may be passed either as the token query parameter or as the Authorization header.

##### Headers
#### Headers

| Header name | Required? | Type | Description |
|------------------|-----------|----------------------|----------------------------------------------------------------------------------------------------|
| Authorization | no** | URL-safe string | The Momento auth token, in string format, is used for authentication/authorization of the request. |

** You must provide a Momento auth token to be used for authentication/authorization of the request. This may be passed either as the token query parameter or as the Authorization header.

#### Responses
## Responses

#### Success
### Success

*Status Code: 204 No Content*

- The message was successfully published to the provided topic

##### Error
### Error

*Status Code: 400 Bad Request*
- This error type typically indicates that the request was incorrectly specified. See the message body for further details.
Expand All @@ -107,7 +105,7 @@ Publishes a message to a topic.

## Examples

#### Publish
### Publish

Below is an example that publishes the value `hello world!` to the *example* topic in the *my-cache* cache in the *us-east-1* region.

Expand Down

0 comments on commit fe42226

Please sign in to comment.