v1

latestOpenAPI 3.0.02026-07-175152156.1 KB
AppVersionAbility

Edits an ability for an application version

put/app/{appId}/version/{appVersion}/ability/{abilityPackageName}

Path parameters

appIdnumber required

ID of the target application

appVersionnumber required

Version # of the target application version

abilityPackageNamestring required

The NPM package name

Request body

hiddenSupportedPoliciesstring[]

Policies that are supported by this ability, but are hidden from users of this app specifically

Example request

{
  "hiddenSupportedPolicies": [
    "@vincent/foo-bar-policy-1",
    "@vincent/foo-bar-policy-2"
  ]
}

Response

Successful operation

_idstring required

Document ID

updatedAtstring date-time required

Timestamp when this was last modified

createdAtstring date-time required

Timestamp when this was created

appIdnumber required

Application ID

appVersionnumber required

Application version

abilityPackageNamestring required

Ability package name

abilityVersionstring required

Ability version

hiddenSupportedPoliciesstring[]

Policies that are supported by this ability, but are hidden from users of this app specifically

isDeletedboolean

Whether or not this AppVersionAbility is deleted

Example response

{
  "appId": 5,
  "appVersion": 2,
  "abilityPackageName": "@vincent/foo-bar",
  "abilityVersion": "1.0.0",
  "hiddenSupportedPolicies": [
    "@vincent/foo-bar-policy-1",
    "@vincent/foo-bar-policy-2"
  ]
}