OPopenintegrationhub
Domains

Create schema.

Changed on

This endpoint is used to send new schema for a given domain.

post/domains/{domainId}/schemas

Request

Path parameters

domainIdstring required

ID of the domain to import model into

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"
        }
      }
    }
  }
}

Changes

  • 834571f85ba3Revision changes
    • info

      added the non-success response with the status

  • f73867fae82fRevision changes
    • breaking

      added subschema #2 to the request body allOf list

    • breaking

      the request's body type changed from object to no type

    • warning

      removed the request property