dapr
/
docs
mirror of https://github.com/dapr/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

case-sentivice URL params note (#814) 

Co-authored-by: Yaron Schneider <yaronsc@microsoft.com>
This commit is contained in:
Mark Chmarny 2020-09-24 15:05:53 -07:00 committed by GitHub
parent 4b3f3a8c83
commit be9a77d458
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 53 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
reference/api/actors_api.md
View File

@ -52,6 +52,8 @@ actorType | The actor type.
actorId | The actor ID.
method | The name of the method to invoke.
> Note, all URL parameters are case-sensitive.
#### Examples
Example of invoking a method on an actor:
@ -110,6 +112,8 @@ daprPort | The Dapr port.
actorType | The actor type.
actorId | The actor ID.
> Note, all URL parameters are case-sensitive.
#### Examples
```shell
@ -161,6 +165,8 @@ actorType | The actor type.
actorId | The actor ID.
key | The key for the state value.
> Note, all URL parameters are case-sensitive.
#### Examples
```shell
@ -229,6 +235,8 @@ actorType | The actor type.
actorId | The actor ID.
name | The name of the reminder to create.
> Note, all URL parameters are case-sensitive.
#### Examples
```shell
@ -268,6 +276,8 @@ actorType | The actor type.
actorId | The actor ID.
name | The name of the reminder to get.
> Note, all URL parameters are case-sensitive.
#### Examples
```shell
@ -312,6 +322,8 @@ actorType | The actor type.
actorId | The actor ID.
name | The name of the reminder to delete.
> Note, all URL parameters are case-sensitive.
#### Examples
```shell
@ -364,6 +376,8 @@ actorType | The actor type.
actorId | The actor ID.
name | The name of the timer to create.
> Note, all URL parameters are case-sensitive.
#### Examples
```shell
@ -404,6 +418,8 @@ actorType | The actor type.
actorId | The actor ID.
name | The name of the timer to delete.
> Note, all URL parameters are case-sensitive.
```shell
curl http://localhost:3500/v1.0/actors/stormtrooper/50/timers/checkRebels \
-X "Content-Type: application/json"
@ -490,6 +506,8 @@ appPort | The application port.
actorType | The actor type.
actorId | The actor ID.
> Note, all URL parameters are case-sensitive.
#### Examples
Example of deactivating an actor: The example deactives the actor type stormtrooper that has actorId of 50
@ -526,6 +544,8 @@ actorType | The actor type.
actorId | The actor ID.
methodName | The name of the method to invoke.
> Note, all URL parameters are case-sensitive.
#### Examples
Example of invoking a method for an actor: The example calls the performAction method on the actor type stormtrooper that has actorId of 50
@ -562,6 +582,8 @@ actorType | The actor type.
actorId | The actor ID.
reminderName | The name of the reminder to invoke.
> Note, all URL parameters are case-sensitive.
#### Examples
Example of invoking a reminder for an actor: The example calls the checkRebels reminder method on the actor type stormtrooper that has actorId of 50
@ -598,6 +620,8 @@ actorType | The actor type.
actorId | The actor ID.
timerName | The name of the timer to invoke.
> Note, all URL parameters are case-sensitive.
#### Examples
Example of invoking a timer for an actor: The example calls the checkRebels timer method on the actor type stormtrooper that has actorId of 50

10
reference/api/bindings_api.md
View File

@ -106,6 +106,8 @@ Parameter | Description
appPort | the application port
name | the name of the binding
> Note, all URL parameters are case-sensitive.
### Binding payload
In order to deliver binding inputs, a POST call is made to user code with the name of the binding as the URL path.
@ -129,6 +131,8 @@ Parameter | Description
appPort | the application port
name | the name of the binding
> Note, all URL parameters are case-sensitive.
#### HTTP Response body (optional)
Optionally, a response body can be used to directly bind input bindings with state stores or output bindings.
@ -183,6 +187,8 @@ The bindings endpoint receives the following JSON payload:
}
```
> Note, all URL parameters are case-sensitive.
The `data` field takes any JSON serializable value and acts as the payload to be sent to the output binding.
The `metadata` field is an array of key/value pairs and allows you to set binding specific metadata for each call.
The `operation` field tells the Dapr binding which operation it should perform.
@ -194,6 +200,8 @@ Parameter | Description
daprPort | the Dapr port
name | the name of the output binding to invoke
> Note, all URL parameters are case-sensitive.
### Examples
```shell
@ -212,7 +220,7 @@ curl -X POST http://localhost:3500/v1.0/bindings/myKafka \
### Common metadata values
There are common metadata properties which are support accross multiple binding components. The list below illustrates them:
There are common metadata properties which are support across multiple binding components. The list below illustrates them:
|Property|Description|Binding definition|Available in
|-|-|-|-|

6
reference/api/pubsub_api.md
View File

@ -26,6 +26,8 @@ daprPort | the Dapr port
pubsubname | the name of pubsub component.
topic | the name of the topic
> Note, all URL parameters are case-sensitive.
```shell
curl -X POST http://localhost:3500/v1.0/publish/pubsubName/deathStarStatus \
-H "Content-Type: application/json" \
@ -68,6 +70,8 @@ Example:
]
```
> Note, all subscription parameters are case-sensitive.
## Provide route(s) for Dapr to deliver topic events
In order to deliver topic events, a `POST` call will be made to user code with the route specified in the subscription response.
@ -80,6 +84,8 @@ The following example illustrates this point, considering a subscription for top
POST http://localhost:<appPort>/orders
```
> Note, all URL parameters are case-sensitive.
### URL Parameters
Parameter | Description

