@@ -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
- ## Customize a DevRev object
50
+ ## Customize DevRev objects
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)
@@ -226,7 +226,7 @@ The following custom field types are supported -
226
226
The list variants of all the supported custom field types are also supported.
227
227
In the example above, the ` impacted_environments ` field is a list of enum values.
228
228
229
- ## Filtering DevRev objects
229
+ ## Filter DevRev objects
230
230
231
231
<Callout intent = " note" >
232
232
To demonstrate filtering capabilities, consider finding all bugs in the 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
- ## Deprecate a custom schema fragment
391
+ ## Deprecate custom schema fragments
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:
@@ -419,7 +419,7 @@ curl --location 'https://api.devrev.ai/schemas.custom.list' \
419
419
420
420
Deprecated fragments aren't listed in the response.
421
421
422
- ## UI hints
422
+ ## Configure UI hints
423
423
424
424
UI hints allow customizing the UI/UX of custom fields. So far, ` ui.display_name ` has
425
425
been used to set the display name of a field. Let's look at the other supported UI
@@ -446,7 +446,7 @@ hints:
446
446
` is_filterable ` is not a UI hint but a top level field property.
447
447
</Callout >
448
448
449
- ## Stock field overrides
449
+ ## Override stock fields
450
450
451
451
The fields available in native DevRev objects are called stock fields. For example,
452
452
` priority ` is a stock field of _ issue_ .
@@ -514,7 +514,7 @@ A few observations can be made from the above payload:
514
514
If you want the overrides to be scoped to a subtype, you can add them to the subtype
515
515
instead.
516
516
517
- ## Stage customization
517
+ ## Customize stages
518
518
519
519
Stages represent the different phases an object can be in during its lifecycle. For
520
520
example, an issue might go through the following lifecycle:
@@ -541,7 +541,7 @@ and _closed_ states in your organization.
541
541
You want to add a new stage _ Needs RCA_ to the _ bug_ subtype.
542
542
</Callout >
543
543
544
- ### Add a custom stage
544
+ ### Create custom stages
545
545
546
546
``` curl
547
547
curl --location 'https://api.devrev.ai/stages.custom.create' \
@@ -558,7 +558,7 @@ A stage can be referenced by any object type. For example, both _issue_ and _tic
558
558
object types can use the _ in_development_ stage. It's incorrect to say that the stage is
559
559
bound to an _ issue_ or _ ticket_ .
560
560
561
- ### Stage diagram
561
+ ### Create stage diagrams
562
562
563
563
A stage diagram determines the allowed transitions between stages for a given object.
564
564
For example, _ triage_ stage can transition to _ backlog_ stage but not vice versa.
@@ -628,7 +628,7 @@ curl --location 'https://api.devrev.ai/stage-diagrams.create' \
628
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.
629
629
</Callout >
630
630
631
- ### Apply a stage diagram
631
+ ### Apply stage diagrams
632
632
633
633
The stage diagram created above can be referenced in the _ bug_ subtype as follows:
634
634
@@ -649,7 +649,7 @@ curl --location 'https://api.devrev.ai/schemas.custom.set' \
649
649
650
650
All objects of the _ bug_ subtype now adhere to the stage diagram created above.
651
651
652
- ## Dependent fields
652
+ ## Configure dependent fields
653
653
654
654
<Callout intent = " note" >
655
655
The developers in your organization tend to forget to add an RCA when resolving the
0 commit comments