Devops

Update the WoT validation config

PUT

https://ditto.eclipseprojects.io/devops/wot/config

curl -X PUT 'https://ditto.eclipseprojects.io/devops/wot/config' \
  -H 'Authorization: Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "configId": "string",
  "enabled": true,
  "log-warning-instead-of-failing-api-calls": true,
  "thing": {
    "enforce": {
      "enforce-thing-description-modification": true,
      "attributes": true,
      "inbox-messages-input": true,
      "inbox-messages-output": true,
      "outbox-messages": true
    },
    "forbid": {
      "thing-description-deletion": true,
      "non-modeled-attributes": true,
      "non-modeled-inbox-messages": true,
      "non-modeled-outbox-messages": true
    }
  },
  "feature": {
    "enforce": {
      "featureDescriptionModification": true,
      "presenceOfModeledFeatures": true,
      "properties": true,
      "desiredProperties": true,
      "inbox-messages-input": true,
      "inbox-messages-output": true,
      "outbox-messages": true
    },
    "forbid": {
      "featureDescriptionDeletion": true,
      "nonModeledFeatures": true,
      "nonModeledProperties": true,
      "nonModeledDesiredProperties": true,
      "non-modeled-inbox-messages": true,
      "non-modeled-outbox-messages": true
    }
  },
  "dynamic-config": [
    {
      "scope-id": "string",
      "validation-context": {
        "ditto-headers-patterns": [
          {}
        ],
        "thing-definition-patterns": [
          "string"
        ],
        "feature-definition-patterns": [
          "string"
        ],
        "scope-id": "string"
      },
      "config-overrides": {
        "enabled": true,
        "log-warning-instead-of-failing-api-calls": true,
        "thing": {
          "enforce": {
            "enforce-thing-description-modification": true,
            "attributes": true,
            "inbox-messages-input": true,
            "inbox-messages-output": true,
            "outbox-messages": true
          },
          "forbid": {
            "thing-description-deletion": true,
            "non-modeled-attributes": true,
            "non-modeled-inbox-messages": true,
            "non-modeled-outbox-messages": true
          }
        },
        "feature": {
          "enforce": {
            "featureDescriptionModification": true,
            "presenceOfModeledFeatures": true,
            "properties": true,
            "desiredProperties": true,
            "inbox-messages-input": true,
            "inbox-messages-output": true,
            "outbox-messages": true
          },
          "forbid": {
            "featureDescriptionDeletion": true,
            "nonModeledFeatures": true,
            "nonModeledProperties": true,
            "nonModeledDesiredProperties": true,
            "non-modeled-inbox-messages": true,
            "non-modeled-outbox-messages": true
          }
        }
      }
    }
  ],
  "revision": 0,
  "created": "2024-01-15T09:30:00Z",
  "modified": "2024-01-15T09:30:00Z",
  "deleted": true,
  "metadata": {}
}'

const body = `{
  "configId": "string",
  "enabled": true,
  "log-warning-instead-of-failing-api-calls": true,
  "thing": {
    "enforce": {
      "enforce-thing-description-modification": true,
      "attributes": true,
      "inbox-messages-input": true,
      "inbox-messages-output": true,
      "outbox-messages": true
    },
    "forbid": {
      "thing-description-deletion": true,
      "non-modeled-attributes": true,
      "non-modeled-inbox-messages": true,
      "non-modeled-outbox-messages": true
    }
  },
  "feature": {
    "enforce": {
      "featureDescriptionModification": true,
      "presenceOfModeledFeatures": true,
      "properties": true,
      "desiredProperties": true,
      "inbox-messages-input": true,
      "inbox-messages-output": true,
      "outbox-messages": true
    },
    "forbid": {
      "featureDescriptionDeletion": true,
      "nonModeledFeatures": true,
      "nonModeledProperties": true,
      "nonModeledDesiredProperties": true,
      "non-modeled-inbox-messages": true,
      "non-modeled-outbox-messages": true
    }
  },
  "dynamic-config": [
    {
      "scope-id": "string",
      "validation-context": {
        "ditto-headers-patterns": [
          {}
        ],
        "thing-definition-patterns": [
          "string"
        ],
        "feature-definition-patterns": [
          "string"
        ],
        "scope-id": "string"
      },
      "config-overrides": {
        "enabled": true,
        "log-warning-instead-of-failing-api-calls": true,
        "thing": {
          "enforce": {
            "enforce-thing-description-modification": true,
            "attributes": true,
            "inbox-messages-input": true,
            "inbox-messages-output": true,
            "outbox-messages": true
          },
          "forbid": {
            "thing-description-deletion": true,
            "non-modeled-attributes": true,
            "non-modeled-inbox-messages": true,
            "non-modeled-outbox-messages": true
          }
        },
        "feature": {
          "enforce": {
            "featureDescriptionModification": true,
            "presenceOfModeledFeatures": true,
            "properties": true,
            "desiredProperties": true,
            "inbox-messages-input": true,
            "inbox-messages-output": true,
            "outbox-messages": true
          },
          "forbid": {
            "featureDescriptionDeletion": true,
            "nonModeledFeatures": true,
            "nonModeledProperties": true,
            "nonModeledDesiredProperties": true,
            "non-modeled-inbox-messages": true,
            "non-modeled-outbox-messages": true
          }
        }
      }
    }
  ],
  "revision": 0,
  "created": "2024-01-15T09:30:00Z",
  "modified": "2024-01-15T09:30:00Z",
  "deleted": true,
  "metadata": {}
}`;

