Skip to content

Instantly share code, notes, and snippets.

@brockinit
Last active March 7, 2018 01:24
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save brockinit/7bbb3dbdf8861d559df3ec57a6e8f5ca to your computer and use it in GitHub Desktop.
Save brockinit/7bbb3dbdf8861d559df3ec57a6e8f5ca to your computer and use it in GitHub Desktop.
Revere API Documentation

API Documentation Example

/organizations


PUT /organizations/{organizationId}

Path Parameters:

organizationId: "number" - The unique ID of the organization to update

Request Payload:

{
  "orgName": "string",
  "primaryAccountId": "number"
}

Response Payload: 200

// Each of these are one of the data types found in the OpenAPI Spec https://swagger.io/specification/#dataTypes
{
  "primaryAccountId": "number",
  "name": "string",
  "isBeta": "boolean",
  "id": "number",
  "isTrial": "boolean",
  "isActive": "boolean",
  "createdOn": "string",
  "trialStartTs": "string",
  "isPro": "boolean"
}

GET /organizations/details

Query Parameters:

aSpecialParam: "string" - The best param there ever was
extraDetails: "boolean" - For getting even more information in the response

Response Payload: 200

// Each of these are one of the data types found in the OpenAPI Spec https://swagger.io/specification/#dataTypes
{
  "slackInfo": {
    "teamName": "string",
    "configurationUrl": "string",
    "postUrl": "string",
    "teamUrl": "string",
    "channel": "string",
    "accessToken": "string",
    "userName": "string",
    "userId": "string",
    "orgId": "number",
    "accountId": "number",
    "scope": "string",
    "teamId": "boolean",
    "botAccessToken": "boolean",
    "botUserId": "string",
    "id": "number",
    "channelId": "string"
  },
  "org": {
    "primaryAccountId": "number",
    "name": "string",
    "isBeta": true,
    "id": "number",
    "isTrial": "boolean",
    "isActive": "boolean",
    "createdOn": "string",
    "trialStartTs": "string",
    "isPro": "boolean"
  },
  "orgPreferences": {
    "alertsOnWeekendsEnabled": "boolean",
    "weeklyAlertsSchedule": "string",
    "timezone": "string",
    "dailyStatusEnabled": "boolean",
    "id": "number",
    "dailyAlertsSchedule": "string",
    "dowWeeklyAlertsSchedule": "number",
    "orgId": "number"
  },
  "slackChannelInfo": {
    "channels": [
      "string"
    ],
    "groups": [
      "string"
    ]
  },
  "slackConnected": "boolean"
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment