openlayer 0.15.0 → 0.17.0

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 (276) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +35 -0
  3. data/README.md +1 -1
  4. data/lib/openlayer/client.rb +8 -0
  5. data/lib/openlayer/models/background_task_retrieve_params.rb +20 -0
  6. data/lib/openlayer/models/background_task_retrieve_response.rb +85 -0
  7. data/lib/openlayer/models/governance/framework_create_params.rb +143 -0
  8. data/lib/openlayer/models/governance/framework_create_response.rb +412 -0
  9. data/lib/openlayer/models/governance/framework_export_params.rb +36 -0
  10. data/lib/openlayer/models/governance/framework_export_response.rb +32 -0
  11. data/lib/openlayer/models/governance/framework_list_params.rb +148 -0
  12. data/lib/openlayer/models/governance/framework_list_project_rule_stats_params.rb +74 -0
  13. data/lib/openlayer/models/governance/framework_list_project_rule_stats_response.rb +279 -0
  14. data/lib/openlayer/models/governance/framework_list_projects_params.rb +39 -0
  15. data/lib/openlayer/models/governance/framework_list_projects_response.rb +315 -0
  16. data/lib/openlayer/models/governance/framework_list_response.rb +423 -0
  17. data/lib/openlayer/models/governance/framework_list_rules_params.rb +39 -0
  18. data/lib/openlayer/models/governance/framework_list_rules_response.rb +696 -0
  19. data/lib/openlayer/models/governance/framework_retrieve_params.rb +22 -0
  20. data/lib/openlayer/models/governance/framework_retrieve_response.rb +412 -0
  21. data/lib/openlayer/models/governance/framework_update_params.rb +200 -0
  22. data/lib/openlayer/models/governance/framework_update_response.rb +412 -0
  23. data/lib/openlayer/models/governance/frameworks/document_list_params.rb +41 -0
  24. data/lib/openlayer/models/governance/frameworks/document_list_response.rb +598 -0
  25. data/lib/openlayer/models/governance/frameworks/document_retrieve_params.rb +30 -0
  26. data/lib/openlayer/models/governance/frameworks/document_retrieve_response.rb +587 -0
  27. data/lib/openlayer/models/governance/frameworks/section_list_rules_params.rb +96 -0
  28. data/lib/openlayer/models/governance/frameworks/section_list_rules_response.rb +700 -0
  29. data/lib/openlayer/models/governance/frameworks/subsection_list_rules_params.rb +88 -0
  30. data/lib/openlayer/models/governance/frameworks/subsection_list_rules_response.rb +700 -0
  31. data/lib/openlayer/models/governance/rule_create_params.rb +173 -0
  32. data/lib/openlayer/models/governance/rule_create_response.rb +677 -0
  33. data/lib/openlayer/models/governance/rule_delete_params.rb +22 -0
  34. data/lib/openlayer/models/governance/rule_list_params.rb +231 -0
  35. data/lib/openlayer/models/governance/rule_list_response.rb +694 -0
  36. data/lib/openlayer/models/governance/rule_result_create_evidence_params.rb +69 -0
  37. data/lib/openlayer/models/governance/rule_result_create_evidence_response.rb +95 -0
  38. data/lib/openlayer/models/governance/rule_result_list_evidence_params.rb +39 -0
  39. data/lib/openlayer/models/governance/rule_result_list_evidence_response.rb +106 -0
  40. data/lib/openlayer/models/governance/rule_result_list_params.rb +149 -0
  41. data/lib/openlayer/models/governance/rule_result_list_response.rb +276 -0
  42. data/lib/openlayer/models/governance/rule_result_retrieve_params.rb +22 -0
  43. data/lib/openlayer/models/governance/rule_result_retrieve_response.rb +264 -0
  44. data/lib/openlayer/models/governance/rule_result_update_params.rb +156 -0
  45. data/lib/openlayer/models/governance/rule_result_update_response.rb +263 -0
  46. data/lib/openlayer/models/governance/rule_retrieve_params.rb +22 -0
  47. data/lib/openlayer/models/governance/rule_retrieve_response.rb +681 -0
  48. data/lib/openlayer/models/governance/rule_stat_retrieve_params.rb +39 -0
  49. data/lib/openlayer/models/governance/rule_stat_retrieve_response.rb +508 -0
  50. data/lib/openlayer/models/governance/rule_tag_list_params.rb +39 -0
  51. data/lib/openlayer/models/governance/rule_tag_list_response.rb +91 -0
  52. data/lib/openlayer/models/governance/rule_update_params.rb +78 -0
  53. data/lib/openlayer/models/governance/rule_update_response.rb +677 -0
  54. data/lib/openlayer/models/inference_pipeline_retrieve_response.rb +0 -1
  55. data/lib/openlayer/models/inference_pipeline_retrieve_sessions_response.rb +3 -0
  56. data/lib/openlayer/models/inference_pipeline_retrieve_users_response.rb +3 -0
  57. data/lib/openlayer/models/inference_pipeline_update_response.rb +0 -1
  58. data/lib/openlayer/models/project_create_response.rb +0 -1
  59. data/lib/openlayer/models/project_list_response.rb +0 -1
  60. data/lib/openlayer/models/project_update_response.rb +0 -1
  61. data/lib/openlayer/models/projects/inference_pipeline_create_params.rb +0 -1
  62. data/lib/openlayer/models/projects/inference_pipeline_create_response.rb +0 -1
  63. data/lib/openlayer/models/projects/inference_pipeline_list_response.rb +0 -1
  64. data/lib/openlayer/models/storage/presigned_url_retrieve_params.rb +28 -0
  65. data/lib/openlayer/models/storage/presigned_url_retrieve_response.rb +19 -0
  66. data/lib/openlayer/models/workspaces/api_key_create_params.rb +17 -1
  67. data/lib/openlayer/models/workspaces/api_key_create_response.rb +73 -3
  68. data/lib/openlayer/models/workspaces/api_key_delete_params.rb +28 -0
  69. data/lib/openlayer/models/workspaces/api_key_list_params.rb +22 -0
  70. data/lib/openlayer/models/workspaces/api_key_list_response.rb +134 -0
  71. data/lib/openlayer/models/workspaces/api_key_retrieve_params.rb +28 -0
  72. data/lib/openlayer/models/workspaces/api_key_retrieve_response.rb +131 -0
  73. data/lib/openlayer/models/workspaces/api_key_rotate_params.rb +56 -0
  74. data/lib/openlayer/models/workspaces/api_key_rotate_response.rb +131 -0
  75. data/lib/openlayer/models/workspaces/api_key_update_params.rb +38 -0
  76. data/lib/openlayer/models/workspaces/api_key_update_response.rb +131 -0
  77. data/lib/openlayer/models.rb +4 -0
  78. data/lib/openlayer/resources/background_tasks.rb +34 -0
  79. data/lib/openlayer/resources/commits.rb +1 -1
  80. data/lib/openlayer/resources/governance/frameworks/documents.rb +72 -0
  81. data/lib/openlayer/resources/governance/frameworks/sections.rb +68 -0
  82. data/lib/openlayer/resources/governance/frameworks/subsections.rb +65 -0
  83. data/lib/openlayer/resources/governance/frameworks.rb +292 -0
  84. data/lib/openlayer/resources/governance/rule_results.rb +187 -0
  85. data/lib/openlayer/resources/governance/rule_stats.rb +43 -0
  86. data/lib/openlayer/resources/governance/rule_tags.rb +43 -0
  87. data/lib/openlayer/resources/governance/rules.rb +210 -0
  88. data/lib/openlayer/resources/governance.rb +34 -0
  89. data/lib/openlayer/resources/inference_pipelines/rows.rb +4 -5
  90. data/lib/openlayer/resources/inference_pipelines.rb +5 -14
  91. data/lib/openlayer/resources/projects/tests.rb +3 -3
  92. data/lib/openlayer/resources/storage/presigned_url.rb +27 -1
  93. data/lib/openlayer/resources/tests.rb +1 -4
  94. data/lib/openlayer/resources/workspaces/api_keys.rb +146 -2
  95. data/lib/openlayer/resources/workspaces/invites.rb +1 -1
  96. data/lib/openlayer/resources/workspaces.rb +1 -1
  97. data/lib/openlayer/version.rb +1 -1
  98. data/lib/openlayer.rb +70 -0
  99. data/rbi/openlayer/client.rbi +6 -0
  100. data/rbi/openlayer/models/background_task_retrieve_params.rbi +38 -0
  101. data/rbi/openlayer/models/background_task_retrieve_response.rbi +105 -0
  102. data/rbi/openlayer/models/governance/framework_create_params.rbi +298 -0
  103. data/rbi/openlayer/models/governance/framework_create_response.rbi +735 -0
  104. data/rbi/openlayer/models/governance/framework_export_params.rbi +58 -0
  105. data/rbi/openlayer/models/governance/framework_export_response.rbi +48 -0
  106. data/rbi/openlayer/models/governance/framework_list_params.rbi +310 -0
  107. data/rbi/openlayer/models/governance/framework_list_project_rule_stats_params.rbi +178 -0
  108. data/rbi/openlayer/models/governance/framework_list_project_rule_stats_response.rbi +441 -0
  109. data/rbi/openlayer/models/governance/framework_list_projects_params.rbi +68 -0
  110. data/rbi/openlayer/models/governance/framework_list_projects_response.rbi +498 -0
  111. data/rbi/openlayer/models/governance/framework_list_response.rbi +776 -0
  112. data/rbi/openlayer/models/governance/framework_list_rules_params.rbi +68 -0
  113. data/rbi/openlayer/models/governance/framework_list_rules_response.rbi +1334 -0
  114. data/rbi/openlayer/models/governance/framework_retrieve_params.rbi +40 -0
  115. data/rbi/openlayer/models/governance/framework_retrieve_response.rbi +735 -0
  116. data/rbi/openlayer/models/governance/framework_update_params.rbi +425 -0
  117. data/rbi/openlayer/models/governance/framework_update_response.rbi +735 -0
  118. data/rbi/openlayer/models/governance/frameworks/document_list_params.rbi +70 -0
  119. data/rbi/openlayer/models/governance/frameworks/document_list_response.rbi +1050 -0
  120. data/rbi/openlayer/models/governance/frameworks/document_retrieve_params.rbi +50 -0
  121. data/rbi/openlayer/models/governance/frameworks/document_retrieve_response.rbi +1006 -0
  122. data/rbi/openlayer/models/governance/frameworks/section_list_rules_params.rbi +193 -0
  123. data/rbi/openlayer/models/governance/frameworks/section_list_rules_response.rbi +1338 -0
  124. data/rbi/openlayer/models/governance/frameworks/subsection_list_rules_params.rbi +182 -0
  125. data/rbi/openlayer/models/governance/frameworks/subsection_list_rules_response.rbi +1338 -0
  126. data/rbi/openlayer/models/governance/rule_create_params.rbi +291 -0
  127. data/rbi/openlayer/models/governance/rule_create_response.rbi +1289 -0
  128. data/rbi/openlayer/models/governance/rule_delete_params.rbi +40 -0
  129. data/rbi/openlayer/models/governance/rule_list_params.rbi +486 -0
  130. data/rbi/openlayer/models/governance/rule_list_response.rbi +1330 -0
  131. data/rbi/openlayer/models/governance/rule_result_create_evidence_params.rbi +90 -0
  132. data/rbi/openlayer/models/governance/rule_result_create_evidence_response.rbi +113 -0
  133. data/rbi/openlayer/models/governance/rule_result_list_evidence_params.rbi +68 -0
  134. data/rbi/openlayer/models/governance/rule_result_list_evidence_response.rbi +156 -0
  135. data/rbi/openlayer/models/governance/rule_result_list_params.rbi +322 -0
  136. data/rbi/openlayer/models/governance/rule_result_list_response.rbi +580 -0
  137. data/rbi/openlayer/models/governance/rule_result_retrieve_params.rbi +43 -0
  138. data/rbi/openlayer/models/governance/rule_result_retrieve_response.rbi +537 -0
  139. data/rbi/openlayer/models/governance/rule_result_update_params.rbi +381 -0
  140. data/rbi/openlayer/models/governance/rule_result_update_response.rbi +537 -0
  141. data/rbi/openlayer/models/governance/rule_retrieve_params.rbi +40 -0
  142. data/rbi/openlayer/models/governance/rule_retrieve_response.rbi +1289 -0
  143. data/rbi/openlayer/models/governance/rule_stat_retrieve_params.rbi +68 -0
  144. data/rbi/openlayer/models/governance/rule_stat_retrieve_response.rbi +877 -0
  145. data/rbi/openlayer/models/governance/rule_tag_list_params.rbi +68 -0
  146. data/rbi/openlayer/models/governance/rule_tag_list_response.rbi +141 -0
  147. data/rbi/openlayer/models/governance/rule_update_params.rbi +108 -0
  148. data/rbi/openlayer/models/governance/rule_update_response.rbi +1289 -0
  149. data/rbi/openlayer/models/inference_pipeline_retrieve_response.rbi +0 -5
  150. data/rbi/openlayer/models/inference_pipeline_retrieve_sessions_response.rbi +2 -0
  151. data/rbi/openlayer/models/inference_pipeline_retrieve_users_response.rbi +2 -0
  152. data/rbi/openlayer/models/inference_pipeline_update_response.rbi +0 -5
  153. data/rbi/openlayer/models/project_create_response.rbi +0 -5
  154. data/rbi/openlayer/models/project_list_response.rbi +0 -5
  155. data/rbi/openlayer/models/project_update_response.rbi +0 -5
  156. data/rbi/openlayer/models/projects/inference_pipeline_create_params.rbi +0 -5
  157. data/rbi/openlayer/models/projects/inference_pipeline_create_response.rbi +0 -5
  158. data/rbi/openlayer/models/projects/inference_pipeline_list_response.rbi +0 -5
  159. data/rbi/openlayer/models/storage/presigned_url_retrieve_params.rbi +47 -0
  160. data/rbi/openlayer/models/storage/presigned_url_retrieve_response.rbi +32 -0
  161. data/rbi/openlayer/models/workspaces/api_key_create_params.rbi +18 -0
  162. data/rbi/openlayer/models/workspaces/api_key_create_response.rbi +117 -5
  163. data/rbi/openlayer/models/workspaces/api_key_delete_params.rbi +48 -0
  164. data/rbi/openlayer/models/workspaces/api_key_list_params.rbi +40 -0
  165. data/rbi/openlayer/models/workspaces/api_key_list_response.rbi +202 -0
  166. data/rbi/openlayer/models/workspaces/api_key_retrieve_params.rbi +48 -0
  167. data/rbi/openlayer/models/workspaces/api_key_retrieve_response.rbi +194 -0
  168. data/rbi/openlayer/models/workspaces/api_key_rotate_params.rbi +85 -0
  169. data/rbi/openlayer/models/workspaces/api_key_rotate_response.rbi +194 -0
  170. data/rbi/openlayer/models/workspaces/api_key_update_params.rbi +60 -0
  171. data/rbi/openlayer/models/workspaces/api_key_update_response.rbi +194 -0
  172. data/rbi/openlayer/models.rbi +4 -0
  173. data/rbi/openlayer/resources/background_tasks.rbi +26 -0
  174. data/rbi/openlayer/resources/commits.rbi +1 -1
  175. data/rbi/openlayer/resources/governance/frameworks/documents.rbi +57 -0
  176. data/rbi/openlayer/resources/governance/frameworks/sections.rbi +56 -0
  177. data/rbi/openlayer/resources/governance/frameworks/subsections.rbi +52 -0
  178. data/rbi/openlayer/resources/governance/frameworks.rbi +261 -0
  179. data/rbi/openlayer/resources/governance/rule_results.rbi +167 -0
  180. data/rbi/openlayer/resources/governance/rule_stats.rbi +34 -0
  181. data/rbi/openlayer/resources/governance/rule_tags.rbi +34 -0
  182. data/rbi/openlayer/resources/governance/rules.rbi +209 -0
  183. data/rbi/openlayer/resources/governance.rbi +27 -0
  184. data/rbi/openlayer/resources/inference_pipelines/rows.rbi +4 -5
  185. data/rbi/openlayer/resources/inference_pipelines.rbi +5 -14
  186. data/rbi/openlayer/resources/projects/tests.rbi +3 -3
  187. data/rbi/openlayer/resources/storage/presigned_url.rbi +16 -1
  188. data/rbi/openlayer/resources/tests.rbi +1 -4
  189. data/rbi/openlayer/resources/workspaces/api_keys.rbi +110 -1
  190. data/rbi/openlayer/resources/workspaces/invites.rbi +1 -1
  191. data/rbi/openlayer/resources/workspaces.rbi +1 -1
  192. data/sig/openlayer/client.rbs +4 -0
  193. data/sig/openlayer/models/background_task_retrieve_params.rbs +23 -0
  194. data/sig/openlayer/models/background_task_retrieve_response.rbs +55 -0
  195. data/sig/openlayer/models/governance/framework_create_params.rbs +124 -0
  196. data/sig/openlayer/models/governance/framework_create_response.rbs +293 -0
  197. data/sig/openlayer/models/governance/framework_export_params.rbs +30 -0
  198. data/sig/openlayer/models/governance/framework_export_response.rbs +21 -0
  199. data/sig/openlayer/models/governance/framework_list_params.rbs +145 -0
  200. data/sig/openlayer/models/governance/framework_list_project_rule_stats_params.rbs +87 -0
  201. data/sig/openlayer/models/governance/framework_list_project_rule_stats_response.rbs +232 -0
  202. data/sig/openlayer/models/governance/framework_list_projects_params.rbs +38 -0
  203. data/sig/openlayer/models/governance/framework_list_projects_response.rbs +248 -0
  204. data/sig/openlayer/models/governance/framework_list_response.rbs +314 -0
  205. data/sig/openlayer/models/governance/framework_list_rules_params.rbs +38 -0
  206. data/sig/openlayer/models/governance/framework_list_rules_response.rbs +547 -0
  207. data/sig/openlayer/models/governance/framework_retrieve_params.rbs +25 -0
  208. data/sig/openlayer/models/governance/framework_retrieve_response.rbs +293 -0
  209. data/sig/openlayer/models/governance/framework_update_params.rbs +175 -0
  210. data/sig/openlayer/models/governance/framework_update_response.rbs +293 -0
  211. data/sig/openlayer/models/governance/frameworks/document_list_params.rbs +40 -0
  212. data/sig/openlayer/models/governance/frameworks/document_list_response.rbs +435 -0
  213. data/sig/openlayer/models/governance/frameworks/document_retrieve_params.rbs +32 -0
  214. data/sig/openlayer/models/governance/frameworks/document_retrieve_response.rbs +418 -0
  215. data/sig/openlayer/models/governance/frameworks/section_list_rules_params.rbs +102 -0
  216. data/sig/openlayer/models/governance/frameworks/section_list_rules_response.rbs +549 -0
  217. data/sig/openlayer/models/governance/frameworks/subsection_list_rules_params.rbs +95 -0
  218. data/sig/openlayer/models/governance/frameworks/subsection_list_rules_response.rbs +549 -0
  219. data/sig/openlayer/models/governance/rule_create_params.rbs +120 -0
  220. data/sig/openlayer/models/governance/rule_create_response.rbs +530 -0
  221. data/sig/openlayer/models/governance/rule_delete_params.rbs +25 -0
  222. data/sig/openlayer/models/governance/rule_list_params.rbs +228 -0
  223. data/sig/openlayer/models/governance/rule_list_response.rbs +547 -0
  224. data/sig/openlayer/models/governance/rule_result_create_evidence_params.rbs +53 -0
  225. data/sig/openlayer/models/governance/rule_result_create_evidence_response.rbs +62 -0
  226. data/sig/openlayer/models/governance/rule_result_list_evidence_params.rbs +38 -0
  227. data/sig/openlayer/models/governance/rule_result_list_evidence_response.rbs +79 -0
  228. data/sig/openlayer/models/governance/rule_result_list_params.rbs +156 -0
  229. data/sig/openlayer/models/governance/rule_result_list_response.rbs +252 -0
  230. data/sig/openlayer/models/governance/rule_result_retrieve_params.rbs +26 -0
  231. data/sig/openlayer/models/governance/rule_result_retrieve_response.rbs +235 -0
  232. data/sig/openlayer/models/governance/rule_result_update_params.rbs +165 -0
  233. data/sig/openlayer/models/governance/rule_result_update_response.rbs +235 -0
  234. data/sig/openlayer/models/governance/rule_retrieve_params.rbs +25 -0
  235. data/sig/openlayer/models/governance/rule_retrieve_response.rbs +530 -0
  236. data/sig/openlayer/models/governance/rule_stat_retrieve_params.rbs +38 -0
  237. data/sig/openlayer/models/governance/rule_stat_retrieve_response.rbs +434 -0
  238. data/sig/openlayer/models/governance/rule_tag_list_params.rbs +38 -0
  239. data/sig/openlayer/models/governance/rule_tag_list_response.rbs +74 -0
  240. data/sig/openlayer/models/governance/rule_update_params.rbs +62 -0
  241. data/sig/openlayer/models/governance/rule_update_response.rbs +530 -0
  242. data/sig/openlayer/models/inference_pipeline_retrieve_response.rbs +1 -2
  243. data/sig/openlayer/models/inference_pipeline_update_response.rbs +1 -2
  244. data/sig/openlayer/models/project_create_response.rbs +1 -2
  245. data/sig/openlayer/models/project_list_response.rbs +1 -2
  246. data/sig/openlayer/models/project_update_response.rbs +1 -2
  247. data/sig/openlayer/models/projects/inference_pipeline_create_params.rbs +1 -2
  248. data/sig/openlayer/models/projects/inference_pipeline_create_response.rbs +1 -2
  249. data/sig/openlayer/models/projects/inference_pipeline_list_response.rbs +1 -2
  250. data/sig/openlayer/models/storage/presigned_url_retrieve_params.rbs +25 -0
  251. data/sig/openlayer/models/storage/presigned_url_retrieve_response.rbs +15 -0
  252. data/sig/openlayer/models/workspaces/api_key_create_params.rbs +5 -1
  253. data/sig/openlayer/models/workspaces/api_key_create_response.rbs +42 -3
  254. data/sig/openlayer/models/workspaces/api_key_delete_params.rbs +30 -0
  255. data/sig/openlayer/models/workspaces/api_key_list_params.rbs +25 -0
  256. data/sig/openlayer/models/workspaces/api_key_list_response.rbs +91 -0
  257. data/sig/openlayer/models/workspaces/api_key_retrieve_params.rbs +30 -0
  258. data/sig/openlayer/models/workspaces/api_key_retrieve_response.rbs +86 -0
  259. data/sig/openlayer/models/workspaces/api_key_rotate_params.rbs +45 -0
  260. data/sig/openlayer/models/workspaces/api_key_rotate_response.rbs +86 -0
  261. data/sig/openlayer/models/workspaces/api_key_update_params.rbs +34 -0
  262. data/sig/openlayer/models/workspaces/api_key_update_response.rbs +86 -0
  263. data/sig/openlayer/models.rbs +4 -0
  264. data/sig/openlayer/resources/background_tasks.rbs +12 -0
  265. data/sig/openlayer/resources/governance/frameworks/documents.rbs +24 -0
  266. data/sig/openlayer/resources/governance/frameworks/sections.rbs +23 -0
  267. data/sig/openlayer/resources/governance/frameworks/subsections.rbs +22 -0
  268. data/sig/openlayer/resources/governance/frameworks.rbs +88 -0
  269. data/sig/openlayer/resources/governance/rule_results.rbs +57 -0
  270. data/sig/openlayer/resources/governance/rule_stats.rbs +16 -0
  271. data/sig/openlayer/resources/governance/rule_tags.rbs +16 -0
  272. data/sig/openlayer/resources/governance/rules.rbs +68 -0
  273. data/sig/openlayer/resources/governance.rbs +17 -0
  274. data/sig/openlayer/resources/storage/presigned_url.rbs +5 -0
  275. data/sig/openlayer/resources/workspaces/api_keys.rbs +33 -0
  276. metadata +212 -2
