Skip to content

Commit e396ae1

Browse files
OAS Update
1 parent 58ab60a commit e396ae1

File tree

1 file changed

+310
-0
lines changed

1 file changed

+310
-0
lines changed

services/mongodb-flex/v1/mongodb-flex.json

Lines changed: 310 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -799,6 +799,37 @@
799799
},
800800
"type": "object"
801801
},
802+
"handlers_instances.SlowQueriesResponse": {
803+
"properties": {
804+
"slowQueries": {
805+
"description": "A list of documents with information about slow queries as detected by the Performance Advisor.",
806+
"items": {
807+
"$ref": "#/components/schemas/mongodbatlas.SlowQuery"
808+
},
809+
"type": "array"
810+
}
811+
},
812+
"type": "object"
813+
},
814+
"handlers_instances.SuggestedIndexesResponse": {
815+
"properties": {
816+
"shapes": {
817+
"description": "Documents with information about the query shapes that are served by the suggested indexes.",
818+
"items": {
819+
"$ref": "#/components/schemas/mongodbatlas.Shape"
820+
},
821+
"type": "array"
822+
},
823+
"suggestedIndexes": {
824+
"description": "Documents with information about the indexes suggested by the Performance Advisor.",
825+
"items": {
826+
"$ref": "#/components/schemas/mongodbatlas.SuggestedIndex"
827+
},
828+
"type": "array"
829+
}
830+
},
831+
"type": "object"
832+
},
802833
"instance.ListInstance": {
803834
"properties": {
804835
"id": {
@@ -840,6 +871,131 @@
840871
}
841872
},
842873
"type": "object"
874+
},
875+
"mongodbatlas.Operation": {
876+
"properties": {
877+
"predicates": {
878+
"description": "Documents containing the search criteria used by the query.",
879+
"items": {
880+
"type": "object"
881+
},
882+
"type": "array"
883+
},
884+
"raw": {
885+
"description": "Raw log line produced by the query.",
886+
"type": "string"
887+
},
888+
"stats": {
889+
"allOf": [
890+
{
891+
"$ref": "#/components/schemas/mongodbatlas.Stats"
892+
}
893+
],
894+
"description": "Query statistics.",
895+
"type": "object"
896+
}
897+
},
898+
"type": "object"
899+
},
900+
"mongodbatlas.Shape": {
901+
"properties": {
902+
"avgMs": {
903+
"description": "Average duration in milliseconds for the queries examined that match this shape.",
904+
"type": "number"
905+
},
906+
"count": {
907+
"description": "Number of queries examined that match this shape.",
908+
"type": "integer"
909+
},
910+
"id": {
911+
"description": "Unique id for this shape. Exists only for the duration of the API request.",
912+
"type": "string"
913+
},
914+
"inefficiencyScore": {
915+
"description": "Average number of documents read for every document returned by the query.",
916+
"type": "integer"
917+
},
918+
"namespace": {
919+
"description": "The namespace in which the slow query ran.",
920+
"type": "string"
921+
},
922+
"operations": {
923+
"description": "It represents documents with specific information and log lines for individual queries.",
924+
"items": {
925+
"$ref": "#/components/schemas/mongodbatlas.Operation"
926+
},
927+
"type": "array"
928+
}
929+
},
930+
"type": "object"
931+
},
932+
"mongodbatlas.SlowQuery": {
933+
"properties": {
934+
"line": {
935+
"description": "The raw log line pertaining to the slow query.",
936+
"type": "string"
937+
},
938+
"namespace": {
939+
"description": "The namespace in which the slow query ran.",
940+
"type": "string"
941+
}
942+
},
943+
"type": "object"
944+
},
945+
"mongodbatlas.Stats": {
946+
"properties": {
947+
"ms": {
948+
"description": "Duration in milliseconds of the query.",
949+
"type": "number"
950+
},
951+
"nReturned": {
952+
"description": "Number of results returned by the query.",
953+
"type": "integer"
954+
},
955+
"nScanned": {
956+
"description": "Number of documents read by the query.",
957+
"type": "integer"
958+
},
959+
"ts": {
960+
"description": "Query timestamp, in seconds since epoch.",
961+
"type": "integer"
962+
}
963+
},
964+
"type": "object"
965+
},
966+
"mongodbatlas.SuggestedIndex": {
967+
"properties": {
968+
"id": {
969+
"description": "Unique id for this suggested index.",
970+
"type": "string"
971+
},
972+
"impact": {
973+
"description": "List of unique identifiers which correspond the query shapes in this response which pertain to this suggested index.",
974+
"items": {
975+
"type": "string"
976+
},
977+
"type": "array"
978+
},
979+
"index": {
980+
"description": "Array of documents that specifies a key in the index and its sort order, ascending or descending.",
981+
"items": {
982+
"additionalProperties": {
983+
"type": "integer"
984+
},
985+
"type": "object"
986+
},
987+
"type": "array"
988+
},
989+
"namespace": {
990+
"description": "Namespace of the suggested index.",
991+
"type": "string"
992+
},
993+
"weight": {
994+
"description": "Estimated percentage performance improvement that the suggested index would provide.",
995+
"type": "number"
996+
}
997+
},
998+
"type": "object"
843999
}
8441000
}
8451001
},
@@ -1461,6 +1617,160 @@
14611617
"summary": "Put endpoint"
14621618
}
14631619
},
1620+
"/v1/projects/{projectId}/instances/{instanceId}/advisor/slow-queries": {
1621+
"get": {
1622+
"description": "gets slow queries from the Opsmanager performance advisor",
1623+
"parameters": [
1624+
{
1625+
"description": "project id",
1626+
"explode": false,
1627+
"in": "path",
1628+
"name": "projectId",
1629+
"required": true,
1630+
"schema": {
1631+
"type": "string"
1632+
},
1633+
"style": "simple"
1634+
},
1635+
{
1636+
"description": "instance id",
1637+
"explode": false,
1638+
"in": "path",
1639+
"name": "instanceId",
1640+
"required": true,
1641+
"schema": {
1642+
"type": "string"
1643+
},
1644+
"style": "simple"
1645+
}
1646+
],
1647+
"responses": {
1648+
"200": {
1649+
"content": {
1650+
"application/json": {
1651+
"schema": {
1652+
"$ref": "#/components/schemas/handlers_instances.SlowQueriesResponse"
1653+
}
1654+
}
1655+
},
1656+
"description": "OK"
1657+
},
1658+
"400": {
1659+
"content": {
1660+
"application/json": {
1661+
"schema": {
1662+
"$ref": "#/components/schemas/Error"
1663+
}
1664+
}
1665+
},
1666+
"description": "Bad Request"
1667+
},
1668+
"404": {
1669+
"content": {
1670+
"application/json": {
1671+
"schema": {
1672+
"$ref": "#/components/schemas/Error"
1673+
}
1674+
}
1675+
},
1676+
"description": "Not Found"
1677+
},
1678+
"500": {
1679+
"content": {
1680+
"application/json": {
1681+
"schema": {
1682+
"$ref": "#/components/schemas/Error"
1683+
}
1684+
}
1685+
},
1686+
"description": "Internal Server Error"
1687+
}
1688+
},
1689+
"security": [
1690+
{
1691+
"BearerAuth": []
1692+
}
1693+
],
1694+
"summary": "Get slow queries"
1695+
}
1696+
},
1697+
"/v1/projects/{projectId}/instances/{instanceId}/advisor/suggested-indexes": {
1698+
"get": {
1699+
"description": "gets suggested indexes from the Opsmanager performance advisor",
1700+
"parameters": [
1701+
{
1702+
"description": "project id",
1703+
"explode": false,
1704+
"in": "path",
1705+
"name": "projectId",
1706+
"required": true,
1707+
"schema": {
1708+
"type": "string"
1709+
},
1710+
"style": "simple"
1711+
},
1712+
{
1713+
"description": "instance id",
1714+
"explode": false,
1715+
"in": "path",
1716+
"name": "instanceId",
1717+
"required": true,
1718+
"schema": {
1719+
"type": "string"
1720+
},
1721+
"style": "simple"
1722+
}
1723+
],
1724+
"responses": {
1725+
"200": {
1726+
"content": {
1727+
"application/json": {
1728+
"schema": {
1729+
"$ref": "#/components/schemas/handlers_instances.SuggestedIndexesResponse"
1730+
}
1731+
}
1732+
},
1733+
"description": "OK"
1734+
},
1735+
"400": {
1736+
"content": {
1737+
"application/json": {
1738+
"schema": {
1739+
"$ref": "#/components/schemas/Error"
1740+
}
1741+
}
1742+
},
1743+
"description": "Bad Request"
1744+
},
1745+
"404": {
1746+
"content": {
1747+
"application/json": {
1748+
"schema": {
1749+
"$ref": "#/components/schemas/Error"
1750+
}
1751+
}
1752+
},
1753+
"description": "Not Found"
1754+
},
1755+
"500": {
1756+
"content": {
1757+
"application/json": {
1758+
"schema": {
1759+
"$ref": "#/components/schemas/Error"
1760+
}
1761+
}
1762+
},
1763+
"description": "Internal Server Error"
1764+
}
1765+
},
1766+
"security": [
1767+
{
1768+
"BearerAuth": []
1769+
}
1770+
],
1771+
"summary": "Get suggested indexes"
1772+
}
1773+
},
14641774
"/v1/projects/{projectId}/instances/{instanceId}/backups": {
14651775
"get": {
14661776
"description": "List backups of an instance",

0 commit comments

Comments
 (0)