@@ -47,7 +47,7 @@ _issue_ would have all _issue_ fields plus _bug_-specific fields like _RCA_.
47
47
48
48
Subtypes are defined using a schema fragment of type ` custom_type_fragment ` .
49
49
50
- ## Customizing a DevRev object
50
+ ## Customize a DevRev object
51
51
<Callout intent = " note" >
52
52
Your team needs to track software bugs. You want to know:
53
53
- Which environments are affected (development, testing, production)
@@ -388,7 +388,7 @@ The object now references the latest fragment version (`custom_type_fragment/2`)
388
388
the optional release notes field is absent, the tenant fragment remains attached,
389
389
allowing for future tenant-specific field additions.
390
390
391
- ## Deprecating a custom schema fragment
391
+ ## Deprecate a custom schema fragment
392
392
393
393
Custom schema fragments can be deprecated to avoid creating work items using them. The
394
394
following POST request payload to ` schemas.custom.set ` can be used:
@@ -406,7 +406,7 @@ following POST request payload to `schemas.custom.set` can be used:
406
406
}
407
407
```
408
408
409
- ## Listing custom schema fragments
409
+ ## List custom schema fragments
410
410
411
411
The following API call can be used to list all the custom schema fragments in your
412
412
organization:
@@ -431,10 +431,16 @@ hints:
431
431
* ` is_sortable ` : Whether the field is sortable. Requires ` is_filterable ` to be true.
432
432
* ` is_groupable ` : Whether the field is groupable. Requires ` is_filterable ` to be true.
433
433
* ` order ` : The order in which the field appears in the side panel.
434
+ * ` is_read_only ` : Whether the field is read-only in the UI. Once the object is created, this
435
+ field cannot be updated in the UI.
434
436
* ` group_name ` : The group title under which field(s) appear in the side panel. In the
435
437
example below, the fields are grouped under groups titled ** Group 1** and ** Group 2** .
436
438
437
439
![ customization-group_name-ui-hint] ( ../img/customization-group_name-ui-hint.png )
440
+ * ` unit ` : The unit for the field. For example, days, kg. The unit is displayed
441
+ in the side panel as shown below:
442
+
443
+ ![ customization-unit-ui-hint] ( ../img/customization-unit-ui-hint.png )
438
444
439
445
<Callout intent = " tip" >
440
446
` is_filterable ` is not a UI hint but a top level field property.
@@ -535,7 +541,7 @@ and _closed_ states in your organization.
535
541
You want to add a new stage _ Needs RCA_ to the _ bug_ subtype.
536
542
</Callout >
537
543
538
- ### Adding a custom stage
544
+ ### Add a custom stage
539
545
540
546
``` curl
541
547
curl --location 'https://api.devrev.ai/stages.custom.create' \
@@ -622,7 +628,7 @@ curl --location 'https://api.devrev.ai/stage-diagrams.create' \
622
628
It is important to specify the start stage for the diagram. This is the default stage that gets assigned to the newly created objects.
623
629
</Callout >
624
630
625
- ### Using a stage diagram
631
+ ### Apply a stage diagram
626
632
627
633
The stage diagram created above can be referenced in the _ bug_ subtype as follows:
628
634
0 commit comments