reqctl 0.1.38__py3-none-any.whl

reqctl/schemas/dictionary.schema.yaml

@@ -0,0 +1,256 @@
+# @req> REQ-97751594@BwWOFlFOjjyU bw5pgk
+$schema: "https://json-schema.org/draft/2020-12/schema"
+# @req> REQ-83218477@nthDaUhwd58l hvachr
+$id: "reqctl/dictionary.schema.yaml"
+# @req> REQ-52846482@4k8T0YLN4n97 w3ligq
+type: object
+# @req> REQ-20678879@c210nefD6kHQ 2j2acz
+additionalProperties: false
+
+# @req> REQ-70136689@kGycTrf0_sOP y7gjxb
+# @req> REQ-60231841@jePDPrjCGq74 whtum4
+# @req> REQ-55732743@ELdWYlfmjgH0 osucvy
+required: [kind, status, entries]
+
+# @req> REQ-20678879@c210nefD6kHQ wvisqw
+properties:
+
+  # @req> REQ-60231841@jePDPrjCGq74 6txmwh
+  status:
+    enum: [draft, approved, deprecated, superseded]
+    # @req> REQ-21532897@4mlJA_VkJWru w2ix3u
+    default: draft
+
+  # @req> REQ-70136689@kGycTrf0_sOP ga7747
+  kind:
+    enum: [term, parameter, data]
+    # @req> REQ-95557166@iVuq5MGUC4wD glk266
+    readOnly: true
+
+  # @req> REQ-15824835@Yz8PdrMb9q2F 2or7iw
+  name:
+    type: string
+    pattern: "^[a-z][a-z0-9_]*$"
+    # @req> REQ-91205530@FiUaykViw6dQ b6cnwg
+    # @req> REQ-71965656@F8ulVugEMpD- h5i2tk
+    x-address: true
+
+  # @req> REQ-95242849@qtpUa2UbKM6O vfi7sv
+  carried:
+    type: array
+    uniqueItems: true
+    # @req> REQ-38278436@G9G7n7d2Ke-7 yyw6vd
+    readOnly: true
+    items:
+      type: string
+      pattern: "^[a-z][a-z0-9_]*$"
+
+  # @req> REQ-54705070@azHphsRsbfJl gmnzxo
+  text:
+    type: string
+    minLength: 1
+    # @req> REQ-51326810@tZsTSo6pwmwE 365hpf
+    # @req> REQ-67358511@6v5ZhXIOqAkD c2dajd
+    # @req> REQ-59874866@fH6bFHN-Lwa8 7okmvn
+    # @req> REQ-76604940@SEVyiDrbH-Ez vw3dbe
+    x-prose: true
+
+  # @req> REQ-38954638@497pbk7J9sqk hpuute
+  value_type:
+    enum: [duration, size, count, ratio, percentage, currency, boolean, text]
+    # @req> REQ-52544202@FdBPIIOU8f_v qyhuti
+    x-entry-of: value_types
+
+  # @req> REQ-92926466@dhyvKSDWQfjw wc43aq
+  unit:
+    type: string
+    minLength: 1
+
+  # @req> REQ-21045294@UE8gAjNCLsm8 6mwqw2
+  default:
+    type: string
+    minLength: 1
+
+  # @req> REQ-36099384@oqIHWa_e7CDN qukf5f
+  ceiling:
+    type: string
+    minLength: 1
+
+  # @req> REQ-22682482@F_OIMxlkifKy 3uk233
+  fields:
+    type: array
+    minItems: 1
+    uniqueItems: true
+    items: {type: string, minLength: 1}
+
+  # @req> REQ-12136510@Q7qxyHYKDLns mpjvzb
+  rationale:
+    type: string
+    # @req> REQ-51326810@tZsTSo6pwmwE z5vxyy
+    # @req> REQ-67358511@6v5ZhXIOqAkD wi4wcd
+    # @req> REQ-59874866@fH6bFHN-Lwa8 zf2lsy
+    # @req> REQ-76604940@SEVyiDrbH-Ez bqzsae
+    x-prose: true
+
+  # @req> REQ-55732743@ELdWYlfmjgH0 lyffll
+  entries:
+    type: object
+    minProperties: 1
+    propertyNames:
+      type: string
+      minLength: 1
+
+  # @req> REQ-66350758@mhvWsKLsPGHC qttgzd
+  assessed:
+    type: object
+    # @req> REQ-20438611@e9DfaZdZU0eT zbz6r3
+    readOnly: true
+    # @req> REQ-91894254@HA2Tpgi5MW9m qow7p3
+    default: {}
+    # @req> REQ-77349514@c5tXalbMeD2i g5owzj
+    propertyNames:
+      pattern: "^[a-z][a-z0-9_]*(\\..+)?$"
+    additionalProperties:
+      type: string
+      minLength: 1
+
+  # @req> REQ-88203622@wlZ9orsr9c7q jez5bu
+  citations:
+    type: object
+    # @req> REQ-89946019@X4MY0OTFXbag wkgpw2
+    readOnly: true
+    propertyNames:
+      pattern: "^[a-z2-7]{6}$"
+    additionalProperties:
+      type: string
+      pattern: "^[A-Za-z0-9_-]{43}$"
+
+  # @req> REQ-40478019@_dwqsOpSOQXA wg7rlk
+  whole_file_citations:
+    type: object
+    readOnly: true
+    propertyNames:
+      minLength: 1
+    additionalProperties:
+      type: object
+      additionalProperties: false
+      required: [pinned, digest]
+      properties:
+        pinned:
+          type: string
+          pattern: "^[A-Za-z0-9_-]{12}$"
+        digest:
+          type: string
+          pattern: "^[A-Za-z0-9_-]{43}$"
+
+# @req> REQ-52555712@ifLOKFIGhkgf j4awd6
+# @req> REQ-20003259@dUyU2uLqjsIF v56wyu
+# @req> REQ-76262680@k4Ti3hJfcZ14 ltndty
+# @req> REQ-12896387@jvS0Os1oYPbk z3j5vy
+# @req> REQ-49304907@NSnffmSJBDm1 umaqja
+allOf:
+
+  # @req> REQ-52555712@ifLOKFIGhkgf e5mj2f
+  - if: {required: [kind], properties: {kind: {const: term}}}
+    then:
+      properties:
+        citations: {not: {}}
+        whole_file_citations: {not: {}}
+        name: {not: {}}
+        text: {not: {}}
+        value_type: {not: {}}
+        unit: {not: {}}
+        default: {not: {}}
+        ceiling: {not: {}}
+        fields: {not: {}}
+        rationale: {not: {}}
+        entries:
+          # @req> REQ-79013939@LHWesLk8a6d7 2yhttw
+          maxProperties: 1
+          additionalProperties: {$ref: "#/$defs/term"}
+
+  # @req> REQ-76262680@k4Ti3hJfcZ14 y4ql4s
+  - if: {required: [kind], properties: {kind: {const: parameter}}}
+    then:
+      # @req> REQ-20003259@dUyU2uLqjsIF gbexkl
+      required: [name, text, value_type]
+      properties:
+        ceiling: {not: {}}
+        fields: {not: {}}
+        # @req> REQ-91205530@FiUaykViw6dQ shltxs
+        # @req> REQ-71965656@F8ulVugEMpD- w2nm2t
+        entries: {x-flag: value, additionalProperties: {$ref: "#/$defs/entry"}}
+
+  # @req> REQ-49304907@NSnffmSJBDm1 2ihvkk
+  - if: {required: [kind], properties: {kind: {const: data}}}
+    then:
+      # @req> REQ-12896387@jvS0Os1oYPbk crwhts
+      required: [name]
+      properties:
+        value_type: {not: {}}
+        unit: {not: {}}
+        # @req> REQ-91205530@FiUaykViw6dQ dss2lp
+        # @req> REQ-71965656@F8ulVugEMpD- zxdanu
+        entries: {x-flag: entry, additionalProperties: {$ref: "#/$defs/entry"}}
+
+# @req> REQ-19756275@hGspvTpsKkDR xr244n
+$defs:
+
+  # @req> REQ-19756275@hGspvTpsKkDR pbyoly
+  entry:
+    type: object
+    additionalProperties: {$ref: "#/$defs/field"}
+    properties:
+      # @req> REQ-52544202@FdBPIIOU8f_v mfnskt
+      value_type: {$ref: "#/$defs/field", x-entry-of: value_types}
+      # @req> REQ-36712960@kffnEhw1AEbI f2vzxe
+      definition:
+        type: string
+        minLength: 1
+        # @req> REQ-51326810@tZsTSo6pwmwE wprnd5
+        # @req> REQ-67358511@6v5ZhXIOqAkD 54mfrx
+        # @req> REQ-59874866@fH6bFHN-Lwa8 fappkf
+        # @req> REQ-76604940@SEVyiDrbH-Ez qemprc
+        x-prose: true
+      # @req> REQ-42019737@90sIiSl5qAyl 46pfik
+      aliases: {not: {}}
+      # @req> REQ-42147485@VsERY4C491hX g5qe2q
+      unclaimed: {not: {}}
+      # @req> REQ-42335087@EHhmRZP7XeYW g6kvgb
+      name:
+        type: string
+        minLength: 1
+        maxLength: 40
+
+  term:
+    # @req> REQ-92166241@HTHjlgOGlMF7 6p6gqt
+    required: [word, definition]
+    # @req> REQ-19756275@hGspvTpsKkDR kanmmn
+    additionalProperties: {$ref: "#/$defs/field"}
+    properties:
+      # @req> REQ-47317077@nmlbp2InoWXJ 5i5a5b
+      word:
+        type: string
+        # @req> REQ-91205530@FiUaykViw6dQ jy2drg
+        # @req> REQ-71965656@F8ulVugEMpD- ixutwk
+        x-flag: term
+      # @req> REQ-36712960@kffnEhw1AEbI 46cyrm
+      definition: {$ref: "#/$defs/entry/properties/definition"}
+      # @req> REQ-91205530@FiUaykViw6dQ 4sfqcl
+      # @req> REQ-71965656@F8ulVugEMpD- w3rrjk
+      # @req> REQ-48736295@BEVQZyse_96M x3zziz
+      aliases: {type: array, uniqueItems: true, items: {type: string, minLength: 1}, x-flag: alias}
+      # @req> REQ-20106088@5vCa8KN82s2L jar5fh
+      unclaimed:
+        type: object
+        # @req> REQ-24370000@L3oFZSuyf_lZ jrazmf
+        additionalProperties: {type: string, x-prose: true}
+
+  # @req> REQ-19756275@hGspvTpsKkDR bb4ooz
+  field:
+    type: [string, number, boolean, array, object]
+    items: {type: [string, number, boolean]}
+    propertyNames:
+      type: string
+      minLength: 1
+    additionalProperties: {$ref: "#/$defs/entry"}

