@meshery/schemas 1.3.28 → 1.3.30

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (96) hide show
  1. package/dist/cloudApi.d.mts +3420 -3186
  2. package/dist/cloudApi.d.ts +3420 -3186
  3. package/dist/constructs/v1beta2/academy/Academy.d.ts +2 -2
  4. package/dist/constructs/v1beta2/academy/AcademySchema.js +1 -1
  5. package/dist/constructs/v1beta2/academy/AcademySchema.mjs +1 -1
  6. package/dist/constructs/v1beta2/core/Core.d.ts +2 -2
  7. package/dist/constructs/v1beta2/core/CoreSchema.js +1 -1
  8. package/dist/constructs/v1beta2/core/CoreSchema.mjs +1 -1
  9. package/dist/constructs/v1beta2/credential/Credential.d.ts +4 -4
  10. package/dist/constructs/v1beta2/credential/CredentialSchema.js +2 -2
  11. package/dist/constructs/v1beta2/credential/CredentialSchema.mjs +2 -2
  12. package/dist/constructs/v1beta2/design/Design.d.ts +12 -12
  13. package/dist/constructs/v1beta2/design/DesignSchema.js +5 -5
  14. package/dist/constructs/v1beta2/design/DesignSchema.mjs +5 -5
  15. package/dist/constructs/v1beta2/event/Event.d.ts +10 -10
  16. package/dist/constructs/v1beta2/event/EventSchema.js +1 -1
  17. package/dist/constructs/v1beta2/event/EventSchema.mjs +1 -1
  18. package/dist/constructs/v1beta2/invitation/Invitation.d.ts +2 -2
  19. package/dist/constructs/v1beta2/invitation/InvitationSchema.js +1 -1
  20. package/dist/constructs/v1beta2/invitation/InvitationSchema.mjs +1 -1
  21. package/dist/constructs/v1beta2/key/Key.d.ts +6 -6
  22. package/dist/constructs/v1beta2/key/KeySchema.js +1 -1
  23. package/dist/constructs/v1beta2/key/KeySchema.mjs +1 -1
  24. package/dist/constructs/v1beta2/keychain/Keychain.d.ts +6 -6
  25. package/dist/constructs/v1beta2/keychain/KeychainSchema.js +1 -1
  26. package/dist/constructs/v1beta2/keychain/KeychainSchema.mjs +1 -1
  27. package/dist/constructs/v1beta2/organization/Organization.d.ts +14 -0
  28. package/dist/constructs/v1beta2/organization/OrganizationSchema.js +1 -1
  29. package/dist/constructs/v1beta2/organization/OrganizationSchema.mjs +1 -1
  30. package/dist/constructs/v1beta2/plan/Plan.d.ts +2 -2
  31. package/dist/constructs/v1beta2/plan/PlanSchema.js +1 -1
  32. package/dist/constructs/v1beta2/plan/PlanSchema.mjs +1 -1
  33. package/dist/constructs/v1beta2/role/Role.d.ts +6 -6
  34. package/dist/constructs/v1beta2/role/RoleSchema.js +1 -1
  35. package/dist/constructs/v1beta2/role/RoleSchema.mjs +1 -1
  36. package/dist/constructs/v1beta2/schedule/Schedule.d.ts +4 -4
  37. package/dist/constructs/v1beta2/schedule/ScheduleSchema.js +2 -2
  38. package/dist/constructs/v1beta2/schedule/ScheduleSchema.mjs +2 -2
  39. package/dist/constructs/v1beta2/subscription/Subscription.d.ts +4 -4
  40. package/dist/constructs/v1beta2/subscription/SubscriptionSchema.js +1 -1
  41. package/dist/constructs/v1beta2/subscription/SubscriptionSchema.mjs +1 -1
  42. package/dist/constructs/v1beta2/team/Team.d.ts +16 -41
  43. package/dist/constructs/v1beta2/team/TeamSchema.js +1 -1
  44. package/dist/constructs/v1beta2/team/TeamSchema.mjs +1 -1
  45. package/dist/constructs/v1beta2/token/Token.d.ts +4 -4
  46. package/dist/constructs/v1beta2/token/TokenSchema.js +1 -1
  47. package/dist/constructs/v1beta2/token/TokenSchema.mjs +1 -1
  48. package/dist/constructs/v1beta2/user/User.d.ts +6 -6
  49. package/dist/constructs/v1beta2/user/UserSchema.js +1 -1
  50. package/dist/constructs/v1beta2/user/UserSchema.mjs +1 -1
  51. package/dist/constructs/v1beta2/view/View.d.ts +4 -4
  52. package/dist/constructs/v1beta2/view/ViewSchema.js +2 -2
  53. package/dist/constructs/v1beta2/view/ViewSchema.mjs +2 -2
  54. package/dist/constructs/v1beta3/academy/Academy.d.ts +767 -3
  55. package/dist/constructs/v1beta3/academy/AcademySchema.js +3 -1
  56. package/dist/constructs/v1beta3/academy/AcademySchema.mjs +3 -1
  57. package/dist/constructs/v1beta3/design/Design.d.ts +5 -5
  58. package/dist/constructs/v1beta3/design/DesignSchema.js +5 -5
  59. package/dist/constructs/v1beta3/design/DesignSchema.mjs +5 -5
  60. package/dist/constructs/v1beta3/environment/Environment.d.ts +6 -6
  61. package/dist/constructs/v1beta3/environment/EnvironmentSchema.js +1 -1
  62. package/dist/constructs/v1beta3/environment/EnvironmentSchema.mjs +1 -1
  63. package/dist/constructs/v1beta3/event/Event.d.ts +11 -11
  64. package/dist/constructs/v1beta3/event/EventSchema.js +1 -1
  65. package/dist/constructs/v1beta3/event/EventSchema.mjs +1 -1
  66. package/dist/constructs/v1beta3/filter/Filter.d.ts +2 -2
  67. package/dist/constructs/v1beta3/filter/FilterSchema.js +2 -2
  68. package/dist/constructs/v1beta3/filter/FilterSchema.mjs +2 -2
  69. package/dist/constructs/v1beta3/invitation/Invitation.d.ts +4 -4
  70. package/dist/constructs/v1beta3/invitation/InvitationSchema.js +1 -1
  71. package/dist/constructs/v1beta3/invitation/InvitationSchema.mjs +1 -1
  72. package/dist/constructs/v1beta3/pattern_resource/PatternResource.d.ts +2 -2
  73. package/dist/constructs/v1beta3/pattern_resource/PatternResourceSchema.js +2 -2
  74. package/dist/constructs/v1beta3/pattern_resource/PatternResourceSchema.mjs +2 -2
  75. package/dist/constructs/v1beta3/performance_profile/PerformanceProfile.d.ts +4 -4
  76. package/dist/constructs/v1beta3/performance_profile/PerformanceProfileSchema.js +1 -1
  77. package/dist/constructs/v1beta3/performance_profile/PerformanceProfileSchema.mjs +1 -1
  78. package/dist/constructs/v1beta3/plan/Plan.d.ts +2 -2
  79. package/dist/constructs/v1beta3/plan/PlanSchema.js +1 -1
  80. package/dist/constructs/v1beta3/plan/PlanSchema.mjs +1 -1
  81. package/dist/constructs/v1beta3/subscription/Subscription.d.ts +4 -4
  82. package/dist/constructs/v1beta3/subscription/SubscriptionSchema.js +1 -1
  83. package/dist/constructs/v1beta3/subscription/SubscriptionSchema.mjs +1 -1
  84. package/dist/constructs/v1beta3/token/Token.d.ts +4 -4
  85. package/dist/constructs/v1beta3/token/TokenSchema.js +1 -1
  86. package/dist/constructs/v1beta3/token/TokenSchema.mjs +1 -1
  87. package/dist/constructs/v1beta3/workspace/Workspace.d.ts +12 -12
  88. package/dist/constructs/v1beta3/workspace/WorkspaceSchema.js +2 -2
  89. package/dist/constructs/v1beta3/workspace/WorkspaceSchema.mjs +2 -2
  90. package/dist/index.d.mts +14 -8
  91. package/dist/index.d.ts +14 -8
  92. package/dist/index.js +6 -6
  93. package/dist/index.mjs +6 -6
  94. package/dist/mesheryApi.d.mts +1407 -1399
  95. package/dist/mesheryApi.d.ts +1407 -1399
  96. package/package.json +1 -1
