v15

latestOpenAPI 3.0.0Apache 2.0raw.githubusercontent.com2019-08-1511717.2 KB

Domains

Update a schema with given URI.

Updates a schema with given URI.

put/domains/{domainId}/schemas/{uri}

Path parameters

domainIdstring required

ID of the domain to update schema for

uristring required

URI of the schema to update

Request body

namestring required

descriptionstring

valueobject

Example request

{
  "value": {
    "$id": "address",
    "required": [
      "street_address",
      "city",
      "state"
    ],
    "properties": {
      "street_address": {
        "type": "string"
      },
      "city": {
        "type": "string"
      },
      "state": {
        "type": "string"
      }
    }
  }
}

Response

successful operation

Example response

{
  "data": {
    "value": {
      "$id": "address",
      "required": [
        "street_address",
        "city",
        "state"
      ],
      "properties": {
        "street_address": {
          "type": "string"
        },
        "city": {
          "type": "string"
        },
        "state": {
          "type": "string"
        }
      }
    }
  }
}