Add new API for Go component #152
Conversation
docs/using-data.md
Outdated
| revision: v0.0.0-20200419152657-af9db7f4a3ab | ||
| ``` | ||
|
|
||
| With this API, we need to encode the slashes in the namespace as '%2F'. You could do that by calling `encodeURIComponent(namespace)` in JS or similiar function in other language. So, for this example, the namespace we use in the coordinates is github.com%2Fquasilyte%2Fregex. Our coordinates would now look like this: |
There was a problem hiding this comment.
I suggest rewording this as:
We need to encode the slashes in the namespace as '%2F'. You could do that by calling `encodeURIComponent(namespace)` in JavaScript or a similar function in other languages. You could also manually add the encoding to the namespace. For this example, the namespace `github.com/quasilyte/regex` would become `github.com%2Fquasilyte%2Fregex`.
After encoding the namespace, our coordinates would now look like this:
docs/using-data.md
Outdated
| revision: v0.0.0-20200419152657-af9db7f4a3ab | ||
| ``` | ||
|
|
||
| Put together, our corrdinates looks like: `go/golang/github.com%2Fquasilyte%2fregex/syntax/v0.0.0-20200419152657-af9db7f4a3ab` |
There was a problem hiding this comment.
This should be reworded as:
"Put together, our coordinates now look like this: go/golang/github.com%2Fquasilyte%2fregex/syntax/v0.0.0-20200419152657-af9db7f4a3ab"
docs/using-data.md
Outdated
|
|
||
| Put together, our corrdinates looks like: `go/golang/github.com%2Fquasilyte%2fregex/syntax/v0.0.0-20200419152657-af9db7f4a3ab` | ||
|
|
||
| Because now the corrdinates is added in the query parameters, we need to encode the whole coordinates, e.g. calling encodeURIComponent() in JS. |
There was a problem hiding this comment.
This isn't clear enough to a new user (especially one who may not have an engineering background).
I suggest rewording it to:
Because we pass the coordinates as a query parameter, we need to encode the whole coordinate string. You could do that by calling encodeURIComponent(namespace) in JavaScript or a similar function in other languages. You could also manually add the encoding to the coordinates. After the encoding, go/golang/github.com%2Fquasilyte%2fregex/syntax/v0.0.0-20200419152657-af9db7f4a3ab would become go%2Fgolang%2Fgithub.com%252Fquasilyte%252Fregex%2Fsyntax%2Fv0.0.0-20200407221936-30656e2c4a95.
docs/using-data.md
Outdated
|
|
||
| To use the API, `Accept-Version: 1.0.0` must be added to the headers. | ||
|
|
||
| Here is an example. | ||
| You could try with the follwing curl command.. |
There was a problem hiding this comment.
Needs to be reworded to:
Here is a curl command you could use with the example coordinates.
|
A few more changes requested and then this will be good to deploy along with the Service pull request |
There was a problem hiding this comment.
This looks great! This can be merged when this Service PR is deployed.
No description provided.