@@ -1699,6 +1699,389 @@ export interface components {
1699
1699
  };
1700
1700
  }[];
1701
1701
  };
1702
+ /** @description Aggregate metrics for the instructor console, mirroring the deployed handler's InstructorConsoleSummary struct. */
1703
+ InstructorConsoleSummary: {
1704
+ /** @description Academy module configuration for the organization. */
1705
+ orgConfig?: {
1706
+ /** @description Academy module assigned to the organization. */
1707
+ module?: string;
1708
+ /** @description Version of the assigned academy module. */
1709
+ version?: string;
1710
+ };
1711
+ /** @description Total distinct learners registered for the organization. */
1712
+ totalLearners?: number;
1713
+ /** @description Learners with at least one active registration. */
1714
+ totalActiveLearners?: number;
1715
+ /** @description Per-content-type registration counts. */
1716
+ curricula?: {
1717
+ /** @description Academy content type. */
1718
+ type?: string;
1719
+ /** @description Registrations for this content type. */
1720
+ totalCount?: number;
1721
+ }[];
1722
+ /** @description Per-status registration counts. */
1723
+ registrationsSummary?: {
1724
+ /** @description Registration status. */
1725
+ status?: string;
1726
+ /** @description Registrations in this status. */
1727
+ totalCount?: number;
1728
+ }[];
1729
+ /** @description Aggregate test outcomes across the organization. */
1730
+ testsSummary?: {
1731
+ totalPassed?: number;
1732
+ totalFailed?: number;
1733
+ totalAttempts?: number;
1734
+ };
1735
+ /** @description Per-test outcome counts. */
1736
+ tests?: {
1737
+ /** @description The test the counts refer to. */
1738
+ test?: {
1739
+ /**
1740
+ * Format: uuid
1741
+ * @description Quiz ID.
1742
+ */
1743
+ id: string;
1744
+ /**
1745
+ * Format: uuid
1746
+ * @description Organization ID that owns this quiz
1747
+ * @example meshery
1748
+ */
1749
+ orgId: string;
1750
+ /**
1751
+ * @description Indicates if the quiz is final . i.e this quiz will used to evaluate the completion of parent section eg course , module , learning path
1752
+ * @example true
1753
+ */
1754
+ final: boolean;
1755
+ /** @description The title of the quiz. */
1756
+ title: string;
1757
+ /** @description Description of the quiz. */
1758
+ description: string;
1759
+ /** @description The slug of the quiz. */
1760
+ slug: string;
1761
+ /** @description The rel permalink of the quiz. */
1762
+ relPermalink: string;
1763
+ /** @description The permalink of the quiz. */
1764
+ permalink: string;
1765
+ /** @description Type of the resource. */
1766
+ type: string;
1767
+ /** @description The section of the quiz. */
1768
+ section: string;
1769
+ /** @description The layout of the quiz. */
1770
+ layout: string;
1771
+ /**
1772
+ * Format: date
1773
+ * @description The date of the quiz.
1774
+ */
1775
+ date: string;
1776
+ /**
1777
+ * Format: date
1778
+ * @description The lastmod of the quiz.
1779
+ */
1780
+ lastmod: string;
1781
+ /** @description The draft of the quiz. */
1782
+ draft: boolean;
1783
+ /** @description The file path of the quiz. */
1784
+ filePath: string;
1785
+ /**
1786
+ * Format: float
1787
+ * @description The pass percentage of the quiz.
1788
+ */
1789
+ passPercentage: number;
1790
+ /** @description Time limit for the quiz in minutes. A value of 0 indicates no time limit. */
1791
+ timeLimit: number;
1792
+ /** @description Maximum number of attempts allowed for the quiz. A value of 0 indicates unlimited attempts. */
1793
+ maxAttempts: number;
1794
+ /** @description The questions of the quiz. */
1795
+ questions: {
1796
+ /**
1797
+ * Format: uuid
1798
+ * @description Question ID.
1799
+ */
1800
+ id: string;
1801
+ /** @description The text of the question. */
1802
+ text: string;
1803
+ /** @enum {string} */
1804
+ type: "multiple-answers" | "single-answer" | "short-answer" | "essay";
1805
+ /** @description The marks of the question. */
1806
+ marks: number;
1807
+ /** @description The multiple answers of the question. */
1808
+ multipleAnswers?: boolean;
1809
+ /** @description The options of the question. */
1810
+ options: {
1811
+ /**
1812
+ * Format: uuid
1813
+ * @description QuestionOption ID.
1814
+ */
1815
+ id: string;
1816
+ /** @description The text of the questionoption. */
1817
+ text: string;
1818
+ /** @description The is correct of the questionoption. */
1819
+ isCorrect: boolean;
1820
+ }[];
1821
+ /** @description The correct answer of the question. */
1822
+ correctAnswer: string;
1823
+ }[];
1824
+ /** @description The total questions of the quiz. */
1825
+ totalQuestions: number;
1826
+ /** @description The total questions in bank of the quiz. */
1827
+ totalQuestionsInBank: number;
1828
+ /** @description The total question sets of the quiz. */
1829
+ totalQuestionSets: number;
1830
+ /** @description The total marks of the quiz. */
1831
+ totalMarks: number;
1832
+ /** @description The prerequisites of the quiz. */
1833
+ prerequisites: {
1834
+ /**
1835
+ * Format: uuid
1836
+ * @description Parent ID.
1837
+ */
1838
+ id: string;
1839
+ /** @description The title of the parent. */
1840
+ title: string;
1841
+ /** @description The rel permalink of the parent. */
1842
+ relPermalink: string;
1843
+ /** @description Type of the resource. */
1844
+ type: string;
1845
+ }[];
1846
+ parent?: {
1847
+ /**
1848
+ * Format: uuid
1849
+ * @description Parent ID.
1850
+ */
1851
+ id: string;
1852
+ /** @description The title of the parent. */
1853
+ title: string;
1854
+ /** @description The rel permalink of the parent. */
1855
+ relPermalink: string;
1856
+ /** @description Type of the resource. */
1857
+ type: string;
1858
+ };
1859
+ nextPage: {
1860
+ /**
1861
+ * Format: uuid
1862
+ * @description Parent ID.
1863
+ */
1864
+ id: string;
1865
+ /** @description The title of the parent. */
1866
+ title: string;
1867
+ /** @description The rel permalink of the parent. */
1868
+ relPermalink: string;
1869
+ /** @description Type of the resource. */
1870
+ type: string;
1871
+ };
1872
+ };
1873
+ passed?: number;
1874
+ failed?: number;
1875
+ attempts?: number;
1876
+ }[];
1877
+ /** @description Curricula with metrics for the organization. */
1878
+ curriculaList?: {
1879
+ /**
1880
+ * @description Total number of Curricula
1881
+ * @example 7
1882
+ */
1883
+ total: number;
1884
+ /** @description The data of the academycurriculawithmetricslistresponse. */
1885
+ data: ({
1886
+ /**
1887
+ * Format: uuid
1888
+ * @description Id of the Curricula
1889
+ * @example 923458-3490394-934893
1890
+ */
1891
+ id: string;
1892
+ /** @enum {string} */
1893
+ type: "learning-path" | "challenge" | "certification";
1894
+ /**
1895
+ * @description Organization ID that owns this learning path
1896
+ * @example meshery
1897
+ */
1898
+ orgId: string;
1899
+ /**
1900
+ * @description Visibility of the Curricula
1901
+ * @enum {string}
1902
+ */
1903
+ visibility: "public" | "private";
1904
+ /**
1905
+ * @description Status of the Curricula
1906
+ * @example ready
1907
+ * @enum {string}
1908
+ */
1909
+ status: "ready" | "archived" | "not_ready";
1910
+ /**
1911
+ * @description slug of the Curricula
1912
+ * @example intro-kubernetes-course
1913
+ */
1914
+ slug: string;
1915
+ /**
1916
+ * @description Level of the Curricula
1917
+ * @enum {string}
1918
+ */
1919
+ level: "beginner" | "intermediate" | "advanced";
1920
+ /**
1921
+ * Format: uuid
1922
+ * @description ID of the badge to be awarded on completion of this curricula
1923
+ */
1924
+ badgeId?: string;
1925
+ /** @description ID of the invite associated with this Curricula */
1926
+ inviteId?: string;
1927
+ /** @description ID of the workspace to which this Curricula belongs */
1928
+ workspaceId?: string;
1929
+ /** @description When the Curricula item was created */
1930
+ createdAt: string;
1931
+ /** @description When the Curricula was last updated */
1932
+ updatedAt: string;
1933
+ deletedAt: string;
1934
+ /** @description Additional metadata about the Curricula */
1935
+ metadata: {
1936
+ [key: string]: unknown;
1937
+ } & {
1938
+ /**
1939
+ * @description Title of the learning path
1940
+ * @example Mastering Kubernetes for Engineers
1941
+ */
1942
+ title: string;
1943
+ /**
1944
+ * @description Short description of the curricula
1945
+ * @example Learn how to configure your Kubernetes clusters and manage the lifecycle of your workloads
1946
+ */
1947
+ description: string;
1948
+ /**
1949
+ * @description Detailed description of the curricula
1950
+ * @example This learning path covers everything from Kubernetes architecture to advanced deployment strategies, including hands-on labs and real-world scenarios.
1951
+ */
1952
+ detailedDescription?: string;
1953
+ /**
1954
+ * Format: uri
1955
+ * @description Filename of the banner image, which should be placed in the same directory as the _index.md file
1956
+ * @example kubernetes-icon.svg
1957
+ */
1958
+ banner?: string | null;
1959
+ /**
1960
+ * Format: uri
1961
+ * @description Canonical URL for the learning path
1962
+ * @example http://localhost:9876/academy/learning-paths/meshery/mastering-kubernetes-for-engineers/
1963
+ */
1964
+ permalink: string;
1965
+ certificate?: {
1966
+ /**
1967
+ * Format: uuid
1968
+ * @description Unique identifier for the certificate
1969
+ * @example 550e8400-e29b-41d4-a716-446655440000
1970
+ */
1971
+ id: string;
1972
+ /**
1973
+ * Format: uuid
1974
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
1975
+ */
1976
+ orgId: string;
1977
+ /**
1978
+ * Format: uuid
1979
+ * @description ID of the recipient (user) who received the certificate
1980
+ * @example 550e8400-e29b-41d4-a716-446655440001
1981
+ */
1982
+ recipientId: string;
1983
+ /**
1984
+ * @description Name of the recipient (user) who received the certificate
1985
+ * @example John Doe
1986
+ */
1987
+ recipientName: string;
1988
+ /**
1989
+ * @description Title of the certificate
1990
+ * @example Kubernetes Expert Certification
1991
+ */
1992
+ title: string;
1993
+ /**
1994
+ * @description Description of the certificate
1995
+ * @example Awarded for successfully completing the Kubernetes Expert course
1996
+ */
1997
+ description: string;
1998
+ /** @description List of issuing authorities for the certificate */
1999
+ issuingAuthorities: {
2000
+ /**
2001
+ * @description Name of the issuing authority
2002
+ * @example Cloud Native Foundation
2003
+ */
2004
+ name: string;
2005
+ /**
2006
+ * @description Role of the issuing authority
2007
+ * @example COO
2008
+ */
2009
+ role?: string;
2010
+ /**
2011
+ * Format: uri
2012
+ * @description URL to the signature image of the issuing authority should be a publicly accessible URL and transparent PNG or SVG format
2013
+ * @example http://localhost:9876/signatures/cloud-native-foundation.png
2014
+ */
2015
+ signatureUrl?: string;
2016
+ }[];
2017
+ /**
2018
+ * Format: date-time
2019
+ * @description Date when the certificate was issued
2020
+ * @example 2023-10-01 12:00:00+00:00
2021
+ */
2022
+ issuedDate: string;
2023
+ /**
2024
+ * Format: date-time
2025
+ * @description Date when the certificate expires. Dynamically calculated from issued_date and expires_in; not specified by instructors.
2026
+ * @example 2025-10-01 12:00:00+00:00
2027
+ */
2028
+ expirationDate?: string;
2029
+ /**
2030
+ * @description Number of months after which the certificate expires
2031
+ * @example 24
2032
+ */
2033
+ expiresIn?: number;
2034
+ };
2035
+ /** @description List of children items in the top-level curricula */
2036
+ children?: {
2037
+ /**
2038
+ * Format: uuid
2039
+ * @description Unique identifier for the course
2040
+ * @example 550e8400-e29b-41d4-a716-446655440002
2041
+ */
2042
+ id: string;
2043
+ /**
2044
+ * @description Title of the course
2045
+ * @example Kubernetes Basics
2046
+ */
2047
+ title: string;
2048
+ /**
2049
+ * Format: uri
2050
+ * @description URL to the course content
2051
+ * @example http://localhost:9876/academy/learning-paths/meshery/intro-kubernetes-course/kubernetes/
2052
+ */
2053
+ permalink: string;
2054
+ /**
2055
+ * @description Course description
2056
+ * @example Learn the basics of Kubernetes
2057
+ */
2058
+ description: string;
2059
+ /**
2060
+ * @description A numeric value to determine the display order. A smaller number appears first. If not specified, items will be sorted alphabetically by title.
2061
+ * @example eg 1 , 2
2062
+ */
2063
+ weight?: number;
2064
+ /**
2065
+ * Format: uri
2066
+ * @description Filename of the banner image, which should be placed in the same directory as the _index.md file
2067
+ * @example kubernetes-icon.svg
2068
+ */
2069
+ banner?: string | null;
2070
+ /**
2071
+ * @description Type of the content (e.g., learning-path, challenge, certification)
2072
+ * @enum {string}
2073
+ */
2074
+ type?: "learning-path" | "challenge" | "certification";
2075
+ /** @description List of child nodes (sub-courses or modules) */
2076
+ children?: Record<string, never>[];
2077
+ }[];
2078
+ };
2079
+ } & {
2080
+ /** @description Number of registrations associated with this curriculum. */
2081
+ registrationCount: number;
2082
+ })[];
2083
+ };
2084
+ };
1702
2085
  AcademyCurriculaWithMetricsListResponse: {
1703
2086
  /**
1704
2087
  * @description Total number of Curricula
@@ -7629,9 +8012,9 @@ export interface operations {
7629
8012
  parameters: {
7630
8013
  query?: {
7631
8014
  /** @description Get responses by page */
7632
- page?: string;
8015
+ page?: number;
7633
8016
  /** @description Get responses by pagesize */
7634
- pagesize?: string;
8017
+ pagesize?: number;
7635
8018
  /** @description Filter tests by absolute path */
7636
8019
  testAbsPath?: string;
7637
8020
  };