@@ -0,0 +1,700 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Openlayer
4
+ module Models
5
+ module Governance
6
+ module Frameworks
7
+ # @see Openlayer::Resources::Governance::Frameworks::Subsections#list_rules
8
+ class SubsectionListRulesResponse < Openlayer::Internal::Type::BaseModel
9
+ # @!attribute items
10
+ #
11
+ # @return [Array<Openlayer::Models::Governance::Frameworks::SubsectionListRulesResponse::Item>]
12
+ required :items,
13
+ -> { Openlayer::Internal::Type::ArrayOf[Openlayer::Models::Governance::Frameworks::SubsectionListRulesResponse::Item] }
14
+
15
+ # @!method initialize(items:)
16
+ # @param items [Array<Openlayer::Models::Governance::Frameworks::SubsectionListRulesResponse::Item>]
17
+
18
+ class Item < Openlayer::Internal::Type::BaseModel
19
+ # @!attribute name
20
+ # The rule name.
21
+ #
22
+ # @return [String]
23
+ required :name, String
24
+
25
+ # @!attribute scope
26
+ # Whether the rule is evaluated once for the whole workspace, or once per project
27
+ # the rule's frameworks apply to. Must be `project` for platform rules. Fixed once
28
+ # the rule is created.
29
+ #
30
+ # @return [Symbol, Openlayer::Models::Governance::Frameworks::SubsectionListRulesResponse::Item::Scope]
31
+ required :scope,
32
+ enum: -> { Openlayer::Models::Governance::Frameworks::SubsectionListRulesResponse::Item::Scope }
33
+
34
+ # @!attribute type
35
+ # `platform` rules are evaluated automatically from the state of your Openlayer
36
+ # workspace. `evidence` rules are satisfied by attaching evidence. Fixed once the
37
+ # rule is created.
38
+ #
39
+ # @return [Symbol, Openlayer::Models::Governance::Frameworks::SubsectionListRulesResponse::Item::Type]
40
+ required :type,
41
+ enum: -> { Openlayer::Models::Governance::Frameworks::SubsectionListRulesResponse::Item::Type }
42
+
43
+ # @!attribute assignee_id
44
+ # The user responsible for satisfying the rule.
45
+ #
46
+ # @return [String, nil]
47
+ optional :assignee_id, String, api_name: :assigneeId, nil?: true
48
+
49
+ # @!attribute automation_params
50
+ # Configuration for the platform check, when the automation takes parameters. Omit
51
+ # or `null` for evidence rules. Fixed once the rule is created.
52
+ #
53
+ # @return [Hash{Symbol=>Object}, nil]
54
+ optional :automation_params,
55
+ Openlayer::Internal::Type::HashOf[Openlayer::Internal::Type::Unknown],
56
+ api_name: :automationParams,
57
+ nil?: true
58
+
59
+ # @!attribute automation_type
60
+ # Which workspace signal a platform rule checks, for example
61
+ # `monitoring_mode_enabled`, `test_setup`, or `project_owner_set`. Set it for
62
+ # platform rules; omit or `null` for evidence rules. Fixed once the rule is
63
+ # created.
64
+ #
65
+ # @return [String, nil]
66
+ optional :automation_type, String, api_name: :automationType, nil?: true
67
+
68
+ # @!attribute deactivated
69
+ # Whether the rule is excluded from compliance calculations.
70
+ #
71
+ # @return [Boolean, nil]
72
+ optional :deactivated, Openlayer::Internal::Type::Boolean
73
+
74
+ # @!attribute description
75
+ # What the rule requires.
76
+ #
77
+ # @return [String, nil]
78
+ optional :description, String, nil?: true
79
+
80
+ # @!attribute evidence_type
81
+ # The kind of evidence that satisfies the rule. Set it for evidence rules; omit or
82
+ # `null` for platform rules. Fixed once the rule is created.
83
+ #
84
+ # @return [Symbol, Openlayer::Models::Governance::Frameworks::SubsectionListRulesResponse::Item::EvidenceType, nil]
85
+ optional :evidence_type,
86
+ enum: -> { Openlayer::Models::Governance::Frameworks::SubsectionListRulesResponse::Item::EvidenceType },
87
+ api_name: :evidenceType,
88
+ nil?: true
89
+
90
+ # @!attribute renewal_cadence_days
91
+ # How often evidence must be renewed, in days. Once evidence is older than this,
92
+ # the rule result becomes `due_soon` and then `failing`. The window restarts
93
+ # whenever evidence is attached. Omit or `null` for platform rules.
94
+ #
95
+ # @return [Integer, nil]
96
+ optional :renewal_cadence_days, Integer, api_name: :renewalCadenceDays, nil?: true
97
+
98
+ response_only do
99
+ # @!attribute id
100
+ # The rule id.
101
+ #
102
+ # @return [String]
103
+ required :id, String
104
+
105
+ # @!attribute date_created
106
+ # The creation date.
107
+ #
108
+ # @return [Time]
109
+ required :date_created, Time, api_name: :dateCreated
110
+
111
+ # @!attribute date_updated
112
+ # The last update date.
113
+ #
114
+ # @return [Time]
115
+ required :date_updated, Time, api_name: :dateUpdated
116
+
117
+ # @!attribute workspace_id
118
+ # The id of the workspace the rule belongs to.
119
+ #
120
+ # @return [String]
121
+ required :workspace_id, String, api_name: :workspaceId
122
+
123
+ # @!attribute frameworks
124
+ # The frameworks that include this rule.
125
+ #
126
+ # @return [Array<Openlayer::Models::Governance::Frameworks::SubsectionListRulesResponse::Item::Framework>, nil]
127
+ optional :frameworks,
128
+ -> { Openlayer::Internal::Type::ArrayOf[Openlayer::Models::Governance::Frameworks::SubsectionListRulesResponse::Item::Framework] }
129
+
130
+ # @!attribute immutable
131
+ # Whether the rule is managed by Openlayer. These rules can't be renamed or
132
+ # deleted; set `deactivated` to exclude one from compliance instead.
133
+ #
134
+ # @return [Boolean, nil]
135
+ optional :immutable, Openlayer::Internal::Type::Boolean
136
+
137
+ # @!attribute results
138
+ # The rule's results, one per entity the rule is evaluated against. Only returned
139
+ # when `includeResults` is `true`.
140
+ #
141
+ # @return [Array<Openlayer::Models::Governance::Frameworks::SubsectionListRulesResponse::Item::Result>, nil]
142
+ optional :results,
143
+ -> { Openlayer::Internal::Type::ArrayOf[Openlayer::Models::Governance::Frameworks::SubsectionListRulesResponse::Item::Result] }
144
+
145
+ # @!attribute results_summary
146
+ # Pass-rate counts across all of the rule's entities, independent of any status
147
+ # filter applied to the request.
148
+ #
149
+ # @return [Openlayer::Models::Governance::Frameworks::SubsectionListRulesResponse::Item::ResultsSummary, nil]
150
+ optional :results_summary,
151
+ -> { Openlayer::Models::Governance::Frameworks::SubsectionListRulesResponse::Item::ResultsSummary },
152
+ api_name: :resultsSummary,
153
+ nil?: true
154
+
155
+ # @!attribute tags
156
+ # The rule tags associated with the rule.
157
+ #
158
+ # @return [Array<Openlayer::Models::Governance::Frameworks::SubsectionListRulesResponse::Item::Tag>, nil]
159
+ optional :tags,
160
+ -> { Openlayer::Internal::Type::ArrayOf[Openlayer::Models::Governance::Frameworks::SubsectionListRulesResponse::Item::Tag] },
161
+ nil?: true
162
+ end
163
+
164
+ # @!method initialize(id:, date_created:, date_updated:, name:, scope:, type:, workspace_id:, assignee_id: nil, automation_params: nil, automation_type: nil, deactivated: nil, description: nil, evidence_type: nil, frameworks: nil, immutable: nil, renewal_cadence_days: nil, results: nil, results_summary: nil, tags: nil)
165
+ # Some parameter documentations has been truncated, see
166
+ # {Openlayer::Models::Governance::Frameworks::SubsectionListRulesResponse::Item}
167
+ # for more details.
168
+ #
169
+ # A single requirement Openlayer tracks. `platform` rules are evaluated
170
+ # automatically from the state of your workspace, and `evidence` rules are
171
+ # satisfied by attaching evidence. A rule can belong to several frameworks, or to
172
+ # none.
173
+ #
174
+ # @param id [String] The rule id.
175
+ #
176
+ # @param date_created [Time] The creation date.
177
+ #
178
+ # @param date_updated [Time] The last update date.
179
+ #
180
+ # @param name [String] The rule name.
181
+ #
182
+ # @param scope [Symbol, Openlayer::Models::Governance::Frameworks::SubsectionListRulesResponse::Item::Scope] Whether the rule is evaluated once for the whole workspace, or once per project
183
+ #
184
+ # @param type [Symbol, Openlayer::Models::Governance::Frameworks::SubsectionListRulesResponse::Item::Type] `platform` rules are evaluated automatically from the state of your Openlayer wo
185
+ #
186
+ # @param workspace_id [String] The id of the workspace the rule belongs to.
187
+ #
188
+ # @param assignee_id [String, nil] The user responsible for satisfying the rule.
189
+ #
190
+ # @param automation_params [Hash{Symbol=>Object}, nil] Configuration for the platform check, when the automation takes parameters. Omit
191
+ #
192
+ # @param automation_type [String, nil] Which workspace signal a platform rule checks, for example `monitoring_mode_enab
193
+ #
194
+ # @param deactivated [Boolean] Whether the rule is excluded from compliance calculations.
195
+ #
196
+ # @param description [String, nil] What the rule requires.
197
+ #
198
+ # @param evidence_type [Symbol, Openlayer::Models::Governance::Frameworks::SubsectionListRulesResponse::Item::EvidenceType, nil] The kind of evidence that satisfies the rule. Set it for evidence rules; omit or
199
+ #
200
+ # @param frameworks [Array<Openlayer::Models::Governance::Frameworks::SubsectionListRulesResponse::Item::Framework>] The frameworks that include this rule.
201
+ #
202
+ # @param immutable [Boolean] Whether the rule is managed by Openlayer. These rules can't be renamed or delete
203
+ #
204
+ # @param renewal_cadence_days [Integer, nil] How often evidence must be renewed, in days. Once evidence is older than this, t
205
+ #
206
+ # @param results [Array<Openlayer::Models::Governance::Frameworks::SubsectionListRulesResponse::Item::Result>] The rule's results, one per entity the rule is evaluated against. Only returned
207
+ #
208
+ # @param results_summary [Openlayer::Models::Governance::Frameworks::SubsectionListRulesResponse::Item::ResultsSummary, nil] Pass-rate counts across all of the rule's entities, independent of any status fi
209
+ #
210
+ # @param tags [Array<Openlayer::Models::Governance::Frameworks::SubsectionListRulesResponse::Item::Tag>, nil] The rule tags associated with the rule.
211
+
212
+ # Whether the rule is evaluated once for the whole workspace, or once per project
213
+ # the rule's frameworks apply to. Must be `project` for platform rules. Fixed once
214
+ # the rule is created.
215
+ #
216
+ # @see Openlayer::Models::Governance::Frameworks::SubsectionListRulesResponse::Item#scope
217
+ module Scope
218
+ extend Openlayer::Internal::Type::Enum
219
+
220
+ PROJECT = :project
221
+ WORKSPACE = :workspace
222
+
223
+ # @!method self.values
224
+ # @return [Array<Symbol>]
225
+ end
226
+
227
+ # `platform` rules are evaluated automatically from the state of your Openlayer
228
+ # workspace. `evidence` rules are satisfied by attaching evidence. Fixed once the
229
+ # rule is created.
230
+ #
231
+ # @see Openlayer::Models::Governance::Frameworks::SubsectionListRulesResponse::Item#type
232
+ module Type
233
+ extend Openlayer::Internal::Type::Enum
234
+
235
+ PLATFORM = :platform
236
+ EVIDENCE = :evidence
237
+
238
+ # @!method self.values
239
+ # @return [Array<Symbol>]
240
+ end
241
+
242
+ # The kind of evidence that satisfies the rule. Set it for evidence rules; omit or
243
+ # `null` for platform rules. Fixed once the rule is created.
244
+ #
245
+ # @see Openlayer::Models::Governance::Frameworks::SubsectionListRulesResponse::Item#evidence_type
246
+ module EvidenceType
247
+ extend Openlayer::Internal::Type::Enum
248
+
249
+ DOCUMENT = :document
250
+ TEXT = :text
251
+ URL = :url
252
+ CATEGORY_VALUE = :categoryValue
253
+
254
+ # @!method self.values
255
+ # @return [Array<Symbol>]
256
+ end
257
+
258
+ class Framework < Openlayer::Internal::Type::BaseModel
259
+ # @!attribute avatar
260
+ # The icon shown for the framework.
261
+ #
262
+ # @return [Openlayer::Models::Governance::Frameworks::SubsectionListRulesResponse::Item::Framework::Avatar, nil]
263
+ required :avatar,
264
+ -> { Openlayer::Models::Governance::Frameworks::SubsectionListRulesResponse::Item::Framework::Avatar },
265
+ nil?: true
266
+
267
+ # @!attribute built_in_slug
268
+ # Identifies a framework that ships with Openlayer, for example `eu_ai_act`,
269
+ # `iso_42001`, `nist_ai_rmf`, or `traiga`. `null` for frameworks you create
270
+ # yourself.
271
+ #
272
+ # @return [String, nil]
273
+ required :built_in_slug, String, api_name: :builtInSlug, nil?: true
274
+
275
+ # @!attribute enabled
276
+ # Whether the framework is active. Rules of a disabled framework are not evaluated
277
+ # and do not count towards compliance.
278
+ #
279
+ # @return [Boolean]
280
+ required :enabled, Openlayer::Internal::Type::Boolean
281
+
282
+ # @!attribute name
283
+ # The framework name.
284
+ #
285
+ # @return [String]
286
+ required :name, String
287
+
288
+ response_only do
289
+ # @!attribute id
290
+ # The framework id.
291
+ #
292
+ # @return [String]
293
+ required :id, String
294
+ end
295
+
296
+ # @!method initialize(id:, avatar:, built_in_slug:, enabled:, name:)
297
+ # Some parameter documentations has been truncated, see
298
+ # {Openlayer::Models::Governance::Frameworks::SubsectionListRulesResponse::Item::Framework}
299
+ # for more details.
300
+ #
301
+ # @param id [String] The framework id.
302
+ #
303
+ # @param avatar [Openlayer::Models::Governance::Frameworks::SubsectionListRulesResponse::Item::Framework::Avatar, nil] The icon shown for the framework.
304
+ #
305
+ # @param built_in_slug [String, nil] Identifies a framework that ships with Openlayer, for example `eu_ai_act`,
306
+ # `iso\_
307
+ #
308
+ # @param enabled [Boolean] Whether the framework is active. Rules of a disabled framework are not evaluated
309
+ #
310
+ # @param name [String] The framework name.
311
+
312
+ # @see Openlayer::Models::Governance::Frameworks::SubsectionListRulesResponse::Item::Framework#avatar
313
+ class Avatar < Openlayer::Internal::Type::BaseModel
314
+ # @!attribute type
315
+ #
316
+ # @return [Symbol, Openlayer::Models::Governance::Frameworks::SubsectionListRulesResponse::Item::Framework::Avatar::Type]
317
+ required :type,
318
+ enum: -> { Openlayer::Models::Governance::Frameworks::SubsectionListRulesResponse::Item::Framework::Avatar::Type }
319
+
320
+ # @!attribute value
321
+ #
322
+ # @return [String]
323
+ required :value, String
324
+
325
+ # @!method initialize(type:, value:)
326
+ # The icon shown for the framework.
327
+ #
328
+ # @param type [Symbol, Openlayer::Models::Governance::Frameworks::SubsectionListRulesResponse::Item::Framework::Avatar::Type]
329
+ # @param value [String]
330
+
331
+ # @see Openlayer::Models::Governance::Frameworks::SubsectionListRulesResponse::Item::Framework::Avatar#type
332
+ module Type
333
+ extend Openlayer::Internal::Type::Enum
334
+
335
+ EMOJI = :emoji
336
+ IMAGE_URL = :imageUrl
337
+ BUILTIN_IMAGE = :builtinImage
338
+
339
+ # @!method self.values
340
+ # @return [Array<Symbol>]
341
+ end
342
+ end
343
+ end
344
+
345
+ class Result < Openlayer::Internal::Type::BaseModel
346
+ # @!attribute deactivated
347
+ # Whether this result is excluded from compliance calculations. Excludes just this
348
+ # result, without deactivating the rule everywhere.
349
+ #
350
+ # @return [Boolean]
351
+ required :deactivated, Openlayer::Internal::Type::Boolean
352
+
353
+ # @!attribute status
354
+ # The compliance status of the rule for this entity. Computed by Openlayer and
355
+ # can't be set directly.
356
+ #
357
+ # @return [Symbol, Openlayer::Models::Governance::Frameworks::SubsectionListRulesResponse::Item::Result::Status]
358
+ required :status,
359
+ enum: -> { Openlayer::Models::Governance::Frameworks::SubsectionListRulesResponse::Item::Result::Status }
360
+
361
+ # @!attribute assignee_id
362
+ # The user responsible for this result.
363
+ #
364
+ # @return [String, nil]
365
+ optional :assignee_id, String, api_name: :assigneeId, nil?: true
366
+
367
+ # @!attribute blocked_by
368
+ # Rule results that must pass before this one can be satisfied.
369
+ #
370
+ # @return [Array<Openlayer::Models::Governance::Frameworks::SubsectionListRulesResponse::Item::Result::BlockedBy>, nil]
371
+ optional :blocked_by,
372
+ -> { Openlayer::Internal::Type::ArrayOf[Openlayer::Models::Governance::Frameworks::SubsectionListRulesResponse::Item::Result::BlockedBy] },
373
+ api_name: :blockedBy
374
+
375
+ # @!attribute blocking
376
+ # Rule results that this one blocks.
377
+ #
378
+ # @return [Array<Openlayer::Models::Governance::Frameworks::SubsectionListRulesResponse::Item::Result::Blocking>, nil]
379
+ optional :blocking,
380
+ -> { Openlayer::Internal::Type::ArrayOf[Openlayer::Models::Governance::Frameworks::SubsectionListRulesResponse::Item::Result::Blocking] }
381
+
382
+ # @!attribute deactivated_reason
383
+ # Why the result was excluded. Required when setting `deactivated` to `true`.
384
+ #
385
+ # @return [String, nil]
386
+ optional :deactivated_reason, String, api_name: :deactivatedReason, nil?: true
387
+
388
+ # @!attribute status_message
389
+ # A human-readable explanation of the status.
390
+ #
391
+ # @return [String, nil]
392
+ optional :status_message, String, api_name: :statusMessage, nil?: true
393
+
394
+ response_only do
395
+ # @!attribute id
396
+ # The rule result id.
397
+ #
398
+ # @return [String]
399
+ required :id, String
400
+
401
+ # @!attribute date_created
402
+ # The creation date.
403
+ #
404
+ # @return [Time]
405
+ required :date_created, Time, api_name: :dateCreated
406
+
407
+ # @!attribute date_updated
408
+ # The last update date.
409
+ #
410
+ # @return [Time]
411
+ required :date_updated, Time, api_name: :dateUpdated
412
+
413
+ # @!attribute rule_id
414
+ # The rule this result belongs to.
415
+ #
416
+ # @return [String]
417
+ required :rule_id, String, api_name: :ruleId
418
+
419
+ # @!attribute workspace_id
420
+ # The id of the workspace the rule result belongs to.
421
+ #
422
+ # @return [String]
423
+ required :workspace_id, String, api_name: :workspaceId
424
+
425
+ # @!attribute date_last_evaluated
426
+ # When the rule was last evaluated. Platform rules only.
427
+ #
428
+ # @return [Time, nil]
429
+ optional :date_last_evaluated, Time, api_name: :dateLastEvaluated, nil?: true
430
+
431
+ # @!attribute date_of_latest_evidence
432
+ # When the most recent piece of evidence was attached. Evidence rules only.
433
+ #
434
+ # @return [Time, nil]
435
+ optional :date_of_latest_evidence, Time, api_name: :dateOfLatestEvidence, nil?: true
436
+
437
+ # @!attribute date_of_next_evaluation
438
+ # When the rule will next be evaluated. Platform rules only.
439
+ #
440
+ # @return [Time, nil]
441
+ optional :date_of_next_evaluation, Time, api_name: :dateOfNextEvaluation, nil?: true
442
+
443
+ # @!attribute date_of_renewal
444
+ # When the evidence must be renewed. Evidence rules with a renewal cadence only.
445
+ #
446
+ # @return [Time, nil]
447
+ optional :date_of_renewal, Time, api_name: :dateOfRenewal, nil?: true
448
+
449
+ # @!attribute project_id
450
+ # The project this result was evaluated for. `null` for workspace-scoped rules.
451
+ #
452
+ # @return [String, nil]
453
+ optional :project_id, String, api_name: :projectId, nil?: true
454
+ end
455
+
456
+ # @!method initialize(id:, date_created:, date_updated:, deactivated:, rule_id:, status:, workspace_id:, assignee_id: nil, blocked_by: nil, blocking: nil, date_last_evaluated: nil, date_of_latest_evidence: nil, date_of_next_evaluation: nil, date_of_renewal: nil, deactivated_reason: nil, project_id: nil, status_message: nil)
457
+ # Some parameter documentations has been truncated, see
458
+ # {Openlayer::Models::Governance::Frameworks::SubsectionListRulesResponse::Item::Result}
459
+ # for more details.
460
+ #
461
+ # The compliance status of one rule for one entity: a project for project-scoped
462
+ # rules, or the workspace for workspace-scoped rules.
463
+ #
464
+ # @param id [String] The rule result id.
465
+ #
466
+ # @param date_created [Time] The creation date.
467
+ #
468
+ # @param date_updated [Time] The last update date.
469
+ #
470
+ # @param deactivated [Boolean] Whether this result is excluded from compliance calculations. Excludes just this
471
+ #
472
+ # @param rule_id [String] The rule this result belongs to.
473
+ #
474
+ # @param status [Symbol, Openlayer::Models::Governance::Frameworks::SubsectionListRulesResponse::Item::Result::Status] The compliance status of the rule for this entity. Computed by Openlayer and can
475
+ #
476
+ # @param workspace_id [String] The id of the workspace the rule result belongs to.
477
+ #
478
+ # @param assignee_id [String, nil] The user responsible for this result.
479
+ #
480
+ # @param blocked_by [Array<Openlayer::Models::Governance::Frameworks::SubsectionListRulesResponse::Item::Result::BlockedBy>] Rule results that must pass before this one can be satisfied.
481
+ #
482
+ # @param blocking [Array<Openlayer::Models::Governance::Frameworks::SubsectionListRulesResponse::Item::Result::Blocking>] Rule results that this one blocks.
483
+ #
484
+ # @param date_last_evaluated [Time, nil] When the rule was last evaluated. Platform rules only.
485
+ #
486
+ # @param date_of_latest_evidence [Time, nil] When the most recent piece of evidence was attached. Evidence rules only.
487
+ #
488
+ # @param date_of_next_evaluation [Time, nil] When the rule will next be evaluated. Platform rules only.
489
+ #
490
+ # @param date_of_renewal [Time, nil] When the evidence must be renewed. Evidence rules with a renewal cadence only.
491
+ #
492
+ # @param deactivated_reason [String, nil] Why the result was excluded. Required when setting `deactivated` to `true`.
493
+ #
494
+ # @param project_id [String, nil] The project this result was evaluated for. `null` for workspace-scoped rules.
495
+ #
496
+ # @param status_message [String, nil] A human-readable explanation of the status.
497
+
498
+ # The compliance status of the rule for this entity. Computed by Openlayer and
499
+ # can't be set directly.
500
+ #
501
+ # @see Openlayer::Models::Governance::Frameworks::SubsectionListRulesResponse::Item::Result#status
502
+ module Status
503
+ extend Openlayer::Internal::Type::Enum
504
+
505
+ RUNNING = :running
506
+ PASSING = :passing
507
+ FAILING = :failing
508
+ SKIPPED = :skipped
509
+ ERROR = :error
510
+ PENDING = :pending
511
+ DUE_SOON = :due_soon
512
+
513
+ # @!method self.values
514
+ # @return [Array<Symbol>]
515
+ end
516
+
517
+ class BlockedBy < Openlayer::Internal::Type::BaseModel
518
+ # @!attribute id
519
+ #
520
+ # @return [String, nil]
521
+ optional :id, String
522
+
523
+ # @!attribute status
524
+ # The compliance status of the rule for this entity. Computed by Openlayer and
525
+ # can't be set directly.
526
+ #
527
+ # @return [Symbol, Openlayer::Models::Governance::Frameworks::SubsectionListRulesResponse::Item::Result::BlockedBy::Status, nil]
528
+ optional :status,
529
+ enum: -> { Openlayer::Models::Governance::Frameworks::SubsectionListRulesResponse::Item::Result::BlockedBy::Status }
530
+
531
+ # @!method initialize(id: nil, status: nil)
532
+ # Some parameter documentations has been truncated, see
533
+ # {Openlayer::Models::Governance::Frameworks::SubsectionListRulesResponse::Item::Result::BlockedBy}
534
+ # for more details.
535
+ #
536
+ # @param id [String]
537
+ #
538
+ # @param status [Symbol, Openlayer::Models::Governance::Frameworks::SubsectionListRulesResponse::Item::Result::BlockedBy::Status] The compliance status of the rule for this entity. Computed by Openlayer and can
539
+
540
+ # The compliance status of the rule for this entity. Computed by Openlayer and
541
+ # can't be set directly.
542
+ #
543
+ # @see Openlayer::Models::Governance::Frameworks::SubsectionListRulesResponse::Item::Result::BlockedBy#status
544
+ module Status
545
+ extend Openlayer::Internal::Type::Enum
546
+
547
+ RUNNING = :running
548
+ PASSING = :passing
549
+ FAILING = :failing
550
+ SKIPPED = :skipped
551
+ ERROR = :error
552
+ PENDING = :pending
553
+ DUE_SOON = :due_soon
554
+
555
+ # @!method self.values
556
+ # @return [Array<Symbol>]
557
+ end
558
+ end
559
+
560
+ class Blocking < Openlayer::Internal::Type::BaseModel
561
+ # @!attribute id
562
+ #
563
+ # @return [String, nil]
564
+ optional :id, String
565
+
566
+ # @!attribute status
567
+ # The compliance status of the rule for this entity. Computed by Openlayer and
568
+ # can't be set directly.
569
+ #
570
+ # @return [Symbol, Openlayer::Models::Governance::Frameworks::SubsectionListRulesResponse::Item::Result::Blocking::Status, nil]
571
+ optional :status,
572
+ enum: -> { Openlayer::Models::Governance::Frameworks::SubsectionListRulesResponse::Item::Result::Blocking::Status }
573
+
574
+ # @!method initialize(id: nil, status: nil)
575
+ # Some parameter documentations has been truncated, see
576
+ # {Openlayer::Models::Governance::Frameworks::SubsectionListRulesResponse::Item::Result::Blocking}
577
+ # for more details.
578
+ #
579
+ # @param id [String]
580
+ #
581
+ # @param status [Symbol, Openlayer::Models::Governance::Frameworks::SubsectionListRulesResponse::Item::Result::Blocking::Status] The compliance status of the rule for this entity. Computed by Openlayer and can
582
+
583
+ # The compliance status of the rule for this entity. Computed by Openlayer and
584
+ # can't be set directly.
585
+ #
586
+ # @see Openlayer::Models::Governance::Frameworks::SubsectionListRulesResponse::Item::Result::Blocking#status
587
+ module Status
588
+ extend Openlayer::Internal::Type::Enum
589
+
590
+ RUNNING = :running
591
+ PASSING = :passing
592
+ FAILING = :failing
593
+ SKIPPED = :skipped
594
+ ERROR = :error
595
+ PENDING = :pending
596
+ DUE_SOON = :due_soon
597
+
598
+ # @!method self.values
599
+ # @return [Array<Symbol>]
600
+ end
601
+ end
602
+ end
603
+
604
+ # @see Openlayer::Models::Governance::Frameworks::SubsectionListRulesResponse::Item#results_summary
605
+ class ResultsSummary < Openlayer::Internal::Type::BaseModel
606
+ # @!attribute passing
607
+ #
608
+ # @return [Integer, nil]
609
+ optional :passing, Integer
610
+
611
+ # @!attribute total
612
+ #
613
+ # @return [Integer, nil]
614
+ optional :total, Integer
615
+
616
+ # @!method initialize(passing: nil, total: nil)
617
+ # Pass-rate counts across all of the rule's entities, independent of any status
618
+ # filter applied to the request.
619
+ #
620
+ # @param passing [Integer]
621
+ # @param total [Integer]
622
+ end
623
+
624
+ class Tag < Openlayer::Internal::Type::BaseModel
625
+ # @!attribute name
626
+ # The tag name.
627
+ #
628
+ # @return [String]
629
+ required :name, String
630
+
631
+ # @!attribute color
632
+ # The color the tag is displayed with.
633
+ #
634
+ # @return [String, nil]
635
+ optional :color, String, nil?: true
636
+
637
+ response_only do
638
+ # @!attribute id
639
+ # The rule tag id.
640
+ #
641
+ # @return [String]
642
+ required :id, String
643
+
644
+ # @!attribute creator_id
645
+ # The user who created the tag. `null` for tags that ship with Openlayer.
646
+ #
647
+ # @return [String, nil]
648
+ required :creator_id, String, api_name: :creatorId, nil?: true
649
+
650
+ # @!attribute date_created
651
+ # The creation date.
652
+ #
653
+ # @return [Time]
654
+ required :date_created, Time, api_name: :dateCreated
655
+
656
+ # @!attribute date_updated
657
+ # The last update date.
658
+ #
659
+ # @return [Time]
660
+ required :date_updated, Time, api_name: :dateUpdated
661
+
662
+ # @!attribute immutable
663
+ # Whether the tag is managed by Openlayer. These tags can't be deleted.
664
+ #
665
+ # @return [Boolean]
666
+ required :immutable, Openlayer::Internal::Type::Boolean
667
+
668
+ # @!attribute workspace_id
669
+ # The id of the workspace the tag belongs to.
670
+ #
671
+ # @return [String]
672
+ required :workspace_id, String, api_name: :workspaceId
673
+ end
674
+
675
+ # @!method initialize(id:, creator_id:, date_created:, date_updated:, immutable:, name:, workspace_id:, color: nil)
676
+ # A label that groups rules across frameworks, for example by team or control
677
+ # family.
678
+ #
679
+ # @param id [String] The rule tag id.
680
+ #
681
+ # @param creator_id [String, nil] The user who created the tag. `null` for tags that ship with Openlayer.
682
+ #
683
+ # @param date_created [Time] The creation date.
684
+ #
685
+ # @param date_updated [Time] The last update date.
686
+ #
687
+ # @param immutable [Boolean] Whether the tag is managed by Openlayer. These tags can't be deleted.
688
+ #
689
+ # @param name [String] The tag name.
690
+ #
691
+ # @param workspace_id [String] The id of the workspace the tag belongs to.
692
+ #
693
+ # @param color [String, nil] The color the tag is displayed with.
694
+ end
695
+ end
696
+ end
697
+ end
698
+ end
699
+ end
700
+ end