@meshery/schemas 1.3.41 → 1.3.43

package/dist/cloudApi.d.mts

@@ -4466,7 +4466,7 @@ type UpdateCurrentItemInProgressTrackerApiResponse = {
         /** The current item of the curriculaprogresstracker. */
         currentItem: {
             [key: string]: {
-                /** CurriculaCurrentItemData ID. */
+                /** CurriculaCurrentItemData ID. Identifies the Hugo content page the learner currently has open, not a database row, so it is an opaque content-scoped string. Not a UUID - production values include slugs, full permalink URLs and the empty string. */
                 id: string;
                 /** The last opened of the curriculacurrentitemdata. */
                 lastOpened: string;
@@ -4491,7 +4491,7 @@ type UpdateCurrentItemInProgressTrackerApiResponse = {
                     [key: string]: boolean;
                 };
                 quiz: {
-                    /** Quiz ID. */
+                    /** Quiz ID. Identifies a Hugo content page, not a database row, so it is an opaque content-scoped string. Not a UUID - stored records carry authored slugs. */
                     id: string;
                     /** Organization ID that owns this quiz */
                     orgId: string;
@@ -4523,13 +4523,13 @@ type UpdateCurrentItemInProgressTrackerApiResponse = {
                     filePath: string;
                     /** The pass percentage of the quiz. */
                     passPercentage: number;
-                    /** Time limit for the quiz in minutes. A value of 0 indicates no time limit. */
-                    timeLimit: number;
+                    /** Time limit for the quiz in minutes. A value of 0 indicates no time limit. Accepts a number or a string because both forms are real production data - the Hugo theme emits a JSON number, while payloads persisted by earlier revisions hold a string such as "25" or the non-numeric sentinel "infinite". A string that does not parse to a positive number means "no time limit" and normalizes to 0. */
+                    timeLimit: number | string;
                     /** Maximum number of attempts allowed for the quiz. A value of 0 indicates unlimited attempts. */
                     maxAttempts: number;
                     /** The questions of the quiz. */
                     questions: {
-                        /** Question ID. */
+                        /** Question ID. Authored in the quiz's Hugo front matter, not a database row, so it is an opaque content-scoped string. Not a UUID. */
                         id: string;
                         /** The text of the question. */
                         text: string;
@@ -4540,7 +4540,7 @@ type UpdateCurrentItemInProgressTrackerApiResponse = {
                         multipleAnswers?: boolean;
                         /** The options of the question. */
                         options: {
-                            /** QuestionOption ID. */
+                            /** QuestionOption ID. Authored in the quiz's Hugo front matter, not a database row, so it is an opaque content-scoped string. Not a UUID. */
                             id: string;
                             /** The text of the questionoption. */
                             text: string;
@@ -4560,7 +4560,7 @@ type UpdateCurrentItemInProgressTrackerApiResponse = {
                     totalMarks: number;
                     /** The prerequisites of the quiz. */
                     prerequisites: {
-                        /** Parent ID. */
+                        /** Parent ID. Identifies a Hugo content page, not a database row, so it is an opaque content-scoped string. Not a UUID. See `Quiz.id`. */
                         id: string;
                         /** The title of the parent. */
                         title: string;
@@ -4570,7 +4570,7 @@ type UpdateCurrentItemInProgressTrackerApiResponse = {
                         type: string;
                     }[];
                     parent?: {
-                        /** Parent ID. */
+                        /** Parent ID. Identifies a Hugo content page, not a database row, so it is an opaque content-scoped string. Not a UUID. See `Quiz.id`. */
                         id: string;
                         /** The title of the parent. */
                         title: string;
@@ -4580,7 +4580,7 @@ type UpdateCurrentItemInProgressTrackerApiResponse = {
                         type: string;
                     };
                     nextPage: {
-                        /** Parent ID. */
+                        /** Parent ID. Identifies a Hugo content page, not a database row, so it is an opaque content-scoped string. Not a UUID. See `Quiz.id`. */
                         id: string;
                         /** The title of the parent. */
                         title: string;
@@ -4604,7 +4604,7 @@ type UpdateCurrentItemInProgressTrackerApiResponse = {
                 /** Timestamp when the item was completed */
                 completedAt: string;
                 itemData: {
-                    /** Parent ID. */
+                    /** Parent ID. Identifies a Hugo content page, not a database row, so it is an opaque content-scoped string. Not a UUID. See `Quiz.id`. */
                     id: string;
                     /** The title of the parent. */
                     title: string;
@@ -4622,7 +4622,7 @@ type UpdateCurrentItemInProgressTrackerApiResponse = {
     registrationId?: string;
     contentType?: "learning-path" | "challenge" | "certification";
     itemData?: {
-        /** CurriculaCurrentItemData ID. */
+        /** CurriculaCurrentItemData ID. Identifies the Hugo content page the learner currently has open, not a database row, so it is an opaque content-scoped string. Not a UUID - production values include slugs, full permalink URLs and the empty string. */
         id: string;
         /** The last opened of the curriculacurrentitemdata. */
         lastOpened: string;
@@ -4635,7 +4635,7 @@ type UpdateCurrentItemInProgressTrackerApiArg = {
     body: {
         contentType: "learning-path" | "challenge" | "certification";
         itemData: {
-            /** CurriculaCurrentItemData ID. */
+            /** CurriculaCurrentItemData ID. Identifies the Hugo content page the learner currently has open, not a database row, so it is an opaque content-scoped string. Not a UUID - production values include slugs, full permalink URLs and the empty string. */
             id: string;
             /** The last opened of the curriculacurrentitemdata. */
             lastOpened: string;
@@ -4644,7 +4644,7 @@ type UpdateCurrentItemInProgressTrackerApiArg = {
     };
 };
 type GetTestByAbsPathApiResponse = {
-    /** Quiz ID. */
+    /** Quiz ID. Identifies a Hugo content page, not a database row, so it is an opaque content-scoped string. Not a UUID - stored records carry authored slugs. */
     id: string;
     /** Organization ID that owns this quiz */
     orgId: string;
@@ -4676,13 +4676,13 @@ type GetTestByAbsPathApiResponse = {
     filePath: string;
     /** The pass percentage of the quiz. */
     passPercentage: number;
-    /** Time limit for the quiz in minutes. A value of 0 indicates no time limit. */
-    timeLimit: number;
+    /** Time limit for the quiz in minutes. A value of 0 indicates no time limit. Accepts a number or a string because both forms are real production data - the Hugo theme emits a JSON number, while payloads persisted by earlier revisions hold a string such as "25" or the non-numeric sentinel "infinite". A string that does not parse to a positive number means "no time limit" and normalizes to 0. */
+    timeLimit: number | string;
     /** Maximum number of attempts allowed for the quiz. A value of 0 indicates unlimited attempts. */
     maxAttempts: number;
     /** The questions of the quiz. */
     questions: {
-        /** Question ID. */
+        /** Question ID. Authored in the quiz's Hugo front matter, not a database row, so it is an opaque content-scoped string. Not a UUID. */
         id: string;
         /** The text of the question. */
         text: string;
@@ -4693,7 +4693,7 @@ type GetTestByAbsPathApiResponse = {
         multipleAnswers?: boolean;
         /** The options of the question. */
         options: {
-            /** QuestionOption ID. */
+            /** QuestionOption ID. Authored in the quiz's Hugo front matter, not a database row, so it is an opaque content-scoped string. Not a UUID. */
             id: string;
             /** The text of the questionoption. */
             text: string;
@@ -4713,7 +4713,7 @@ type GetTestByAbsPathApiResponse = {
     totalMarks: number;
     /** The prerequisites of the quiz. */
     prerequisites: {
-        /** Parent ID. */
+        /** Parent ID. Identifies a Hugo content page, not a database row, so it is an opaque content-scoped string. Not a UUID. See `Quiz.id`. */
         id: string;
         /** The title of the parent. */
         title: string;
@@ -4723,7 +4723,7 @@ type GetTestByAbsPathApiResponse = {
         type: string;
     }[];
     parent?: {
-        /** Parent ID. */
+        /** Parent ID. Identifies a Hugo content page, not a database row, so it is an opaque content-scoped string. Not a UUID. See `Quiz.id`. */
         id: string;
         /** The title of the parent. */
         title: string;
@@ -4733,7 +4733,7 @@ type GetTestByAbsPathApiResponse = {
         type: string;
     };
     nextPage: {
-        /** Parent ID. */
+        /** Parent ID. Identifies a Hugo content page, not a database row, so it is an opaque content-scoped string. Not a UUID. See `Quiz.id`. */
         id: string;
         /** The title of the parent. */
         title: string;
@@ -4748,7 +4748,7 @@ type GetTestByAbsPathApiArg = {
     absPath: string;
 };
 type StartTestByIdApiResponse = {
-    /** Quiz ID. */
+    /** Quiz ID. Identifies a Hugo content page, not a database row, so it is an opaque content-scoped string. Not a UUID - stored records carry authored slugs. */
     id: string;
     /** Organization ID that owns this quiz */
     orgId: string;
@@ -4780,13 +4780,13 @@ type StartTestByIdApiResponse = {
     filePath: string;
     /** The pass percentage of the quiz. */
     passPercentage: number;
-    /** Time limit for the quiz in minutes. A value of 0 indicates no time limit. */
-    timeLimit: number;
+    /** Time limit for the quiz in minutes. A value of 0 indicates no time limit. Accepts a number or a string because both forms are real production data - the Hugo theme emits a JSON number, while payloads persisted by earlier revisions hold a string such as "25" or the non-numeric sentinel "infinite". A string that does not parse to a positive number means "no time limit" and normalizes to 0. */
+    timeLimit: number | string;
     /** Maximum number of attempts allowed for the quiz. A value of 0 indicates unlimited attempts. */
     maxAttempts: number;
     /** The questions of the quiz. */
     questions: {
-        /** Question ID. */
+        /** Question ID. Authored in the quiz's Hugo front matter, not a database row, so it is an opaque content-scoped string. Not a UUID. */
         id: string;
         /** The text of the question. */
         text: string;
@@ -4797,7 +4797,7 @@ type StartTestByIdApiResponse = {
         multipleAnswers?: boolean;
         /** The options of the question. */
         options: {
-            /** QuestionOption ID. */
+            /** QuestionOption ID. Authored in the quiz's Hugo front matter, not a database row, so it is an opaque content-scoped string. Not a UUID. */
             id: string;
             /** The text of the questionoption. */
             text: string;
@@ -4817,7 +4817,7 @@ type StartTestByIdApiResponse = {
     totalMarks: number;
     /** The prerequisites of the quiz. */
     prerequisites: {
-        /** Parent ID. */
+        /** Parent ID. Identifies a Hugo content page, not a database row, so it is an opaque content-scoped string. Not a UUID. See `Quiz.id`. */
         id: string;
         /** The title of the parent. */
         title: string;
@@ -4827,7 +4827,7 @@ type StartTestByIdApiResponse = {
         type: string;
     }[];
     parent?: {
-        /** Parent ID. */
+        /** Parent ID. Identifies a Hugo content page, not a database row, so it is an opaque content-scoped string. Not a UUID. See `Quiz.id`. */
         id: string;
         /** The title of the parent. */
         title: string;
@@ -4837,7 +4837,7 @@ type StartTestByIdApiResponse = {
         type: string;
     };
     nextPage: {
-        /** Parent ID. */
+        /** Parent ID. Identifies a Hugo content page, not a database row, so it is an opaque content-scoped string. Not a UUID. See `Quiz.id`. */
         id: string;
         /** The title of the parent. */
         title: string;
@@ -4872,7 +4872,7 @@ type GetAllTestSessionsForRegistrationApiResponse =
         [key: string]: boolean;
     };
     quiz: {
-        /** Quiz ID. */
+        /** Quiz ID. Identifies a Hugo content page, not a database row, so it is an opaque content-scoped string. Not a UUID - stored records carry authored slugs. */
         id: string;
         /** Organization ID that owns this quiz */
         orgId: string;
@@ -4904,13 +4904,13 @@ type GetAllTestSessionsForRegistrationApiResponse =
         filePath: string;
         /** The pass percentage of the quiz. */
         passPercentage: number;
-        /** Time limit for the quiz in minutes. A value of 0 indicates no time limit. */
-        timeLimit: number;
+        /** Time limit for the quiz in minutes. A value of 0 indicates no time limit. Accepts a number or a string because both forms are real production data - the Hugo theme emits a JSON number, while payloads persisted by earlier revisions hold a string such as "25" or the non-numeric sentinel "infinite". A string that does not parse to a positive number means "no time limit" and normalizes to 0. */
+        timeLimit: number | string;
         /** Maximum number of attempts allowed for the quiz. A value of 0 indicates unlimited attempts. */
         maxAttempts: number;
         /** The questions of the quiz. */
         questions: {
-            /** Question ID. */
+            /** Question ID. Authored in the quiz's Hugo front matter, not a database row, so it is an opaque content-scoped string. Not a UUID. */
             id: string;
             /** The text of the question. */
             text: string;
@@ -4921,7 +4921,7 @@ type GetAllTestSessionsForRegistrationApiResponse =
             multipleAnswers?: boolean;
             /** The options of the question. */
             options: {
-                /** QuestionOption ID. */
+                /** QuestionOption ID. Authored in the quiz's Hugo front matter, not a database row, so it is an opaque content-scoped string. Not a UUID. */
                 id: string;
                 /** The text of the questionoption. */
                 text: string;
@@ -4941,7 +4941,7 @@ type GetAllTestSessionsForRegistrationApiResponse =
         totalMarks: number;
         /** The prerequisites of the quiz. */
         prerequisites: {
-            /** Parent ID. */
+            /** Parent ID. Identifies a Hugo content page, not a database row, so it is an opaque content-scoped string. Not a UUID. See `Quiz.id`. */
             id: string;
             /** The title of the parent. */
             title: string;
@@ -4951,7 +4951,7 @@ type GetAllTestSessionsForRegistrationApiResponse =
             type: string;
         }[];
         parent?: {
-            /** Parent ID. */
+            /** Parent ID. Identifies a Hugo content page, not a database row, so it is an opaque content-scoped string. Not a UUID. See `Quiz.id`. */
             id: string;
             /** The title of the parent. */
             title: string;
@@ -4961,7 +4961,7 @@ type GetAllTestSessionsForRegistrationApiResponse =
             type: string;
         };
         nextPage: {
-            /** Parent ID. */
+            /** Parent ID. Identifies a Hugo content page, not a database row, so it is an opaque content-scoped string. Not a UUID. See `Quiz.id`. */
             id: string;
             /** The title of the parent. */
             title: string;
@@ -5002,7 +5002,7 @@ type SubmitQuizApiResponse = {
         [key: string]: boolean;
     };
     quiz: {
-        /** Quiz ID. */
+        /** Quiz ID. Identifies a Hugo content page, not a database row, so it is an opaque content-scoped string. Not a UUID - stored records carry authored slugs. */
         id: string;
         /** Organization ID that owns this quiz */
         orgId: string;
@@ -5034,13 +5034,13 @@ type SubmitQuizApiResponse = {
         filePath: string;
         /** The pass percentage of the quiz. */
         passPercentage: number;
-        /** Time limit for the quiz in minutes. A value of 0 indicates no time limit. */
-        timeLimit: number;
+        /** Time limit for the quiz in minutes. A value of 0 indicates no time limit. Accepts a number or a string because both forms are real production data - the Hugo theme emits a JSON number, while payloads persisted by earlier revisions hold a string such as "25" or the non-numeric sentinel "infinite". A string that does not parse to a positive number means "no time limit" and normalizes to 0. */
+        timeLimit: number | string;
         /** Maximum number of attempts allowed for the quiz. A value of 0 indicates unlimited attempts. */
         maxAttempts: number;
         /** The questions of the quiz. */
         questions: {
-            /** Question ID. */
+            /** Question ID. Authored in the quiz's Hugo front matter, not a database row, so it is an opaque content-scoped string. Not a UUID. */
             id: string;
             /** The text of the question. */
             text: string;
@@ -5051,7 +5051,7 @@ type SubmitQuizApiResponse = {
             multipleAnswers?: boolean;
             /** The options of the question. */
             options: {
-                /** QuestionOption ID. */
+                /** QuestionOption ID. Authored in the quiz's Hugo front matter, not a database row, so it is an opaque content-scoped string. Not a UUID. */
                 id: string;
                 /** The text of the questionoption. */
                 text: string;
@@ -5071,7 +5071,7 @@ type SubmitQuizApiResponse = {
         totalMarks: number;
         /** The prerequisites of the quiz. */
         prerequisites: {
-            /** Parent ID. */
+            /** Parent ID. Identifies a Hugo content page, not a database row, so it is an opaque content-scoped string. Not a UUID. See `Quiz.id`. */
             id: string;
             /** The title of the parent. */
             title: string;
@@ -5081,7 +5081,7 @@ type SubmitQuizApiResponse = {
             type: string;
         }[];
         parent?: {
-            /** Parent ID. */
+            /** Parent ID. Identifies a Hugo content page, not a database row, so it is an opaque content-scoped string. Not a UUID. See `Quiz.id`. */
             id: string;
             /** The title of the parent. */
             title: string;
@@ -5091,7 +5091,7 @@ type SubmitQuizApiResponse = {
             type: string;
         };
         nextPage: {
-            /** Parent ID. */
+            /** Parent ID. Identifies a Hugo content page, not a database row, so it is an opaque content-scoped string. Not a UUID. See `Quiz.id`. */
             id: string;
             /** The title of the parent. */
             title: string;
@@ -5112,13 +5112,13 @@ type SubmitQuizApiArg = {
         testSessionId: string;
         /** The quiz abs path of the quizsubmission. */
         quizAbsPath: string;
-        /** ID of the associated registration. */
-        registrationId: string;
-        /** ID of the user who owns or created this resource. */
-        userId: string;
+        /** ID of the associated registration. Optional, because a submission may not carry this echo; when it is absent the authoritative value is `TestSubmission.registrationId`. Absence MUST be expressed as `null` or an omitted property - the empty string is not a valid identifier. */
+        registrationId?: string | null;
+        /** ID of the user who owns or created this resource. Optional, because a submission may not carry this echo; when it is absent the authoritative value is `TestSubmission.userId`. Absence MUST be expressed as `null` or an omitted property - the empty string is not a valid identifier. */
+        userId?: string | null;
         /** The answers of the quizsubmission. */
         answers: {
-            /** ID of the associated question. */
+            /** ID of the associated question. Mirrors `Question.id`, a content-authored string rather than a database row identifier, so it is not a UUID. */
             questionId: string;
             /** Map of selected option IDs to a boolean value indicating if it was selected. */
             selectedOptionId: {
@@ -5166,7 +5166,7 @@ type GetAcademyAdminSummaryApiResponse =
     tests?: {
         /** The test the counts refer to. */
         test?: {
-            /** Quiz ID. */
+            /** Quiz ID. Identifies a Hugo content page, not a database row, so it is an opaque content-scoped string. Not a UUID - stored records carry authored slugs. */
             id: string;
             /** Organization ID that owns this quiz */
             orgId: string;
@@ -5198,13 +5198,13 @@ type GetAcademyAdminSummaryApiResponse =
             filePath: string;
             /** The pass percentage of the quiz. */
             passPercentage: number;
-            /** Time limit for the quiz in minutes. A value of 0 indicates no time limit. */
-            timeLimit: number;
+            /** Time limit for the quiz in minutes. A value of 0 indicates no time limit. Accepts a number or a string because both forms are real production data - the Hugo theme emits a JSON number, while payloads persisted by earlier revisions hold a string such as "25" or the non-numeric sentinel "infinite". A string that does not parse to a positive number means "no time limit" and normalizes to 0. */
+            timeLimit: number | string;
             /** Maximum number of attempts allowed for the quiz. A value of 0 indicates unlimited attempts. */
             maxAttempts: number;
             /** The questions of the quiz. */
             questions: {
-                /** Question ID. */
+                /** Question ID. Authored in the quiz's Hugo front matter, not a database row, so it is an opaque content-scoped string. Not a UUID. */
                 id: string;
                 /** The text of the question. */
                 text: string;
@@ -5215,7 +5215,7 @@ type GetAcademyAdminSummaryApiResponse =
                 multipleAnswers?: boolean;
                 /** The options of the question. */
                 options: {
-                    /** QuestionOption ID. */
+                    /** QuestionOption ID. Authored in the quiz's Hugo front matter, not a database row, so it is an opaque content-scoped string. Not a UUID. */
                     id: string;
                     /** The text of the questionoption. */
                     text: string;
@@ -5235,7 +5235,7 @@ type GetAcademyAdminSummaryApiResponse =
             totalMarks: number;
             /** The prerequisites of the quiz. */
             prerequisites: {
-                /** Parent ID. */
+                /** Parent ID. Identifies a Hugo content page, not a database row, so it is an opaque content-scoped string. Not a UUID. See `Quiz.id`. */
                 id: string;
                 /** The title of the parent. */
                 title: string;
@@ -5245,7 +5245,7 @@ type GetAcademyAdminSummaryApiResponse =
                 type: string;
             }[];
             parent?: {
-                /** Parent ID. */
+                /** Parent ID. Identifies a Hugo content page, not a database row, so it is an opaque content-scoped string. Not a UUID. See `Quiz.id`. */
                 id: string;
                 /** The title of the parent. */
                 title: string;
@@ -5255,7 +5255,7 @@ type GetAcademyAdminSummaryApiResponse =
                 type: string;
             };
             nextPage: {
-                /** Parent ID. */
+                /** Parent ID. Identifies a Hugo content page, not a database row, so it is an opaque content-scoped string. Not a UUID. See `Quiz.id`. */
                 id: string;
                 /** The title of the parent. */
                 title: string;