link.latr.developer.defs

samclemente.me

Documentation

client object

No description available.

Properties

clientId string Required

No description available.

maxLength: 128 bytesmaxGraphemes: 128 graphemes
createdAt string datetime Required

An RFC 3339 formatted timestamp.

displayName string Optional

No description available.

maxLength: 256 bytesmaxGraphemes: 128 graphemes
kind string Required

No description available.

maxLength: 16 bytesmaxGraphemes: 16 graphemes
Known values: developer
View raw schema 
{
  "type": "object",
  "required": [
    "clientId",
    "kind",
    "createdAt"
  ],
  "properties": {
    "kind": {
      "type": "string",
      "maxLength": 16,
      "knownValues": [
        "developer"
      ],
      "maxGraphemes": 16
    },
    "clientId": {
      "type": "string",
      "maxLength": 128,
      "maxGraphemes": 128
    },
    "createdAt": {
      "type": "string",
      "format": "datetime"
    },
    "displayName": {
      "type": "string",
      "maxLength": 256,
      "maxGraphemes": 128
    }
  }
}
createdKey object

No description available.

Properties

apiKey string Required

No description available.

maxLength: 512 bytesmaxGraphemes: 512 graphemes
clientId string Required

No description available.

maxLength: 128 bytesmaxGraphemes: 128 graphemes
createdAt string datetime Required

An RFC 3339 formatted timestamp.

keyId string Required

No description available.

maxLength: 128 bytesmaxGraphemes: 128 graphemes
label string Optional

No description available.

maxLength: 256 bytesmaxGraphemes: 128 graphemes
View raw schema 
{
  "type": "object",
  "required": [
    "keyId",
    "clientId",
    "apiKey",
    "createdAt"
  ],
  "properties": {
    "keyId": {
      "type": "string",
      "maxLength": 128,
      "maxGraphemes": 128
    },
    "label": {
      "type": "string",
      "maxLength": 256,
      "maxGraphemes": 128
    },
    "apiKey": {
      "type": "string",
      "maxLength": 512,
      "maxGraphemes": 512
    },
    "clientId": {
      "type": "string",
      "maxLength": 128,
      "maxGraphemes": 128
    },
    "createdAt": {
      "type": "string",
      "format": "datetime"
    }
  }
}
key object

No description available.

Properties

createdAt string datetime Required

An RFC 3339 formatted timestamp.

keyId string Required

No description available.

maxLength: 128 bytesmaxGraphemes: 128 graphemes
label string Optional

No description available.

maxLength: 256 bytesmaxGraphemes: 128 graphemes
revokedAt string datetime Optional

An RFC 3339 formatted timestamp.

View raw schema 
{
  "type": "object",
  "required": [
    "keyId",
    "createdAt"
  ],
  "properties": {
    "keyId": {
      "type": "string",
      "maxLength": 128,
      "maxGraphemes": 128
    },
    "label": {
      "type": "string",
      "maxLength": 256,
      "maxGraphemes": 128
    },
    "createdAt": {
      "type": "string",
      "format": "datetime"
    },
    "revokedAt": {
      "type": "string",
      "format": "datetime"
    }
  }
}
usage object

No description available.

Properties

buckets array of ref#usageBucket Required

No description available.

clientId string Required

No description available.

maxLength: 128 bytesmaxGraphemes: 128 graphemes
dailyLimit integer Optional

No description available.

minimum: 0
remaining integer Optional

No description available.

minimum: 0
usageDate string Required

No description available.

maxLength: 10 bytesmaxGraphemes: 10 graphemes
View raw schema 
{
  "type": "object",
  "required": [
    "clientId",
    "usageDate",
    "buckets"
  ],
  "properties": {
    "buckets": {
      "type": "array",
      "items": {
        "ref": "#usageBucket",
        "type": "ref"
      }
    },
    "clientId": {
      "type": "string",
      "maxLength": 128,
      "maxGraphemes": 128
    },
    "remaining": {
      "type": "integer",
      "minimum": 0
    },
    "usageDate": {
      "type": "string",
      "maxLength": 10,
      "maxGraphemes": 10
    },
    "dailyLimit": {
      "type": "integer",
      "minimum": 0
    }
  }
}
usageBucket object

No description available.

Properties

requestCount integer Required

No description available.

minimum: 0
routeFamily string Required

No description available.

maxLength: 256 bytesmaxGraphemes: 256 graphemes
View raw schema 
{
  "type": "object",
  "required": [
    "routeFamily",
    "requestCount"
  ],
  "properties": {
    "routeFamily": {
      "type": "string",
      "maxLength": 256,
      "maxGraphemes": 256
    },
    "requestCount": {
      "type": "integer",
      "minimum": 0
    }
  }
}

Lexicon Garden

@