runtime_mutations
rules

Update Rule Handler

put/api/rules/{rule_id}

Path parameters

rule_idstring required

Request body

namestring nullable
descriptionstring nullable
contentstring nullable
rule_type'always' | 'manual' | 'pipeline'
globsstring[] nullable
workspace_idstring nullable
file_pathstring nullable
pipelineobject nullable

Response

Successful Response

{"stackTrail":"paths:/api/rules/{rule_id}:put:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}

Changes

Changed in 2 of the 16 revisions of this API.13

  • bc8a81bf391411See the full diff
    • removed the request property project_id

      request-property-removed

    • added the new optional request property workspace_id

      new-optional-request-property

    This revision also has 8 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added the new optional request property pipeline

      new-optional-request-property

    • added the new pipeline enum value to the request property rule_type/anyOf[subschema #1: RuleType]/

      request-property-enum-value-added

    This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog