Browse Source

Make it clear that these are example requests

kegan/remove-docs-from-readme
Kegan Dougal 8 years ago
parent
commit
a06ac2d3be
  1. 2
      src/github.com/matrix-org/go-neb/services/giphy/giphy.go
  2. 2
      src/github.com/matrix-org/go-neb/services/github/github.go
  3. 2
      src/github.com/matrix-org/go-neb/services/github/github_webhook.go
  4. 2
      src/github.com/matrix-org/go-neb/services/guggy/guggy.go
  5. 2
      src/github.com/matrix-org/go-neb/services/jira/jira.go
  6. 2
      src/github.com/matrix-org/go-neb/services/rssbot/rssbot.go

2
src/github.com/matrix-org/go-neb/services/giphy/giphy.go

@ -36,7 +36,7 @@ type giphySearch struct {
// Service contains the Config fields for the Giphy Service.
//
// Example:
// Example request:
// {
// "api_key": "dc6zaTOxFJmzC"
// }

2
src/github.com/matrix-org/go-neb/services/github/github.go

@ -44,7 +44,7 @@ var ownerRepoRegex = regexp.MustCompile(`^([A-z0-9-_]+)/([A-z0-9-_]+)$`)
//
// This will allow the "owner/repo" to be omitted when creating/expanding issues.
//
// Example:
// Example request:
// {
// "RealmID": "github-realm-id"
// }

2
src/github.com/matrix-org/go-neb/services/github/github_webhook.go

@ -28,7 +28,7 @@ const WebhookServiceType = "github-webhook"
// to it. It requires a public domain which Github can reach. Notices will be sent
// as the service user ID, not the ClientUserID.
//
// Example:
// Example request:
// {
// ClientUserID: "@alice:localhost",
// RealmID: "github-realm-id",

2
src/github.com/matrix-org/go-neb/services/guggy/guggy.go

@ -34,7 +34,7 @@ type guggyGifResult struct {
// Service contains the Config fields for the Guggy service.
//
// Example:
// Example request:
// {
// "api_key": "fkweugfyuwegfweyg"
// }

2
src/github.com/matrix-org/go-neb/services/jira/jira.go

@ -33,7 +33,7 @@ var projectKeyRegex = regexp.MustCompile("^[A-z]+$")
//
// Before you can set up a JIRA Service, you need to set up a JIRA Realm.
//
// Example:
// Example request:
// {
// Rooms: {
// "!qmElAGdFYCHoCJuaNt:localhost": {

2
src/github.com/matrix-org/go-neb/services/rssbot/rssbot.go

@ -37,7 +37,7 @@ const minPollingIntervalSeconds = 60 * 5 // 5 min (News feeds can be genuinely s
// Service contains the Config fields for this service.
//
// Example:
// Example request:
// {
// feeds: {
// "http://rss.cnn.com/rss/edition.rss": {

Loading…
Cancel
Save