tweaks to docs (#200)

This commit is contained in:
Dominic Wong
2021-09-02 15:23:24 +01:00
committed by GitHub
parent 2e5af32faf
commit d378ef2de5
39 changed files with 83 additions and 88 deletions

View File

@@ -1,5 +1,5 @@
URL shortening, sharing and tracking
URL shortening, sharing, and tracking
# URL Service
The url service provides one time short urls for anything. Shorten, share and track the usage.
The url service provides one time short urls for anything. Shorten, share, and then track the usage.

View File

@@ -30,8 +30,7 @@ message URLPair {
int64 hitCount = 5;
}
// List shortened URLs. It has no input parameters, as it will take
// the user ID from the token and list the user's (caller's) shortened URLs.
// List information on all the shortened URLs that you have created
message ListRequest {
// filter by short URL, optional
string shortURL = 2;
@@ -42,8 +41,6 @@ message ListResponse {
}
// Proxy returns the destination URL of a short URL.
// Proxy resolves even URLs not owned by the token holder,
// unlike the List endpoint.
message ProxyRequest {
// short url ID, without the domain, eg. if your short URL is
// `m3o.one/u/someshorturlid` then pass in `someshorturlid`