|
1 | 1 | {
|
2 |
| - "openapi": "3.0.1", |
| 2 | + "openapi": "3.0.4", |
3 | 3 | "info": {
|
4 | 4 | "title": "dotnet-monitor",
|
5 | 5 | "version": "1.0"
|
|
187 | 187 | "in": "query",
|
188 | 188 | "description": "The type of dump to capture.",
|
189 | 189 | "schema": {
|
190 |
| - "enum": [ |
191 |
| - "Full", |
192 |
| - "Mini", |
193 |
| - "WithHeap", |
194 |
| - "Triage" |
195 |
| - ], |
196 |
| - "type": "string", |
197 |
| - "default": "WithHeap" |
| 190 | + "$ref": "#/components/schemas/DumpType" |
198 | 191 | }
|
199 | 192 | },
|
200 | 193 | {
|
|
358 | 351 | "in": "query",
|
359 | 352 | "description": "The profiles enabled for the trace session.",
|
360 | 353 | "schema": {
|
361 |
| - "enum": [ |
362 |
| - "Cpu", |
363 |
| - "Http", |
364 |
| - "Logs", |
365 |
| - "Metrics", |
366 |
| - "GcCollect" |
367 |
| - ], |
368 |
| - "type": "string", |
369 |
| - "default": "Cpu, Http, Metrics, GcCollect" |
| 354 | + "$ref": "#/components/schemas/TraceProfile" |
370 | 355 | }
|
371 | 356 | },
|
372 | 357 | {
|
|
1666 | 1651 | "maximum": 2147483647,
|
1667 | 1652 | "minimum": 1,
|
1668 | 1653 | "type": "integer",
|
1669 |
| - "format": "int32", |
1670 |
| - "nullable": true |
| 1654 | + "nullable": true, |
| 1655 | + "format": "int32" |
1671 | 1656 | }
|
1672 | 1657 | },
|
1673 | 1658 | "additionalProperties": false
|
|
1680 | 1665 | },
|
1681 | 1666 | "stateReason": {
|
1682 | 1667 | "type": "string",
|
1683 |
| - "description": "Human-readable explanation for the current state of the collection rule.", |
1684 |
| - "nullable": true |
| 1668 | + "nullable": true, |
| 1669 | + "description": "Human-readable explanation for the current state of the collection rule." |
1685 | 1670 | }
|
1686 | 1671 | },
|
1687 | 1672 | "additionalProperties": false
|
|
1706 | 1691 | },
|
1707 | 1692 | "actionCountSlidingWindowDurationLimit": {
|
1708 | 1693 | "type": "string",
|
| 1694 | + "nullable": true, |
1709 | 1695 | "description": "The sliding window duration in which the actionCountLimit is the maximum number of occurrences (as defined by Limits).",
|
1710 | 1696 | "format": "time-span",
|
1711 |
| - "nullable": true, |
1712 | 1697 | "example": "00:00:30"
|
1713 | 1698 | },
|
1714 | 1699 | "slidingWindowDurationCountdown": {
|
1715 | 1700 | "type": "string",
|
| 1701 | + "nullable": true, |
1716 | 1702 | "description": "The amount of time that needs to pass before the slidingWindowOccurrences drops below the actionCountLimit",
|
1717 | 1703 | "format": "time-span",
|
1718 |
| - "nullable": true, |
1719 | 1704 | "example": "00:00:30"
|
1720 | 1705 | },
|
1721 | 1706 | "ruleFinishedCountdown": {
|
1722 | 1707 | "type": "string",
|
| 1708 | + "nullable": true, |
1723 | 1709 | "description": "The amount of time that needs to pass before the rule is finished",
|
1724 | 1710 | "format": "time-span",
|
1725 |
| - "nullable": true, |
1726 | 1711 | "example": "00:00:30"
|
1727 | 1712 | },
|
1728 | 1713 | "state": {
|
1729 | 1714 | "$ref": "#/components/schemas/CollectionRuleState"
|
1730 | 1715 | },
|
1731 | 1716 | "stateReason": {
|
1732 | 1717 | "type": "string",
|
1733 |
| - "description": "Human-readable explanation for the current state of the collection rule.", |
1734 |
| - "nullable": true |
| 1718 | + "nullable": true, |
| 1719 | + "description": "Human-readable explanation for the current state of the collection rule." |
1735 | 1720 | }
|
1736 | 1721 | },
|
1737 | 1722 | "additionalProperties": false
|
|
1760 | 1745 | "properties": {
|
1761 | 1746 | "version": {
|
1762 | 1747 | "type": "string",
|
1763 |
| - "description": "The dotnet monitor version.", |
1764 |
| - "nullable": true |
| 1748 | + "nullable": true, |
| 1749 | + "description": "The dotnet monitor version." |
1765 | 1750 | },
|
1766 | 1751 | "runtimeVersion": {
|
1767 | 1752 | "type": "string",
|
1768 |
| - "description": "The dotnet runtime version.", |
1769 |
| - "nullable": true |
| 1753 | + "nullable": true, |
| 1754 | + "description": "The dotnet runtime version." |
1770 | 1755 | },
|
1771 | 1756 | "diagnosticPortMode": {
|
1772 | 1757 | "$ref": "#/components/schemas/DiagnosticPortConnectionMode"
|
1773 | 1758 | },
|
1774 | 1759 | "diagnosticPortName": {
|
1775 | 1760 | "type": "string",
|
1776 |
| - "description": "The name of the named pipe or unix domain socket to use for connecting to the diagnostic server.", |
1777 |
| - "nullable": true |
| 1761 | + "nullable": true, |
| 1762 | + "description": "The name of the named pipe or unix domain socket to use for connecting to the diagnostic server." |
1778 | 1763 | },
|
1779 | 1764 | "capabilities": {
|
1780 | 1765 | "type": "array",
|
| 1766 | + "nullable": true, |
1781 | 1767 | "items": {
|
1782 | 1768 | "$ref": "#/components/schemas/MonitorCapability"
|
1783 | 1769 | },
|
1784 |
| - "description": "The capabilities provided by dotnet-monitor.", |
1785 |
| - "nullable": true |
| 1770 | + "description": "The capabilities provided by dotnet-monitor." |
1786 | 1771 | }
|
1787 | 1772 | },
|
1788 | 1773 | "additionalProperties": false
|
1789 | 1774 | },
|
| 1775 | + "DumpType": { |
| 1776 | + "enum": [ |
| 1777 | + "Full", |
| 1778 | + "Mini", |
| 1779 | + "WithHeap", |
| 1780 | + "Triage" |
| 1781 | + ], |
| 1782 | + "type": "string", |
| 1783 | + "default": "WithHeap" |
| 1784 | + }, |
1790 | 1785 | "EventLevel": {
|
1791 | 1786 | "enum": [
|
1792 | 1787 | "LogAlways",
|
|
1806 | 1801 | },
|
1807 | 1802 | "providers": {
|
1808 | 1803 | "type": "array",
|
| 1804 | + "nullable": true, |
1809 | 1805 | "items": {
|
1810 | 1806 | "$ref": "#/components/schemas/EventMetricsProvider"
|
1811 |
| - }, |
1812 |
| - "nullable": true |
| 1807 | + } |
1813 | 1808 | },
|
1814 | 1809 | "meters": {
|
1815 | 1810 | "type": "array",
|
| 1811 | + "nullable": true, |
1816 | 1812 | "items": {
|
1817 | 1813 | "$ref": "#/components/schemas/EventMetricsMeter"
|
1818 |
| - }, |
1819 |
| - "nullable": true |
| 1814 | + } |
1820 | 1815 | }
|
1821 | 1816 | },
|
1822 | 1817 | "additionalProperties": false
|
|
1833 | 1828 | },
|
1834 | 1829 | "instrumentNames": {
|
1835 | 1830 | "type": "array",
|
| 1831 | + "nullable": true, |
1836 | 1832 | "items": {
|
1837 | 1833 | "type": "string"
|
1838 |
| - }, |
1839 |
| - "nullable": true |
| 1834 | + } |
1840 | 1835 | }
|
1841 | 1836 | },
|
1842 | 1837 | "additionalProperties": false
|
|
1853 | 1848 | },
|
1854 | 1849 | "counterNames": {
|
1855 | 1850 | "type": "array",
|
| 1851 | + "nullable": true, |
1856 | 1852 | "items": {
|
1857 | 1853 | "type": "string"
|
1858 |
| - }, |
1859 |
| - "nullable": true |
| 1854 | + } |
1860 | 1855 | }
|
1861 | 1856 | },
|
1862 | 1857 | "additionalProperties": false
|
|
1905 | 1900 | },
|
1906 | 1901 | "arguments": {
|
1907 | 1902 | "type": "object",
|
| 1903 | + "nullable": true, |
1908 | 1904 | "additionalProperties": {
|
1909 | 1905 | "type": "string"
|
1910 |
| - }, |
1911 |
| - "nullable": true |
| 1906 | + } |
1912 | 1907 | }
|
1913 | 1908 | },
|
1914 | 1909 | "additionalProperties": false
|
|
1940 | 1935 | "properties": {
|
1941 | 1936 | "include": {
|
1942 | 1937 | "type": "array",
|
| 1938 | + "nullable": true, |
1943 | 1939 | "items": {
|
1944 | 1940 | "$ref": "#/components/schemas/ExceptionFilter"
|
1945 |
| - }, |
1946 |
| - "nullable": true |
| 1941 | + } |
1947 | 1942 | },
|
1948 | 1943 | "exclude": {
|
1949 | 1944 | "type": "array",
|
| 1945 | + "nullable": true, |
1950 | 1946 | "items": {
|
1951 | 1947 | "$ref": "#/components/schemas/ExceptionFilter"
|
1952 |
| - }, |
1953 |
| - "nullable": true |
| 1948 | + } |
1954 | 1949 | }
|
1955 | 1950 | },
|
1956 | 1951 | "additionalProperties": false
|
|
1978 | 1973 | },
|
1979 | 1974 | "filterSpecs": {
|
1980 | 1975 | "type": "object",
|
| 1976 | + "nullable": true, |
1981 | 1977 | "additionalProperties": {
|
1982 |
| - "$ref": "#/components/schemas/LogLevel" |
| 1978 | + "$ref": "#/components/schemas/NullableOfLogLevel" |
1983 | 1979 | },
|
1984 |
| - "description": "The logger categories and levels at which logs are collected. Setting the log level to null will have logs collected from the corresponding category at the level set in the LogLevel property.", |
1985 |
| - "nullable": true |
| 1980 | + "description": "The logger categories and levels at which logs are collected. Setting the log level to null will have logs collected from the corresponding category at the level set in the LogLevel property." |
1986 | 1981 | },
|
1987 | 1982 | "useAppFilters": {
|
1988 | 1983 | "type": "boolean",
|
|
2031 | 2026 | },
|
2032 | 2027 | "additionalProperties": false
|
2033 | 2028 | },
|
| 2029 | + "NullableOfLogLevel": { |
| 2030 | + "enum": [ |
| 2031 | + "Trace", |
| 2032 | + "Debug", |
| 2033 | + "Information", |
| 2034 | + "Warning", |
| 2035 | + "Error", |
| 2036 | + "Critical", |
| 2037 | + "None" |
| 2038 | + ], |
| 2039 | + "type": "string", |
| 2040 | + "nullable": true |
| 2041 | + }, |
2034 | 2042 | "OperationError": {
|
2035 | 2043 | "type": "object",
|
| 2044 | + "nullable": true, |
2036 | 2045 | "properties": {
|
2037 | 2046 | "code": {
|
2038 | 2047 | "type": "string",
|
|
2043 | 2052 | "nullable": true
|
2044 | 2053 | }
|
2045 | 2054 | },
|
2046 |
| - "additionalProperties": false, |
2047 |
| - "nullable": true |
| 2055 | + "additionalProperties": false |
2048 | 2056 | },
|
2049 | 2057 | "OperationProcessInfo": {
|
2050 | 2058 | "type": "object",
|
| 2059 | + "nullable": true, |
2051 | 2060 | "properties": {
|
2052 | 2061 | "pid": {
|
2053 | 2062 | "type": "integer",
|
|
2063 | 2072 | }
|
2064 | 2073 | },
|
2065 | 2074 | "additionalProperties": false,
|
2066 |
| - "description": "Represents the details of a given process used in an operation.", |
2067 |
| - "nullable": true |
| 2075 | + "description": "Represents the details of a given process used in an operation." |
2068 | 2076 | },
|
2069 | 2077 | "OperationState": {
|
2070 | 2078 | "enum": [
|
|
2111 | 2119 | "tags": {
|
2112 | 2120 | "uniqueItems": true,
|
2113 | 2121 | "type": "array",
|
| 2122 | + "nullable": true, |
2114 | 2123 | "items": {
|
2115 | 2124 | "type": "string"
|
2116 |
| - }, |
2117 |
| - "nullable": true |
| 2125 | + } |
2118 | 2126 | }
|
2119 | 2127 | },
|
2120 | 2128 | "additionalProperties": false,
|
|
2147 | 2155 | "tags": {
|
2148 | 2156 | "uniqueItems": true,
|
2149 | 2157 | "type": "array",
|
| 2158 | + "nullable": true, |
2150 | 2159 | "items": {
|
2151 | 2160 | "type": "string"
|
2152 |
| - }, |
2153 |
| - "nullable": true |
| 2161 | + } |
2154 | 2162 | }
|
2155 | 2163 | },
|
2156 | 2164 | "additionalProperties": false,
|
|
2169 | 2177 | },
|
2170 | 2178 | "status": {
|
2171 | 2179 | "type": "integer",
|
2172 |
| - "format": "int32", |
2173 |
| - "nullable": true |
| 2180 | + "nullable": true, |
| 2181 | + "format": "int32" |
2174 | 2182 | },
|
2175 | 2183 | "detail": {
|
2176 | 2184 | "type": "string",
|
|
2238 | 2246 | },
|
2239 | 2247 | "additionalProperties": false
|
2240 | 2248 | },
|
| 2249 | + "TraceProfile": { |
| 2250 | + "enum": [ |
| 2251 | + "Cpu", |
| 2252 | + "Http", |
| 2253 | + "Logs", |
| 2254 | + "Metrics", |
| 2255 | + "GcCollect" |
| 2256 | + ], |
| 2257 | + "type": "string", |
| 2258 | + "default": "Cpu, Http, Metrics, GcCollect" |
| 2259 | + }, |
2241 | 2260 | "ValidationProblemDetails": {
|
2242 | 2261 | "type": "object",
|
2243 | 2262 | "properties": {
|
|
2251 | 2270 | },
|
2252 | 2271 | "status": {
|
2253 | 2272 | "type": "integer",
|
2254 |
| - "format": "int32", |
2255 |
| - "nullable": true |
| 2273 | + "nullable": true, |
| 2274 | + "format": "int32" |
2256 | 2275 | },
|
2257 | 2276 | "detail": {
|
2258 | 2277 | "type": "string",
|
|
2264 | 2283 | },
|
2265 | 2284 | "errors": {
|
2266 | 2285 | "type": "object",
|
| 2286 | + "nullable": true, |
2267 | 2287 | "additionalProperties": {
|
2268 | 2288 | "type": "array",
|
2269 | 2289 | "items": {
|
2270 | 2290 | "type": "string"
|
2271 | 2291 | }
|
2272 |
| - }, |
2273 |
| - "nullable": true |
| 2292 | + } |
2274 | 2293 | }
|
2275 | 2294 | },
|
2276 | 2295 | "additionalProperties": { }
|
|
0 commit comments