reqctl/schemas/guard.schema.yaml

@@ -0,0 +1,131 @@
+# @req> REQ-97751594@BwWOFlFOjjyU 2loty3
+$schema: "https://json-schema.org/draft/2020-12/schema"
+# @req> REQ-83218477@nthDaUhwd58l slnxeo
+$id: "reqctl/guard.schema.yaml"
+# @req> REQ-52846482@4k8T0YLN4n97 izj5r2
+type: object
+# @req> REQ-20678879@c210nefD6kHQ bioa7v
+additionalProperties: false
+
+# @req> REQ-20098211@G2knHaytDioI tvzckc
+# @req> REQ-60231841@jePDPrjCGq74 w7yc5t
+# @req> REQ-95625116@kUyiwf6F3QNx xvuqs4
+# @req> REQ-72206066@or5GPpF3qRjD e7qjzi
+# @req> REQ-29717668@RIdwMpfLVtSN d4na4n
+required: [text, status, acceptance_criteria, relations, assessed]
+
+# @req> REQ-20678879@c210nefD6kHQ gky3ek
+properties:
+
+  # @req> REQ-20098211@G2knHaytDioI 7d6syh
+  text:
+    type: string
+    minLength: 1
+    # @req> REQ-51326810@tZsTSo6pwmwE dcdmk5
+    # @req> REQ-67358511@6v5ZhXIOqAkD wn4rwf
+    # @req> REQ-59874866@fH6bFHN-Lwa8 525gw6
+    # @req> REQ-76604940@SEVyiDrbH-Ez tviwnj
+    x-prose: true
+
+  # @req> REQ-60231841@jePDPrjCGq74 d4xw2k
+  status:
+    enum: [draft, approved, deprecated, superseded]
+    # @req> REQ-21532897@4mlJA_VkJWru j4mcvz
+    default: draft
+
+  # @req> REQ-95625116@kUyiwf6F3QNx hlxsuk
+  acceptance_criteria:
+    type: array
+    # @req> REQ-40805826@MwrhRhY2S8aV utxx4z
+    default: []
+    # @req> REQ-91205530@FiUaykViw6dQ apmpds
+    # @req> REQ-71965656@F8ulVugEMpD- fiorno
+    x-flag: criterion
+    # @req> REQ-64010477@RC2labUfeA7H 3zaepd
+    items:
+      type: object
+      additionalProperties: false
+      required: [given, when, then]
+      properties:
+        # @req> REQ-51326810@tZsTSo6pwmwE ifmpy5
+        # @req> REQ-67358511@6v5ZhXIOqAkD 7b7u4g
+        # @req> REQ-59874866@fH6bFHN-Lwa8 5p2alw
+        # @req> REQ-76604940@SEVyiDrbH-Ez 5mnihj
+        given: {type: string, minLength: 1, x-prose: true}
+        # @req> REQ-51326810@tZsTSo6pwmwE bvmam4
+        # @req> REQ-67358511@6v5ZhXIOqAkD rlimsw
+        # @req> REQ-59874866@fH6bFHN-Lwa8 wsl2ie
+        # @req> REQ-76604940@SEVyiDrbH-Ez uizjht
+        when: {type: string, minLength: 1, x-prose: true}
+        # @req> REQ-51326810@tZsTSo6pwmwE 46mdi7
+        # @req> REQ-67358511@6v5ZhXIOqAkD yikagx
+        # @req> REQ-59874866@fH6bFHN-Lwa8 siwuzx
+        # @req> REQ-76604940@SEVyiDrbH-Ez 65k6m5
+        then: {type: string, minLength: 1, x-prose: true}
+
+  # @req> REQ-12136510@Q7qxyHYKDLns w5buq3
+  rationale:
+    type: string
+    # @req> REQ-51326810@tZsTSo6pwmwE zhkpa6
+    # @req> REQ-67358511@6v5ZhXIOqAkD utmgyj
+    # @req> REQ-59874866@fH6bFHN-Lwa8 py3hox
+    # @req> REQ-76604940@SEVyiDrbH-Ez gtawtc
+    x-prose: true
+
+  # @req> REQ-72206066@or5GPpF3qRjD rzaqpj
+  relations:
+    type: object
+    # @req> REQ-65468432@457yPXcCJ7jW ddw4ix
+    readOnly: true
+    # @req> REQ-79941148@1tVAUwfYfzOT zexepm
+    default: {}
+    # @req> REQ-27469480@hig9PDBc8EAL sl6rd2
+    propertyNames:
+      pattern: "^GUARD-[0-9]{8}$"
+    additionalProperties:
+      enum: [derives_from, depends_on, constrains, supersedes, conflicts_with]
+
+  # @req> REQ-29717668@RIdwMpfLVtSN 7tsbiq
+  assessed:
+    type: object
+    # @req> REQ-20438611@e9DfaZdZU0eT xvebja
+    readOnly: true
+    # @req> REQ-91894254@HA2Tpgi5MW9m romwk6
+    default: {}
+    # @req> REQ-76117220@AaFqkR9MGAa- vm2npn
+    propertyNames:
+      pattern: "^(GUARD-[0-9]{8}|[a-z][a-z0-9_]*)(\\..+)?$"
+    additionalProperties:
+      type: string
+      minLength: 1
+
+  # @req> REQ-29452949@uJo5VABUlYBe c6uqqp
+  citations:
+    type: object
+    # @req> REQ-89946019@X4MY0OTFXbag dqr3vu
+    readOnly: true
+    # @req> REQ-64498551@plqPhZrcgNff yv3eko
+    propertyNames:
+      pattern: "^[a-z2-7]{6}$"
+    # @req> REQ-60525163@3OcsvouN9GFx k5clyz
+    additionalProperties:
+      type: string
+      pattern: "^[A-Za-z0-9_-]{43}$"
+
+  # @req> REQ-40478019@_dwqsOpSOQXA aem4lb
+  whole_file_citations:
+    type: object
+    readOnly: true
+    propertyNames:
+      minLength: 1
+    additionalProperties:
+      type: object
+      additionalProperties: false
+      required: [pinned, digest]
+      properties:
+        pinned:
+          type: string
+          pattern: "^[A-Za-z0-9_-]{12}$"
+        digest:
+          type: string
+          pattern: "^[A-Za-z0-9_-]{43}$"