@@ -8119,7 +8502,388 @@ export interface operations {
8119
8502
  [name: string]: unknown;
8120
8503
  };
8121
8504
  content: {
8122
- "application/json": Record<string, never>;
8505
+ "application/json": {
8506
+ /** @description Academy module configuration for the organization. */
8507
+ orgConfig?: {
8508
+ /** @description Academy module assigned to the organization. */
8509
+ module?: string;
8510
+ /** @description Version of the assigned academy module. */
8511
+ version?: string;
8512
+ };
8513
+ /** @description Total distinct learners registered for the organization. */
8514
+ totalLearners?: number;
8515
+ /** @description Learners with at least one active registration. */
8516
+ totalActiveLearners?: number;
8517
+ /** @description Per-content-type registration counts. */
8518
+ curricula?: {
8519
+ /** @description Academy content type. */
8520
+ type?: string;
8521
+ /** @description Registrations for this content type. */
8522
+ totalCount?: number;
8523
+ }[];
8524
+ /** @description Per-status registration counts. */
8525
+ registrationsSummary?: {
8526
+ /** @description Registration status. */
8527
+ status?: string;
8528
+ /** @description Registrations in this status. */
8529
+ totalCount?: number;
8530
+ }[];
8531
+ /** @description Aggregate test outcomes across the organization. */
8532
+ testsSummary?: {
8533
+ totalPassed?: number;
8534
+ totalFailed?: number;
8535
+ totalAttempts?: number;
8536
+ };
8537
+ /** @description Per-test outcome counts. */
8538
+ tests?: {
8539
+ /** @description The test the counts refer to. */
8540
+ test?: {
8541
+ /**
8542
+ * Format: uuid
8543
+ * @description Quiz ID.
8544
+ */
8545
+ id: string;
8546
+ /**
8547
+ * Format: uuid
8548
+ * @description Organization ID that owns this quiz
8549
+ * @example meshery
8550
+ */
8551
+ orgId: string;
8552
+ /**
8553
+ * @description Indicates if the quiz is final . i.e this quiz will used to evaluate the completion of parent section eg course , module , learning path
8554
+ * @example true
8555
+ */
8556
+ final: boolean;
8557
+ /** @description The title of the quiz. */
8558
+ title: string;
8559
+ /** @description Description of the quiz. */
8560
+ description: string;
8561
+ /** @description The slug of the quiz. */
8562
+ slug: string;
8563
+ /** @description The rel permalink of the quiz. */
8564
+ relPermalink: string;
8565
+ /** @description The permalink of the quiz. */
8566
+ permalink: string;
8567
+ /** @description Type of the resource. */
8568
+ type: string;
8569
+ /** @description The section of the quiz. */
8570
+ section: string;
8571
+ /** @description The layout of the quiz. */
8572
+ layout: string;
8573
+ /**
8574
+ * Format: date
8575
+ * @description The date of the quiz.
8576
+ */
8577
+ date: string;
8578
+ /**
8579
+ * Format: date
8580
+ * @description The lastmod of the quiz.
8581
+ */
8582
+ lastmod: string;
8583
+ /** @description The draft of the quiz. */
8584
+ draft: boolean;
8585
+ /** @description The file path of the quiz. */
8586
+ filePath: string;
8587
+ /**
8588
+ * Format: float
8589
+ * @description The pass percentage of the quiz.
8590
+ */
8591
+ passPercentage: number;
8592
+ /** @description Time limit for the quiz in minutes. A value of 0 indicates no time limit. */
8593
+ timeLimit: number;
8594
+ /** @description Maximum number of attempts allowed for the quiz. A value of 0 indicates unlimited attempts. */
8595
+ maxAttempts: number;
8596
+ /** @description The questions of the quiz. */
8597
+ questions: {
8598
+ /**
8599
+ * Format: uuid
8600
+ * @description Question ID.
8601
+ */
8602
+ id: string;
8603
+ /** @description The text of the question. */
8604
+ text: string;
8605
+ /** @enum {string} */
8606
+ type: "multiple-answers" | "single-answer" | "short-answer" | "essay";
8607
+ /** @description The marks of the question. */
8608
+ marks: number;
8609
+ /** @description The multiple answers of the question. */
8610
+ multipleAnswers?: boolean;
8611
+ /** @description The options of the question. */
8612
+ options: {
8613
+ /**
8614
+ * Format: uuid
8615
+ * @description QuestionOption ID.
8616
+ */
8617
+ id: string;
8618
+ /** @description The text of the questionoption. */
8619
+ text: string;
8620
+ /** @description The is correct of the questionoption. */
8621
+ isCorrect: boolean;
8622
+ }[];
8623
+ /** @description The correct answer of the question. */
8624
+ correctAnswer: string;
8625
+ }[];
8626
+ /** @description The total questions of the quiz. */
8627
+ totalQuestions: number;
8628
+ /** @description The total questions in bank of the quiz. */
8629
+ totalQuestionsInBank: number;
8630
+ /** @description The total question sets of the quiz. */
8631
+ totalQuestionSets: number;
8632
+ /** @description The total marks of the quiz. */
8633
+ totalMarks: number;
8634
+ /** @description The prerequisites of the quiz. */
8635
+ prerequisites: {
8636
+ /**
8637
+ * Format: uuid
8638
+ * @description Parent ID.
8639
+ */
8640
+ id: string;
8641
+ /** @description The title of the parent. */
8642
+ title: string;
8643
+ /** @description The rel permalink of the parent. */
8644
+ relPermalink: string;
8645
+ /** @description Type of the resource. */
8646
+ type: string;
8647
+ }[];
8648
+ parent?: {
8649
+ /**
8650
+ * Format: uuid
8651
+ * @description Parent ID.
8652
+ */
8653
+ id: string;
8654
+ /** @description The title of the parent. */
8655
+ title: string;
8656
+ /** @description The rel permalink of the parent. */
8657
+ relPermalink: string;
8658
+ /** @description Type of the resource. */
8659
+ type: string;
8660
+ };
8661
+ nextPage: {
8662
+ /**
8663
+ * Format: uuid
8664
+ * @description Parent ID.
8665
+ */
8666
+ id: string;
8667
+ /** @description The title of the parent. */
8668
+ title: string;
8669
+ /** @description The rel permalink of the parent. */
8670
+ relPermalink: string;
8671
+ /** @description Type of the resource. */
8672
+ type: string;
8673
+ };
8674
+ };
8675
+ passed?: number;
8676
+ failed?: number;
8677
+ attempts?: number;
8678
+ }[];
8679
+ /** @description Curricula with metrics for the organization. */
8680
+ curriculaList?: {
8681
+ /**
8682
+ * @description Total number of Curricula
8683
+ * @example 7
8684
+ */
8685
+ total: number;
8686
+ /** @description The data of the academycurriculawithmetricslistresponse. */
8687
+ data: ({
8688
+ /**
8689
+ * Format: uuid
8690
+ * @description Id of the Curricula
8691
+ * @example 923458-3490394-934893
8692
+ */
8693
+ id: string;
8694
+ /** @enum {string} */
8695
+ type: "learning-path" | "challenge" | "certification";
8696
+ /**
8697
+ * @description Organization ID that owns this learning path
8698
+ * @example meshery
8699
+ */
8700
+ orgId: string;
8701
+ /**
8702
+ * @description Visibility of the Curricula
8703
+ * @enum {string}
8704
+ */
8705
+ visibility: "public" | "private";
8706
+ /**
8707
+ * @description Status of the Curricula
8708
+ * @example ready
8709
+ * @enum {string}
8710
+ */
8711
+ status: "ready" | "archived" | "not_ready";
8712
+ /**
8713
+ * @description slug of the Curricula
8714
+ * @example intro-kubernetes-course
8715
+ */
8716
+ slug: string;
8717
+ /**
8718
+ * @description Level of the Curricula
8719
+ * @enum {string}
8720
+ */
8721
+ level: "beginner" | "intermediate" | "advanced";
8722
+ /**
8723
+ * Format: uuid
8724
+ * @description ID of the badge to be awarded on completion of this curricula
8725
+ */
8726
+ badgeId?: string;
8727
+ /** @description ID of the invite associated with this Curricula */
8728
+ inviteId?: string;
8729
+ /** @description ID of the workspace to which this Curricula belongs */
8730
+ workspaceId?: string;
8731
+ /** @description When the Curricula item was created */
8732
+ createdAt: string;
8733
+ /** @description When the Curricula was last updated */
8734
+ updatedAt: string;
8735
+ deletedAt: string;
8736
+ /** @description Additional metadata about the Curricula */
8737
+ metadata: {
8738
+ [key: string]: unknown;
8739
+ } & {
8740
+ /**
8741
+ * @description Title of the learning path
8742
+ * @example Mastering Kubernetes for Engineers
8743
+ */
8744
+ title: string;
8745
+ /**
8746
+ * @description Short description of the curricula
8747
+ * @example Learn how to configure your Kubernetes clusters and manage the lifecycle of your workloads
8748
+ */
8749
+ description: string;
8750
+ /**
8751
+ * @description Detailed description of the curricula
8752
+ * @example This learning path covers everything from Kubernetes architecture to advanced deployment strategies, including hands-on labs and real-world scenarios.
8753
+ */
8754
+ detailedDescription?: string;
8755
+ /**
8756
+ * Format: uri
8757
+ * @description Filename of the banner image, which should be placed in the same directory as the _index.md file
8758
+ * @example kubernetes-icon.svg
8759
+ */
8760
+ banner?: string | null;
8761
+ /**
8762
+ * Format: uri
8763
+ * @description Canonical URL for the learning path
8764
+ * @example http://localhost:9876/academy/learning-paths/meshery/mastering-kubernetes-for-engineers/
8765
+ */
8766
+ permalink: string;
8767
+ certificate?: {
8768
+ /**
8769
+ * Format: uuid
8770
+ * @description Unique identifier for the certificate
8771
+ * @example 550e8400-e29b-41d4-a716-446655440000
8772
+ */
8773
+ id: string;
8774
+ /**
8775
+ * Format: uuid
8776
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
8777
+ */
8778
+ orgId: string;
8779
+ /**
8780
+ * Format: uuid
8781
+ * @description ID of the recipient (user) who received the certificate
8782
+ * @example 550e8400-e29b-41d4-a716-446655440001
8783
+ */
8784
+ recipientId: string;
8785
+ /**
8786
+ * @description Name of the recipient (user) who received the certificate
8787
+ * @example John Doe
8788
+ */
8789
+ recipientName: string;
8790
+ /**
8791
+ * @description Title of the certificate
8792
+ * @example Kubernetes Expert Certification
8793
+ */
8794
+ title: string;
8795
+ /**
8796
+ * @description Description of the certificate
8797
+ * @example Awarded for successfully completing the Kubernetes Expert course
8798
+ */
8799
+ description: string;
8800
+ /** @description List of issuing authorities for the certificate */
8801
+ issuingAuthorities: {
8802
+ /**
8803
+ * @description Name of the issuing authority
8804
+ * @example Cloud Native Foundation
8805
+ */
8806
+ name: string;
8807
+ /**
8808
+ * @description Role of the issuing authority
8809
+ * @example COO
8810
+ */
8811
+ role?: string;
8812
+ /**
8813
+ * Format: uri
8814
+ * @description URL to the signature image of the issuing authority should be a publicly accessible URL and transparent PNG or SVG format
8815
+ * @example http://localhost:9876/signatures/cloud-native-foundation.png
8816
+ */
8817
+ signatureUrl?: string;
8818
+ }[];
8819
+ /**
8820
+ * Format: date-time
8821
+ * @description Date when the certificate was issued
8822
+ * @example 2023-10-01 12:00:00+00:00
8823
+ */
8824
+ issuedDate: string;
8825
+ /**
8826
+ * Format: date-time
8827
+ * @description Date when the certificate expires. Dynamically calculated from issued_date and expires_in; not specified by instructors.
8828
+ * @example 2025-10-01 12:00:00+00:00
8829
+ */
8830
+ expirationDate?: string;
8831
+ /**
8832
+ * @description Number of months after which the certificate expires
8833
+ * @example 24
8834
+ */
8835
+ expiresIn?: number;
8836
+ };
8837
+ /** @description List of children items in the top-level curricula */
8838
+ children?: {
8839
+ /**
8840
+ * Format: uuid
8841
+ * @description Unique identifier for the course
8842
+ * @example 550e8400-e29b-41d4-a716-446655440002
8843
+ */
8844
+ id: string;
8845
+ /**
8846
+ * @description Title of the course
8847
+ * @example Kubernetes Basics
8848
+ */
8849
+ title: string;
8850
+ /**
8851
+ * Format: uri
8852
+ * @description URL to the course content
8853
+ * @example http://localhost:9876/academy/learning-paths/meshery/intro-kubernetes-course/kubernetes/
8854
+ */
8855
+ permalink: string;
8856
+ /**
8857
+ * @description Course description
8858
+ * @example Learn the basics of Kubernetes
8859
+ */
8860
+ description: string;
8861
+ /**
8862
+ * @description A numeric value to determine the display order. A smaller number appears first. If not specified, items will be sorted alphabetically by title.
8863
+ * @example eg 1 , 2
8864
+ */
8865
+ weight?: number;
8866
+ /**
8867
+ * Format: uri
8868
+ * @description Filename of the banner image, which should be placed in the same directory as the _index.md file
8869
+ * @example kubernetes-icon.svg
8870
+ */
8871
+ banner?: string | null;
8872
+ /**
8873
+ * @description Type of the content (e.g., learning-path, challenge, certification)
8874
+ * @enum {string}
8875
+ */
8876
+ type?: "learning-path" | "challenge" | "certification";
8877
+ /** @description List of child nodes (sub-courses or modules) */
8878
+ children?: Record<string, never>[];
8879
+ }[];
8880
+ };
8881
+ } & {
8882
+ /** @description Number of registrations associated with this curriculum. */
8883
+ registrationCount: number;
8884
+ })[];
8885
+ };
8886
+ };
8123
8887
  };
8124
8888
  };
8125
8889
  /** @description Invalid request parameters */