api-request.schema.json

{
  "$id": "https://oneteme.github.io/api-request.schema.json",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "ApiResquet",
  "type": "array",
  "items": {
    "allOf": [
      { "$ref": "https://oneteme.github.io/http-request.schema.json" },
      { "$ref": "#/definitions/api" }
    ]
  },
  "definitions": {
    "api": {
      "type": "object",
      "properties" : {
        "id": {
          "type": "integer",
          "description": "API identity [optional null by default]",
          "minimum":0
        },
        "name": {
          "type": "string",
          "description": "API name [optional null by default]",
          "pattern": "^\\w+$"
        },
        "version": {
          "type": "integer",
          "description": "API version [optional null by default]",
          "minimum":0
        },
        "description": {
          "type": "string",
          "description": "API description [optional null by default]"
        },
        "comparisonConfig":{
          "type": "object",
          "description": "Response comparison configuration [optional null by default]",
          "properties": {
            "type": {
              "type": "string",
              "enum": ["JSON","CSV","TXT","ZIP"],
              "description": "response type [required]"
            }
          },
          "required": ["type"]
        },
        "executionConfig":{
          "type": "object",
          "description": "Api execution configuration [optional]",
          "properties": {
            "enabled": {
              "type": "boolean",
              "description": "enable api assertion execution [true by default]"
            },
            "parallel": {
              "type": "boolean",
              "description": "enable parallel stable & latest api execution [true by default]"
            }
          }
        },
        "stableApi": {
          "$ref": "https://oneteme.github.io/http-request.schema.json" ,
          "additionalProperties": false
        }
      }
    }
  }
}