Skip to content
This repository was archived by the owner on Jan 21, 2020. It is now read-only.

Commit 275105d

Browse files
FrenchBenDavid Chung
authored andcommitted
fixed typo (#361)
Signed-off-by: French Ben <[email protected]>
1 parent db32bd8 commit 275105d

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

docs/plugins/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ project, so please double-check where the code lives before filing InfraKit issu
102102
Have a Plugin you'd like to share? Submit a Pull Request to add yourself to the list!
103103

104104
### Creating a plugin
105-
A plugin must be an HTTP server that implements one of the plugin [APIs](#apis), lisetning on a Unix socket. While
105+
A plugin must be an HTTP server that implements one of the plugin [APIs](#apis), listening on a Unix socket. While
106106
a plugin can be written in any programming language, [utilities](pkg/rpc) are available as libraries to simplify Plugin
107107
development in Go. Our [reference implementations](#reference-implementations) should provide a good starting point
108108
for building a new plugin using these utilities.
@@ -112,15 +112,15 @@ _InfraKit_ plugins are exposed via HTTP, using [JSON-RPC 2.0](http://www.jsonrpc
112112

113113
API requests can be made manually with `curl`. For example, the following command will list all groups:
114114
```console
115-
$ curl -X POST --unix-socket ~/.infrakit/plugins/group http:/rpc \
115+
$ curl -X POST --unix-socket ~/.infrakit/plugins/group http://rpc \
116116
-H 'Content-Type: application/json' \
117117
-d '{"jsonrpc":"2.0","method":"Group.InspectGroups","params":{},"id":1}'
118118
{"jsonrpc":"2.0","result":{"Groups":null},"id":1}
119119
```
120120

121121
API errors are surfaced with the `error` response field:
122122
```console
123-
$ curl -X POST --unix-socket ~/.infrakit/plugins/group http:/rpc \
123+
$ curl -X POST --unix-socket ~/.infrakit/plugins/group http://rpc \
124124
-H 'Content-Type: application/json' \
125125
-d '{"jsonrpc":"2.0","method":"Group.CommitGroup","params":{},"id":1}'
126126
{"jsonrpc":"2.0","error":{"code":-32000,"message":"Group ID must not be blank","data":null},"id":1}
@@ -141,7 +141,7 @@ Plugins are required to identify the name and version of plugin APIs they implem
141141
like the following:
142142

143143
```console
144-
$ curl -X POST --unix-socket ~/.infrakit/plugins/group http:/rpc \
144+
$ curl -X POST --unix-socket ~/.infrakit/plugins/group http://rpc \
145145
-H 'Content-Type: application/json' \
146146
-d '{"jsonrpc":"2.0","method":"Plugin.Implements","params":{},"id":1}'
147147
{"jsonrpc":"2.0","result":{"Interfaces":[{"Name":"Group","Version":"0.1.0"}]},"id":1}

0 commit comments

Comments
 (0)