Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1,702 changes: 1,702 additions & 0 deletions src/data/abtesting-v3.json

Large diffs are not rendered by default.

208 changes: 156 additions & 52 deletions src/data/abtesting.json

Large diffs are not rendered by default.

1,669 changes: 1,669 additions & 0 deletions src/data/advanced-personalization.json

Large diffs are not rendered by default.

492 changes: 376 additions & 116 deletions src/data/analytics.json

Large diffs are not rendered by default.

4,238 changes: 4,238 additions & 0 deletions src/data/composition.json

Large diffs are not rendered by default.

3,397 changes: 3,397 additions & 0 deletions src/data/crawler.json

Large diffs are not rendered by default.

2,049 changes: 1,602 additions & 447 deletions src/data/ingestion.json

Large diffs are not rendered by default.

1,844 changes: 1,844 additions & 0 deletions src/data/insights.json

Large diffs are not rendered by default.

95 changes: 67 additions & 28 deletions src/data/monitoring.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"openapi": "3.0.2",
"info": {
"title": "Algolia Monitoring API",
"description": "The Monitoring API lets you check the status of your Algolia infrastructure.\n\n## Base URLs\n\nThe base URL for requests to the Monitoring API is:\n\n- `https://status.algolia.com`\n\n**All requests must use HTTPS.**\n\n## Availability and authentication\n\nAccess to the [Infrastructure](#tag/infrastructure) endpoints\nis available as part of the [Premium or Elevate plans](https://www.algolia.com/pricing).\n\nTo authenticate requests to the Infrastructure endpoints, add these headers:\n\n- `x-algolia-application-id`. Your Algolia application ID.\n- `x-algolia-api-key`. Your Monitoring API key.\n\nYou can find your application ID and API key in the [Algolia dashboard](https://dashboard.algolia.com/account).\n\nOther endpoints don't require authentication.\n\n## Response status and errors\n\nThe Monitoring API returns JSON responses.\nSince JSON doesn't guarantee any specific ordering, don't rely on the order of attributes in the API response.\n\nSuccessful responses return a `2xx` status. Client errors return a `4xx` status. Server errors are indicated by a `5xx` status.\nError responses have a `message` property with more information.\n\n## Version\n\nThe current version of the Monitoring API is version 1, as indicated by the `/1/` in each endpoint's URL.\n",
"description": "The Monitoring API lets you check the status of your Algolia infrastructure.\n\n## Base URLs\n\nThe base URL for requests to the Monitoring API is:\n\n- `https://status.algolia.com`\n\n**All requests must use HTTPS.**\n\n## Availability and authentication\n\nAccess to the Infrastructure endpoints\nis available as part of the [Premium or Elevate plans](https://www.algolia.com/pricing).\n\nTo authenticate requests to the Infrastructure endpoints, add these headers:\n\n- `x-algolia-application-id`. Your Algolia application ID.\n- `x-algolia-api-key`. Your Monitoring API key.\n\nYou can find your application ID and API key in the [Algolia dashboard](https://dashboard.algolia.com/account/api-keys).\n\nOther endpoints don't require authentication.\n\n## Response status and errors\n\nThe Monitoring API returns JSON responses.\nSince JSON doesn't guarantee any specific ordering, don't rely on the order of attributes in the API response.\n\nSuccessful responses return a `2xx` status. Client errors return a `4xx` status. Server errors are indicated by a `5xx` status.\nError responses have a `message` property with more information.\n\n## Version\n\nThe current version of the Monitoring API is version 1, as indicated by the `/1/` in each endpoint's URL.\n",
"version": "1.0.0"
},
"servers": [
Expand Down Expand Up @@ -69,8 +69,7 @@
"404": {
"$ref": "#/components/responses/IndexNotFound"
}
},
"tags": ["monitoring"]
}
},
"post": {
"operationId": "customPost",
Expand Down Expand Up @@ -117,8 +116,7 @@
"404": {
"$ref": "#/components/responses/IndexNotFound"
}
},
"tags": ["monitoring"]
}
},
"put": {
"operationId": "customPut",
Expand Down Expand Up @@ -165,8 +163,7 @@
"404": {
"$ref": "#/components/responses/IndexNotFound"
}
},
"tags": ["monitoring"]
}
},
"delete": {
"operationId": "customDelete",
Expand Down Expand Up @@ -203,16 +200,17 @@
"404": {
"$ref": "#/components/responses/IndexNotFound"
}
},
"tags": ["monitoring"]
}
}
},
"/1/status": {
"get": {
"operationId": "getClustersStatus",
"operationId": "getStatus",
"summary": "Retrieve status of all clusters",
"security": [],
"tags": ["monitoring"],
"tags": [
"status"
],
"description": "Retrieves the status of all Algolia clusters and instances.",
"responses": {
"200": {
Expand All @@ -229,7 +227,10 @@
"summary": "Retrieve cluster status",
"description": "Retrieves the status of selected clusters.",
"operationId": "getClusterStatus",
"tags": ["monitoring"],
"x-mcp-tool": true,
"tags": [
"status"
],
"security": [],
"parameters": [
{
Expand All @@ -254,8 +255,11 @@
"summary": "Retrieve all incidents",
"description": "Retrieves known incidents for all clusters.",
"operationId": "getIncidents",
"x-mcp-tool": true,
"security": [],
"tags": ["monitoring"],
"tags": [
"incidents"
],
"responses": {
"200": {
"$ref": "#/components/responses/IncidentsResponse"
Expand All @@ -271,7 +275,9 @@
"summary": "Retrieve cluster incidents",
"description": "Retrieves known incidents for the selected clusters.",
"operationId": "getClusterIncidents",
"tags": ["monitoring"],
"tags": [
"incidents"
],
"security": [],
"parameters": [
{
Expand Down Expand Up @@ -304,7 +310,9 @@
}
],
"description": "Retrieves the servers that belong to clusters.\n\nThe response depends on whether you authenticate your API request:\n\n- With authentication, the response lists the servers assigned to your\nAlgolia application's cluster.\n\n- Without authentication, the response lists the servers for all Algolia\nclusters.\n",
"tags": ["monitoring"],
"tags": [
"monitoring-tag"
],
"responses": {
"200": {
"$ref": "#/components/responses/InventoryResponse"
Expand All @@ -321,7 +329,9 @@
"description": "Retrieves the average latency for search requests for selected clusters.",
"operationId": "getLatency",
"security": [],
"tags": ["monitoring"],
"tags": [
"monitoring-tag"
],
"parameters": [
{
"$ref": "#/components/parameters/Clusters"
Expand All @@ -343,7 +353,9 @@
"description": "Retrieves average times for indexing operations for selected clusters.",
"operationId": "getIndexingTime",
"security": [],
"tags": ["monitoring"],
"tags": [
"monitoring-tag"
],
"parameters": [
{
"$ref": "#/components/parameters/Clusters"
Expand All @@ -365,7 +377,9 @@
"description": "Test whether clusters are reachable or not.",
"operationId": "getReachability",
"security": [],
"tags": ["monitoring"],
"tags": [
"monitoring-tag"
],
"parameters": [
{
"$ref": "#/components/parameters/Clusters"
Expand All @@ -386,7 +400,9 @@
"summary": "Retrieve metrics",
"description": "Retrieves metrics related to your Algolia infrastructure, aggregated over a selected time window.\n\nAccess to this API is available as part of the [Premium or Elevate plans](https://www.algolia.com/pricing).\nYou must authenticate requests with the `x-algolia-application-id` and `x-algolia-api-key` headers (using the Monitoring API key).\n",
"operationId": "getMetrics",
"tags": ["monitoring"],
"tags": [
"infrastructure"
],
"parameters": [
{
"$ref": "#/components/parameters/MetricInPath"
Expand All @@ -409,7 +425,10 @@
"get": {
"x-helper": true,
"x-asynchronous-helper": false,
"tags": ["monitoring"],
"x-acl": [],
"tags": [
"Api Key"
],
"operationId": "setClientApiKey",
"summary": "Switch the API key used to authenticate requests",
"description": "Switch the API key used to authenticate requests.\n",
Expand Down Expand Up @@ -451,7 +470,7 @@
"PathInPath": {
"name": "path",
"in": "path",
"description": "Path of the endpoint, anything after \"/1\" must be specified.",
"description": "Path of the endpoint, for example `1/newFeature`.",
"required": true,
"schema": {
"type": "string",
Expand Down Expand Up @@ -513,7 +532,12 @@
"title": "status",
"type": "string",
"description": "Status of the cluster.",
"enum": ["operational", "degraded_performance", "partial_outage", "major_outage"]
"enum": [
"operational",
"degraded_performance",
"partial_outage",
"major_outage"
]
},
"Timestamp": {
"type": "integer",
Expand Down Expand Up @@ -577,12 +601,16 @@
"ServerStatus": {
"title": "status",
"type": "string",
"enum": ["PRODUCTION"]
"enum": [
"PRODUCTION"
]
},
"Type": {
"title": "type",
"type": "string",
"enum": ["cluster"]
"enum": [
"cluster"
]
},
"Server": {
"title": "server",
Expand Down Expand Up @@ -666,7 +694,13 @@
},
"Period": {
"type": "string",
"enum": ["minute", "hour", "day", "week", "month"],
"enum": [
"minute",
"hour",
"day",
"week",
"month"
],
"example": "week"
},
"ProbesMetric": {
Expand Down Expand Up @@ -1105,7 +1139,7 @@
},
"ssd_usage": {
"type": "object",
"description": "Solid-state disk (SSD) usage expressed as % of RAM.\n0% means no SSD usage. A value of 50% indicates 32 GB SSD usage for a machine with 64 RAM.\n",
"description": "Solid-state disk (SSD) usage expressed as % of RAM. \n0% means no SSD usage. A value of 50% indicates 32 GB SSD usage for a machine with 64 RAM.\n",
"additionalProperties": {
"x-additionalPropertiesName": "probes",
"$ref": "#/components/schemas/InfraProbes"
Expand Down Expand Up @@ -1219,7 +1253,12 @@
"x-tagGroups": [
{
"name": "General",
"tags": ["status", "incidents", "infrastructure", "monitoring-tag"]
"tags": [
"status",
"incidents",
"infrastructure",
"monitoring-tag"
]
}
]
}
}
Loading
Loading