reqctl/schemas/requirement.schema.yaml

@@ -0,0 +1,152 @@
+# @req> REQ-97751594@BwWOFlFOjjyU 5sbikq
+$schema: "https://json-schema.org/draft/2020-12/schema"
+# @req> REQ-83218477@nthDaUhwd58l 7kxgvq
+$id: "reqctl/requirement.schema.yaml"
+# @req> REQ-52846482@4k8T0YLN4n97 ho5alx
+type: object
+# @req> REQ-20678879@c210nefD6kHQ sj2at6
+additionalProperties: false
+
+# @req> REQ-20098211@G2knHaytDioI 7wuse3
+# @req> REQ-75098293@uTbLO-CtERyf lq5h2w
+# @req> REQ-60231841@jePDPrjCGq74 r3skuz
+# @req> REQ-18969680@m-TFl7mdkBH_ rmqb2t
+# @req> REQ-34233802@zs99YCdQML6g 2wgdwc
+# @req> REQ-95625116@kUyiwf6F3QNx xxnnyy
+# @req> REQ-72206066@or5GPpF3qRjD oeehhz
+# @req> REQ-29717668@RIdwMpfLVtSN btnn3m
+required: [text, type, status, verification, priority, acceptance_criteria, relations, assessed]
+
+# @req> REQ-20678879@c210nefD6kHQ d42jgw
+properties:
+
+  # @req> REQ-20098211@G2knHaytDioI barydb
+  text:
+    type: string
+    minLength: 1
+    # @req> REQ-51326810@tZsTSo6pwmwE herx2o
+    # @req> REQ-67358511@6v5ZhXIOqAkD scvw2e
+    # @req> REQ-59874866@fH6bFHN-Lwa8 bb4d4e
+    # @req> REQ-76604940@SEVyiDrbH-Ez 733htw
+    x-prose: true
+
+  # @req> REQ-75098293@uTbLO-CtERyf udnboc
+  type:
+    enum: [functional, non_functional, constraint]
+    # @req> REQ-13331330@P4lNv8GZIYi5 suidvz
+    default: functional
+
+  # @req> REQ-60231841@jePDPrjCGq74 wtgfve
+  status:
+    enum: [draft, approved, deprecated, superseded]
+    # @req> REQ-21532897@4mlJA_VkJWru bqeoev
+    default: draft
+
+  # @req> REQ-35443917@I_xqd07AsRI5 efas27
+  # @req> REQ-87380206@s24vYGZICHft idouod
+  verification:
+    enum: [inspection, analysis, demonstration]
+    default: inspection
+
+  # @req> REQ-95625116@kUyiwf6F3QNx 3n7kdx
+  acceptance_criteria:
+    type: array
+    # @req> REQ-40805826@MwrhRhY2S8aV 5hswio
+    default: []
+    # @req> REQ-91205530@FiUaykViw6dQ e3xspv
+    # @req> REQ-71965656@F8ulVugEMpD- q4nno6
+    x-flag: criterion
+    # @req> REQ-64010477@RC2labUfeA7H ens75t
+    items:
+      type: object
+      additionalProperties: false
+      required: [given, when, then]
+      properties:
+        # @req> REQ-51326810@tZsTSo6pwmwE vnflam
+        # @req> REQ-67358511@6v5ZhXIOqAkD f6o5gy
+        # @req> REQ-59874866@fH6bFHN-Lwa8 3jfz4j
+        # @req> REQ-76604940@SEVyiDrbH-Ez 6q22bn
+        given: {type: string, minLength: 1, x-prose: true}
+        # @req> REQ-51326810@tZsTSo6pwmwE oaaz6i
+        # @req> REQ-67358511@6v5ZhXIOqAkD lfrvre
+        # @req> REQ-59874866@fH6bFHN-Lwa8 6z6dih
+        # @req> REQ-76604940@SEVyiDrbH-Ez yec3ne
+        when: {type: string, minLength: 1, x-prose: true}
+        # @req> REQ-51326810@tZsTSo6pwmwE innu6u
+        # @req> REQ-67358511@6v5ZhXIOqAkD tihnkp
+        # @req> REQ-59874866@fH6bFHN-Lwa8 rgv7rq
+        # @req> REQ-76604940@SEVyiDrbH-Ez 5o7gi4
+        then: {type: string, minLength: 1, x-prose: true}
+
+  # @req> REQ-34233802@zs99YCdQML6g x3wn7x
+  priority:
+    enum: [high, medium, low]
+    # @req> REQ-24203829@voUq-k4sF1lM oqje27
+    default: medium
+
+  # @req> REQ-12136510@Q7qxyHYKDLns 6jxptq
+  rationale:
+    type: string
+    # @req> REQ-51326810@tZsTSo6pwmwE w7r4bo
+    # @req> REQ-67358511@6v5ZhXIOqAkD myuvtx
+    # @req> REQ-59874866@fH6bFHN-Lwa8 gxhhuc
+    # @req> REQ-76604940@SEVyiDrbH-Ez ostref
+    x-prose: true
+
+  # @req> REQ-72206066@or5GPpF3qRjD rebolx
+  relations:
+    type: object
+    # @req> REQ-65468432@457yPXcCJ7jW xdlpsu
+    readOnly: true
+    # @req> REQ-79941148@1tVAUwfYfzOT c3ap4f
+    default: {}
+    # @req> REQ-79353110@BkH49V7f27Ux 5hl4ke
+    propertyNames:
+      pattern: "^REQ-[0-9]{8}$"
+    additionalProperties:
+      enum: [derives_from, depends_on, constrains, supersedes, conflicts_with]
+
+  # @req> REQ-29717668@RIdwMpfLVtSN hzpraj
+  assessed:
+    type: object
+    # @req> REQ-20438611@e9DfaZdZU0eT hjvz6r
+    readOnly: true
+    # @req> REQ-91894254@HA2Tpgi5MW9m qzqq6g
+    default: {}
+    # @req> REQ-61848293@mqx_oBnVQn8f r55whv
+    propertyNames:
+      pattern: "^(REQ-[0-9]{8}|[a-z][a-z0-9_]*)(\\..+)?$"
+    additionalProperties:
+      type: string
+      minLength: 1
+
+  # @req> REQ-29452949@uJo5VABUlYBe zkmdiw
+  citations:
+    type: object
+    # @req> REQ-89946019@X4MY0OTFXbag osv6l4
+    readOnly: true
+    # @req> REQ-64498551@plqPhZrcgNff 5sdhfc
+    propertyNames:
+      pattern: "^[a-z2-7]{6}$"
+    # @req> REQ-60525163@3OcsvouN9GFx 3hchvm
+    additionalProperties:
+      type: string
+      pattern: "^[A-Za-z0-9_-]{43}$"
+
+  # @req> REQ-40478019@_dwqsOpSOQXA bormph
+  whole_file_citations:
+    type: object
+    readOnly: true
+    propertyNames:
+      minLength: 1
+    additionalProperties:
+      type: object
+      additionalProperties: false
+      required: [pinned, digest]
+      properties:
+        pinned:
+          type: string
+          pattern: "^[A-Za-z0-9_-]{12}$"
+        digest:
+          type: string
+          pattern: "^[A-Za-z0-9_-]{43}$"