Skip to content

Commit 2e426ca

Browse files
github-actions[bot]github-actions[bot]
committed
(prod) Release OpenAPI Spec V1 🚀. See https://github.com/mongodb/openapi/actions/runs/14915175669.
1 parent 7059b86 commit 2e426ca

File tree

2 files changed

+391
-6
lines changed

2 files changed

+391
-6
lines changed

‎openapi/v1-deprecated/v1.json‎

Lines changed: 193 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15787,6 +15787,9 @@
1578715787
"$ref": "#/components/responses/internalServerError"
1578815788
}
1578915789
},
15790+
"x-xgen-changelog": {
15791+
"2025-05-08": "Corrects an issue where the endpoint would include Atlas internal entries."
15792+
},
1579015793
"x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Project-IP-Access-List/operation/listProjectIpAccessLists"
1579115794
},
1579215795
"post": {
@@ -16930,6 +16933,33 @@
1693016933
"type": "integer",
1693116934
"format": "int64"
1693216935
}
16936+
},
16937+
{
16938+
"name": "includeMetrics",
16939+
"in": "query",
16940+
"description": "Whether or not to include metrics extracted from the slow query log as separate fields.",
16941+
"schema": {
16942+
"type": "boolean",
16943+
"default": false
16944+
}
16945+
},
16946+
{
16947+
"name": "includeReplicaState",
16948+
"in": "query",
16949+
"description": "Whether or not to include the replica state of the host when the slow query log was generated as a separate field.",
16950+
"schema": {
16951+
"type": "boolean",
16952+
"default": false
16953+
}
16954+
},
16955+
{
16956+
"name": "includeOpType",
16957+
"in": "query",
16958+
"description": "Whether or not to include the operation type (read/write/command) extracted from the slow query log as a separate field.",
16959+
"schema": {
16960+
"type": "boolean",
16961+
"default": false
16962+
}
1693316963
}
1693416964
],
1693516965
"responses": {
@@ -30944,6 +30974,9 @@
3094430974
"xgen-IPA-124-array-max-items": "Schema predates IPA validation"
3094530975
}
3094630976
},
30977+
"severityOverride": {
30978+
"$ref": "#/components/schemas/EventSeverity"
30979+
},
3094730980
"updated": {
3094830981
"type": "string",
3094930982
"description": "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.",
@@ -31054,6 +31087,9 @@
3105431087
"xgen-IPA-124-array-max-items": "Schema predates IPA validation"
3105531088
}
3105631089
},
31090+
"severityOverride": {
31091+
"$ref": "#/components/schemas/EventSeverity"
31092+
},
3105731093
"updated": {
3105831094
"type": "string",
3105931095
"description": "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.",
@@ -31277,6 +31313,9 @@
3127731313
"xgen-IPA-124-array-max-items": "Schema predates IPA validation"
3127831314
}
3127931315
},
31316+
"severityOverride": {
31317+
"$ref": "#/components/schemas/EventSeverity"
31318+
},
3128031319
"threshold": {
3128131320
"$ref": "#/components/schemas/GreaterThanRawThreshold"
3128231321
},
@@ -31362,6 +31401,9 @@
3136231401
"xgen-IPA-124-array-max-items": "Schema predates IPA validation"
3136331402
}
3136431403
},
31404+
"severityOverride": {
31405+
"$ref": "#/components/schemas/EventSeverity"
31406+
},
3136531407
"updated": {
3136631408
"type": "string",
3136731409
"description": "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.",
@@ -31479,6 +31521,9 @@
3147931521
"xgen-IPA-124-array-max-items": "Schema predates IPA validation"
3148031522
}
3148131523
},
31524+
"severityOverride": {
31525+
"$ref": "#/components/schemas/EventSeverity"
31526+
},
3148231527
"threshold": {
3148331528
"$ref": "#/components/schemas/GreaterThanTimeThreshold"
3148431529
},
@@ -31779,6 +31824,9 @@
3177931824
"xgen-IPA-124-array-max-items": "Schema predates IPA validation"
3178031825
}
3178131826
},
31827+
"severityOverride": {
31828+
"$ref": "#/components/schemas/EventSeverity"
31829+
},
3178231830
"updated": {
3178331831
"type": "string",
3178431832
"description": "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.",
@@ -31896,6 +31944,9 @@
3189631944
"xgen-IPA-124-array-max-items": "Schema predates IPA validation"
3189731945
}
3189831946
},
31947+
"severityOverride": {
31948+
"$ref": "#/components/schemas/EventSeverity"
31949+
},
3189931950
"threshold": {
3190031951
"$ref": "#/components/schemas/GreaterThanDaysThresholdView"
3190131952
},
@@ -31926,6 +31977,11 @@
3192631977
"GCP_ENCRYPTION_KEY_INVALID"
3192731978
]
3192831979
},
31980+
"EventSeverity": {
31981+
"type": "string",
31982+
"description": "Severity of the event.",
31983+
"enum": ["INFO", "WARNING", "ERROR", "CRITICAL"]
31984+
},
3192931985
"FlexClusterMetricThreshold": {
3193031986
"title": "Flex Cluster Metric Threshold",
3193131987
"required": ["metricName"],
@@ -32086,6 +32142,9 @@
3208632142
"xgen-IPA-124-array-max-items": "Schema predates IPA validation"
3208732143
}
3208832144
},
32145+
"severityOverride": {
32146+
"$ref": "#/components/schemas/EventSeverity"
32147+
},
3208932148
"updated": {
3209032149
"type": "string",
3209132150
"description": "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.",
@@ -32215,6 +32274,9 @@
3221532274
"xgen-IPA-124-array-max-items": "Schema predates IPA validation"
3221632275
}
3221732276
},
32277+
"severityOverride": {
32278+
"$ref": "#/components/schemas/EventSeverity"
32279+
},
3221832280
"threshold": {
3221932281
"$ref": "#/components/schemas/GreaterThanRawThreshold"
3222032282
},
@@ -32492,6 +32554,9 @@
3249232554
"xgen-IPA-124-array-max-items": "Schema predates IPA validation"
3249332555
}
3249432556
},
32557+
"severityOverride": {
32558+
"$ref": "#/components/schemas/EventSeverity"
32559+
},
3249532560
"updated": {
3249632561
"type": "string",
3249732562
"description": "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.",
@@ -32603,6 +32668,9 @@
3260332668
"xgen-IPA-124-array-max-items": "Schema predates IPA validation"
3260432669
}
3260532670
},
32671+
"severityOverride": {
32672+
"$ref": "#/components/schemas/EventSeverity"
32673+
},
3260632674
"updated": {
3260732675
"type": "string",
3260832676
"description": "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.",
@@ -32955,6 +33023,9 @@
3295533023
"xgen-IPA-124-array-max-items": "Schema predates IPA validation"
3295633024
}
3295733025
},
33026+
"severityOverride": {
33027+
"$ref": "#/components/schemas/EventSeverity"
33028+
},
3295833029
"threshold": {
3295933030
"$ref": "#/components/schemas/LessThanTimeThreshold"
3296033031
},
@@ -33086,6 +33157,9 @@
3308633157
"xgen-IPA-124-array-max-items": "Schema predates IPA validation"
3308733158
}
3308833159
},
33160+
"severityOverride": {
33161+
"$ref": "#/components/schemas/EventSeverity"
33162+
},
3308933163
"threshold": {
3309033164
"$ref": "#/components/schemas/LessThanDaysThresholdView"
3309133165
},
@@ -33465,6 +33539,9 @@
3346533539
"xgen-IPA-124-array-max-items": "Schema predates IPA validation"
3346633540
}
3346733541
},
33542+
"severityOverride": {
33543+
"$ref": "#/components/schemas/EventSeverity"
33544+
},
3346833545
"threshold": {
3346933546
"$ref": "#/components/schemas/AlertsThresholdInteger"
3347033547
},
@@ -33597,6 +33674,9 @@
3359733674
"xgen-IPA-124-array-max-items": "Schema predates IPA validation"
3359833675
}
3359933676
},
33677+
"severityOverride": {
33678+
"$ref": "#/components/schemas/EventSeverity"
33679+
},
3360033680
"threshold": {
3360133681
"$ref": "#/components/schemas/AlertsThresholdInteger"
3360233682
},
@@ -33734,6 +33814,9 @@
3373433814
"xgen-IPA-124-array-max-items": "Schema predates IPA validation"
3373533815
}
3373633816
},
33817+
"severityOverride": {
33818+
"$ref": "#/components/schemas/EventSeverity"
33819+
},
3373733820
"updated": {
3373833821
"type": "string",
3373933822
"description": "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.",
@@ -33958,6 +34041,9 @@
3395834041
"xgen-IPA-124-array-max-items": "Schema predates IPA validation"
3395934042
}
3396034043
},
34044+
"severityOverride": {
34045+
"$ref": "#/components/schemas/EventSeverity"
34046+
},
3396134047
"updated": {
3396234048
"type": "string",
3396334049
"description": "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.",
@@ -34054,6 +34140,9 @@
3405434140
"xgen-IPA-124-array-max-items": "Schema predates IPA validation"
3405534141
}
3405634142
},
34143+
"severityOverride": {
34144+
"$ref": "#/components/schemas/EventSeverity"
34145+
},
3405734146
"threshold": {
3405834147
"$ref": "#/components/schemas/StreamProcessorMetricThreshold"
3405934148
},
@@ -34512,6 +34601,9 @@
3451234601
"xgen-IPA-124-array-max-items": "Schema predates IPA validation"
3451334602
}
3451434603
},
34604+
"severityOverride": {
34605+
"$ref": "#/components/schemas/EventSeverity"
34606+
},
3451534607
"updated": {
3451634608
"type": "string",
3451734609
"description": "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.",
@@ -36220,7 +36312,7 @@
3622036312
"type": "array",
3622136313
"description": "Atlas roles and the unique identifiers of the groups and organizations associated with each role. The array must include at least one element with an Organization role and its respective **orgId**. Each element in the array can have a value for **orgId** or **groupId**, but not both.",
3622236314
"items": {
36223-
"$ref": "#/components/schemas/RoleAssignment"
36315+
"$ref": "#/components/schemas/ConnectedOrgConfigRoleAssignment"
3622436316
},
3622536317
"x-xgen-IPA-exception": {
3622636318
"xgen-IPA-124-array-max-items": "Schema predates IPA validation"
@@ -36229,7 +36321,7 @@
3622936321
},
3623036322
"description": "Mapping settings that link one IdP and MongoDB Cloud."
3623136323
},
36232-
"RoleAssignment": {
36324+
"ConnectedOrgConfigRoleAssignment": {
3623336325
"type": "object",
3623436326
"properties": {
3623536327
"groupId": {
@@ -38355,7 +38447,22 @@
3835538447
"ATLAS_FLEX_GCP_200_USAGE_HOURS",
3835638448
"ATLAS_FLEX_GCP_300_USAGE_HOURS",
3835738449
"ATLAS_FLEX_GCP_400_USAGE_HOURS",
38358-
"ATLAS_FLEX_GCP_500_USAGE_HOURS"
38450+
"ATLAS_FLEX_GCP_500_USAGE_HOURS",
38451+
"ATLAS_FLEX_AWS_LEGACY_100_USAGE_HOURS",
38452+
"ATLAS_FLEX_AWS_LEGACY_200_USAGE_HOURS",
38453+
"ATLAS_FLEX_AWS_LEGACY_300_USAGE_HOURS",
38454+
"ATLAS_FLEX_AWS_LEGACY_400_USAGE_HOURS",
38455+
"ATLAS_FLEX_AWS_LEGACY_500_USAGE_HOURS",
38456+
"ATLAS_FLEX_AZURE_LEGACY_100_USAGE_HOURS",
38457+
"ATLAS_FLEX_AZURE_LEGACY_200_USAGE_HOURS",
38458+
"ATLAS_FLEX_AZURE_LEGACY_300_USAGE_HOURS",
38459+
"ATLAS_FLEX_AZURE_LEGACY_400_USAGE_HOURS",
38460+
"ATLAS_FLEX_AZURE_LEGACY_500_USAGE_HOURS",
38461+
"ATLAS_FLEX_GCP_LEGACY_100_USAGE_HOURS",
38462+
"ATLAS_FLEX_GCP_LEGACY_200_USAGE_HOURS",
38463+
"ATLAS_FLEX_GCP_LEGACY_300_USAGE_HOURS",
38464+
"ATLAS_FLEX_GCP_LEGACY_400_USAGE_HOURS",
38465+
"ATLAS_FLEX_GCP_LEGACY_500_USAGE_HOURS"
3835938466
]
3836038467
},
3836138468
"startDate": {
@@ -49171,10 +49278,23 @@
4917149278
"description": "Text of the MongoDB log related to this slow query.",
4917249279
"readOnly": true
4917349280
},
49281+
"metrics": {
49282+
"$ref": "#/components/schemas/PerformanceAdvisorSlowQueryMetrics"
49283+
},
4917449284
"namespace": {
4917549285
"type": "string",
4917649286
"description": "Human-readable label that identifies the namespace on the specified host. The resource expresses this parameter value as `<database>.<collection>`.",
4917749287
"readOnly": true
49288+
},
49289+
"opType": {
49290+
"type": "string",
49291+
"description": "Operation type (read/write/command) associated with this slow query log.",
49292+
"readOnly": true
49293+
},
49294+
"replicaState": {
49295+
"type": "string",
49296+
"description": "Replica state associated with this slow query log.",
49297+
"readOnly": true
4917849298
}
4917949299
},
4918049300
"description": "Details of one slow query that the Performance Advisor detected.",
@@ -49196,6 +49316,76 @@
4919649316
}
4919749317
}
4919849318
},
49319+
"PerformanceAdvisorSlowQueryMetrics": {
49320+
"type": "object",
49321+
"properties": {
49322+
"docsExamined": {
49323+
"type": "integer",
49324+
"description": "The number of documents in the collection that MongoDB scanned in order to carry out the operation.",
49325+
"format": "int64",
49326+
"readOnly": true
49327+
},
49328+
"docsExaminedReturnedRatio": {
49329+
"type": "number",
49330+
"description": "Ratio of documents examined to documents returned.",
49331+
"format": "double",
49332+
"readOnly": true
49333+
},
49334+
"docsReturned": {
49335+
"type": "integer",
49336+
"description": "The number of documents returned by the operation.",
49337+
"format": "int64",
49338+
"readOnly": true
49339+
},
49340+
"fromUserConnection": {
49341+
"type": "boolean",
49342+
"description": "This boolean will be true when the server can identfiy the query source as non-server. This field is only available for MDB 8.0+.",
49343+
"readOnly": true
49344+
},
49345+
"hasIndexCoverage": {
49346+
"type": "boolean",
49347+
"description": "Indicates if the query has index coverage.",
49348+
"readOnly": true
49349+
},
49350+
"hasSort": {
49351+
"type": "boolean",
49352+
"description": "This boolean will be true when a query cannot use the ordering in the index to return the requested sorted results; i.e. MongoDB must sort the documents after it receives the documents from a cursor.",
49353+
"readOnly": true
49354+
},
49355+
"keysExamined": {
49356+
"type": "integer",
49357+
"description": "The number of index keys that MongoDB scanned in order to carry out the operation.",
49358+
"format": "int64",
49359+
"readOnly": true
49360+
},
49361+
"keysExaminedReturnedRatio": {
49362+
"type": "number",
49363+
"description": "Ratio of keys examined to documents returned.",
49364+
"format": "double",
49365+
"readOnly": true
49366+
},
49367+
"numYields": {
49368+
"type": "integer",
49369+
"description": "The number of times the operation yielded to allow other operations to complete.",
49370+
"format": "int64",
49371+
"readOnly": true
49372+
},
49373+
"operationExecutionTime": {
49374+
"type": "integer",
49375+
"description": "Total execution time of a query in milliseconds.",
49376+
"format": "int64",
49377+
"readOnly": true
49378+
},
49379+
"responseLength": {
49380+
"type": "integer",
49381+
"description": "The length in bytes of the operation's result document.",
49382+
"format": "int64",
49383+
"readOnly": true
49384+
}
49385+
},
49386+
"description": "Metrics from a slow query log.",
49387+
"readOnly": true
49388+
},
4919949389
"BasicBSONList": {
4920049390
"type": "array",
4920149391
"description": "List that contains the search criteria that the query uses. To use the values in key-value pairs in these predicates requires **Project Data Access Read Only** permissions or greater. Otherwise, MongoDB Cloud redacts these values.",

0 commit comments

Comments
 (0)