const response = await fetch('https://ditto.eclipseprojects.io/devops/wot/config', {
  method: 'PUT',
  headers: {
    'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
    'Content-Type': 'application/json',
  },
  body,
});

const data = await response.text();

import requests

body = '''{
  "configId": "string",
  "enabled": true,
  "log-warning-instead-of-failing-api-calls": true,
  "thing": {
    "enforce": {
      "enforce-thing-description-modification": true,
      "attributes": true,
      "inbox-messages-input": true,
      "inbox-messages-output": true,
      "outbox-messages": true
    },
    "forbid": {
      "thing-description-deletion": true,
      "non-modeled-attributes": true,
      "non-modeled-inbox-messages": true,
      "non-modeled-outbox-messages": true
    }
  },
  "feature": {
    "enforce": {
      "featureDescriptionModification": true,
      "presenceOfModeledFeatures": true,
      "properties": true,
      "desiredProperties": true,
      "inbox-messages-input": true,
      "inbox-messages-output": true,
      "outbox-messages": true
    },
    "forbid": {
      "featureDescriptionDeletion": true,
      "nonModeledFeatures": true,
      "nonModeledProperties": true,
      "nonModeledDesiredProperties": true,
      "non-modeled-inbox-messages": true,
      "non-modeled-outbox-messages": true
    }
  },
  "dynamic-config": [
    {
      "scope-id": "string",
      "validation-context": {
        "ditto-headers-patterns": [
          {}
        ],
        "thing-definition-patterns": [
          "string"
        ],
        "feature-definition-patterns": [
          "string"
        ],
        "scope-id": "string"
      },
      "config-overrides": {
        "enabled": true,
        "log-warning-instead-of-failing-api-calls": true,
        "thing": {
          "enforce": {
            "enforce-thing-description-modification": true,
            "attributes": true,
            "inbox-messages-input": true,
            "inbox-messages-output": true,
            "outbox-messages": true
          },
          "forbid": {
            "thing-description-deletion": true,
            "non-modeled-attributes": true,
            "non-modeled-inbox-messages": true,
            "non-modeled-outbox-messages": true
          }
        },
        "feature": {
          "enforce": {
            "featureDescriptionModification": true,
            "presenceOfModeledFeatures": true,
            "properties": true,
            "desiredProperties": true,
            "inbox-messages-input": true,
            "inbox-messages-output": true,
            "outbox-messages": true
          },
          "forbid": {
            "featureDescriptionDeletion": true,
            "nonModeledFeatures": true,
            "nonModeledProperties": true,
            "nonModeledDesiredProperties": true,
            "non-modeled-inbox-messages": true,
            "non-modeled-outbox-messages": true
          }
        }
      }
    }
  ],
  "revision": 0,
  "created": "2024-01-15T09:30:00Z",
  "modified": "2024-01-15T09:30:00Z",
  "deleted": true,
  "metadata": {}
}'''

response = requests.put(
    'https://ditto.eclipseprojects.io/devops/wot/config',
    data=body.encode('utf-8'),
    headers={
        'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
        'Content-Type': 'application/json',
    },
)
print(response.text)

Request Body

