Skip to content
AveraAveraAvera Documentation

Update project settings

PATCH
/api/v1/projects/{projectIdOrKey}/settings
curl --request PATCH \
  --url https://app.avera.io/api/v1/projects/example/settings \
  --header 'Content-Type: application/json' \
  --data '{ "numbering": { "scheme": "TYPE_ONLY", "projectPrefix": "example", "separator": "example", "padDigits": 1, "perTypeSequences": true, "customPattern": "example" }, "defaultAiModel": "example", "validation": { "requirementItemType": "example", "testItemType": "example" }, "documents": { "headingNumbering": true } }'

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
projectIdOrKey
required
string

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
numbering
required
object
scheme
required
string
Allowed values: TYPE_ONLY PROJECT_PREFIX CUSTOM
projectPrefix
string | null
separator
required
string
padDigits
required
integer format: int32
perTypeSequences
required
boolean
customPattern
string | null
defaultAiModel
string | null
validation
required
object
requirementItemType
string | null
testItemType
string | null
documents
required
object
headingNumbering
required
boolean

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media type*/*
object
numbering
required
object
scheme
required
string
Allowed values: TYPE_ONLY PROJECT_PREFIX CUSTOM
projectPrefix
string | null
separator
required
string
padDigits
required
integer format: int32
perTypeSequences
required
boolean
customPattern
string | null
defaultAiModel
string | null
validation
required
object
requirementItemType
string | null
testItemType
string | null
documents
required
object
headingNumbering
required
boolean