Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
catalinaadam committed Jul 10, 2024
1 parent 1f37797 commit b20d299
Showing 1 changed file with 59 additions and 0 deletions.
59 changes: 59 additions & 0 deletions docs/release-notes/3.0.0_Beta.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,3 +92,62 @@ Be aware that API responses will be more verbose, including all defined fields r
#### Removed Inventory API section from documentation

We have streamlined our API documentation by removing the Inventory API section and focusing instead on the Management API for inventory-related tasks. If you are using the Inventory API in your integrations or scripts, make sure to review the updated API documentation for the correct endpoints and methods.


#### Streamlined API endpoints for Services, Nodes, and Agents

We have simplified our API structure by consolidated multiple endpoints into single, versatile endpoints for Services, Nodes, and Agents:

**Services API update**
A new `/v1/inventory/Services/Add` endpoint replaces individual service-specific endpoints. You can now specify the service type (mysql, mongodb, postgresql, proxysql, haproxy, external) as a top-level property in the request payload. For example:

```json
{
"mysql": {
"service_name": "mysql-sales-db-prod-1",
"node_id": "pmm-server",
"address": "209.0.25.100",
"port": 3306
// ... other properties
}
}
```

**Nodes API update**
Similarly, `/v1/inventory/Nodes/Add` now handles all node types (generic, container, remote, remote_rds, remote_azure). The node type is specified in the request payload:

```json
{
"generic": {
"node_name": "mysql-sales-db-prod-1",
"region": "us-east-1",
"az": "us-east-1a",
"address": "209.0.25.100"
// ... other properties
}
}
```

**Agents API update**
The Agents API follows the same pattern, with a single endpoint for all agent types. The agent type is specified as the top-level property in the request payload:

```json
{
"mysqld_exporter": {
"pmm_agent_id": "pmm-server",
"service_id": "13519ec9-eedc-4d21-868c-582e146e1d0e",
"username": "mysql-prod-user",
"password": "mysql-prod-pass",
"listen_port": 33060,
"custom_labels": {
"department": "sales",
"environment": "sales-prod",
"replication_set": "db-sales-prod-1-rs1",
"cluster": "db-sales-prod-1"
}
}
}
```

**Impact**
Update your API calls to use the new consolidated endpoints. Review the updated API documentation in the Swagger UI of your PMM instance for the new request formats.

0 comments on commit b20d299

Please sign in to comment.