2
reference/api/secrets_api.md
View File

@ -22,6 +22,8 @@ daprPort | the Dapr port
secret-store-name | the name of the secret store to get the secret from
name | the name of the secret to get
> Note, all URL parameters are case-sensitive.
#### Query Parameters
Some secret stores have **optional** metadata properties. metadata is populated using query parameters:

2
reference/api/service_invocation_api.md
View File

@ -36,6 +36,8 @@ daprPort | the Dapr port
appId | the App ID associated with the remote app
method-name | the name of the method or url to invoke on the remote app
> Note, all URL parameters are case-sensitive.
### Request Contents
In the request you can pass along headers:

10
reference/api/state_api.md
View File

@ -69,6 +69,8 @@ Parameter | Description
daprPort | the Dapr port
storename | ```metadata.name``` field in the user configured state store component yaml. Please refer Dapr State Store configuration structure mentioned above.
> Note, all URL parameters are case-sensitive.
#### Request Body
A JSON array of state objects. Each state object is comprised with the following fields:
@ -136,6 +138,8 @@ key | the key of the desired state
consistency | (optional) read consistency mode, see [state operation options](#optional-behaviors)
metadata | (optional) metadata as query parameters to the state store
> Note, all URL parameters are case-sensitive.
### HTTP Response
#### Response Codes
@ -195,6 +199,8 @@ daprPort | the Dapr port
storename | ```metadata.name``` field in the user configured state store component yaml. Please refer Dapr State Store configuration structure mentioned above.
metadata | (optional) metadata as query parameters to the state store
> Note, all URL parameters are case-sensitive.
### HTTP Response
#### Response Codes
@ -262,6 +268,8 @@ key | the key of the desired state
concurrency | (optional) either *first-write* or *last-write*, see [state operation options](#optional-behaviors)
consistency | (optional) either *strong* or *eventual*, see [state operation options](#optional-behaviors)
> Note, all URL parameters are case-sensitive.
#### Request Headers
Header | Description
@ -322,6 +330,8 @@ Parameter | Description
daprPort | the Dapr port
storename | ```metadata.name``` field in the user configured state store component yaml. Please refer Dapr State Store configuration structure mentioned above.
> Note, all URL parameters are case-sensitive.
#### Request Body
Field | Description