json.schema.entity.services.connections.apiService.restConnection.json Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of openmetadata-spec Show documentation

There is a newer version: 1.6.0-rc1

{
  "$id": "https://open-metadata.org/schema/entity/services/connections/apiService/restConnection.json",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "RESTConnection",
  "description": "REST Connection Config",
  "type": "object",
  "javaType": "org.openmetadata.schema.services.connections.api.RESTConnection",
  "definitions": {
    "RESTAPIType": {
      "description": "REST API type",
      "type": "string",
      "enum": ["REST"],
      "default": "REST"
    }
  },
  "properties": {
    "type": {
      "title": "REST API Type",
      "description": "REST API Type",
      "$ref": "#/definitions/RESTAPIType",
      "default": "REST"
    },
    "openAPISchemaURL": {
      "expose": true,
      "title": "OpenAPISchemaURL",
      "description": "Open API Schema URL.",
      "type": "string",
      "format": "uri"
    },
    "token": {
      "title": "Token",
      "description": "Generated Token to connect to OpenAPI Schema.",
      "type": "string",
      "format": "password"
    }
  },
  "additionalProperties": false,
  "required": ["openAPISchemaURL"]
}