{
  "configId": "string",
  "enabled": true,
  "log-warning-instead-of-failing-api-calls": true,
  "thing": {
    "enforce": {
      "enforce-thing-description-modification": true,
      "attributes": true,
      "inbox-messages-input": true,
      "inbox-messages-output": true,
      "outbox-messages": true
    },
    "forbid": {
      "thing-description-deletion": true,
      "non-modeled-attributes": true,
      "non-modeled-inbox-messages": true,
      "non-modeled-outbox-messages": true
    }
  },
  "feature": {
    "enforce": {
      "featureDescriptionModification": true,
      "presenceOfModeledFeatures": true,
      "properties": true,
      "desiredProperties": true,
      "inbox-messages-input": true,
      "inbox-messages-output": true,
      "outbox-messages": true
    },
    "forbid": {
      "featureDescriptionDeletion": true,
      "nonModeledFeatures": true,
      "nonModeledProperties": true,
      "nonModeledDesiredProperties": true,
      "non-modeled-inbox-messages": true,
      "non-modeled-outbox-messages": true
    }
  },
  "dynamic-config": [
    {
      "scope-id": "string",
      "validation-context": {
        "ditto-headers-patterns": [
          {}
        ],
        "thing-definition-patterns": [
          "string"
        ],
        "feature-definition-patterns": [
          "string"
        ],
        "scope-id": "string"
      },
      "config-overrides": {
        "enabled": true,
        "log-warning-instead-of-failing-api-calls": true,
        "thing": {
          "enforce": {
            "enforce-thing-description-modification": true,
            "attributes": true,
            "inbox-messages-input": true,
            "inbox-messages-output": true,
            "outbox-messages": true
          },
          "forbid": {
            "thing-description-deletion": true,
            "non-modeled-attributes": true,
            "non-modeled-inbox-messages": true,
            "non-modeled-outbox-messages": true
          }
        },
        "feature": {
          "enforce": {
            "featureDescriptionModification": true,
            "presenceOfModeledFeatures": true,
            "properties": true,
            "desiredProperties": true,
            "inbox-messages-input": true,
            "inbox-messages-output": true,
            "outbox-messages": true
          },
          "forbid": {
            "featureDescriptionDeletion": true,
            "nonModeledFeatures": true,
            "nonModeledProperties": true,
            "nonModeledDesiredProperties": true,
            "non-modeled-inbox-messages": true,
            "non-modeled-outbox-messages": true
          }
        }
      }
    }
  ],
  "revision": 0,
  "created": "2024-01-15T09:30:00Z",
  "modified": "2024-01-15T09:30:00Z",
  "deleted": true,
  "metadata": {}
}

Body

application/json

WoT validation configuration object.

configIdstringrequired

The unique ID of the config.

enabledboolean

Whether WoT validation is enabled globally. Defaults to true if not specified.

log-warning-instead-of-failing-api-callsboolean

thingThingValidationConfigrequired

Thing validation config.

Show child attributes

enforceobject

Show child attributes

enforce-thing-description-modificationboolean

attributesboolean

inbox-messages-inputboolean

inbox-messages-outputboolean

outbox-messagesboolean

forbidobject

Show child attributes

thing-description-deletionboolean

non-modeled-attributesboolean

non-modeled-inbox-messagesboolean

non-modeled-outbox-messagesboolean

featureFeatureValidationConfigrequired

Feature validation config.

Show child attributes

enforceobject

Show child attributes

featureDescriptionModificationboolean

presenceOfModeledFeaturesboolean

propertiesboolean

desiredPropertiesboolean

inbox-messages-inputboolean

inbox-messages-outputboolean

outbox-messagesboolean

forbidobject

Show child attributes

featureDescriptionDeletionboolean

nonModeledFeaturesboolean

nonModeledPropertiesboolean

nonModeledDesiredPropertiesboolean

non-modeled-inbox-messagesboolean

non-modeled-outbox-messagesboolean

dynamic-configArray<DynamicValidationConfig>

Show child attributes

Dynamic config section for request/response.

scope-idstringrequired

validation-contextValidationContextrequired

Validation context for dynamic config section.

Show child attributes

ditto-headers-patternsArray<object>

Show child attributes

[key: string]string

thing-definition-patternsArray<string>

feature-definition-patternsArray<string>

scope-idstringrequired

config-overridesConfigOverridesrequired

Config overrides for a dynamic config section.

Show child attributes

enabledbooleanrequired

log-warning-instead-of-failing-api-callsboolean

thingThingValidationConfigrequired

Thing validation config.

Show child attributes

enforceobject

Show child attributes

enforce-thing-description-modificationboolean

attributesboolean

inbox-messages-inputboolean

inbox-messages-outputboolean

outbox-messagesboolean

forbidobject

Show child attributes

thing-description-deletionboolean

non-modeled-attributesboolean

non-modeled-inbox-messagesboolean

non-modeled-outbox-messagesboolean

featureFeatureValidationConfigrequired

Feature validation config.

Show child attributes

enforceobject

Show child attributes

featureDescriptionModificationboolean

presenceOfModeledFeaturesboolean

propertiesboolean

desiredPropertiesboolean

inbox-messages-inputboolean

inbox-messages-outputboolean

outbox-messagesboolean

forbidobject

Show child attributes

featureDescriptionDeletionboolean

nonModeledFeaturesboolean

nonModeledPropertiesboolean

nonModeledDesiredPropertiesboolean

non-modeled-inbox-messagesboolean

non-modeled-outbox-messagesboolean

revisioninteger<int64>

createdstring<date-time>

modifiedstring<date-time>

deletedboolean

metadataobject

Response

204No Content

Updated config

Authorization

DevOpsBasichttp (basic)

Eclipse Ditto devops user (devops) + password (foobar)

DevOpsBearerhttp (bearer)

A JSON Web Token issued by a supported OAuth 2.0 Identity Provider for the Eclipse Ditto devops user.

Docs by Sourcey