@itentialopensource/adapter-azure_devops/entities/Commits/schema.json

This adapter integrates with system described as: Azure DevOps.

{
  "$id": "schema.json",
  "type": "object",
  "schema": "http://json-schema.org/draft-07/schema#",
  "translate": true,
  "dynamicfields": true,
  "properties": {
    "ph_request_type": {
      "type": "string",
      "description": "type of request (internal to adapter)",
      "default": "commitsGetCommits",
      "enum": [
        "commitsGetPushCommits",
        "commitsGet",
        "commitsGetChanges",
        "commitsGetCommits",
        "commitsGetCommitsBatch"
      ],
      "external_name": "ph_request_type"
    },
    "skip": {
      "type": "number",
      "description": "Number of entries to skip",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "$skip"
    },
    "top": {
      "type": "number",
      "description": "Maximum number of entries to retrieve",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "$top"
    },
    "searchCriteriaAuthor": {
      "type": "string",
      "description": "Alias or display name of the author",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "searchCriteria\\.author"
    },
    "searchCriteriaCompareVersionVersion": {
      "type": "string",
      "description": "Version string identifier (name of tag/branch, SHA1 of commit)",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "searchCriteria\\.compareVersion\\.version"
    },
    "searchCriteriaCompareVersionVersionOptions": {
      "type": "string",
      "description": "Version options - Specify additional modifiers to version (e.g Previous)",
      "parse": true,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "searchCriteria\\.compareVersion\\.versionOptions"
    },
    "searchCriteriaCompareVersionVersionType": {
      "type": "string",
      "description": "Version type (branch, tag, or commit). Determines how Id is interpreted",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "searchCriteria\\.compareVersion\\.versionType"
    },
    "searchCriteriaExcludeDeletes": {
      "type": "boolean",
      "description": "Only applies when an itemPath is specified. This determines whether to exclude delete entries of the specified path.",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "searchCriteria\\.excludeDeletes"
    },
    "searchCriteriaFromCommitId": {
      "type": "string",
      "description": "If provided, a lower bound for filtering commits alphabetically",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "searchCriteria\\.fromCommitId"
    },
    "searchCriteriaFromDate": {
      "type": "string",
      "description": "If provided, only include history entries created after this date (string)",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "searchCriteria\\.fromDate"
    },
    "searchCriteriaHistoryMode": {
      "type": "string",
      "description": "What Git history mode should be used. This only applies to the search criteria when Ids = null and an itemPath is specified.",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "searchCriteria\\.historyMode"
    },
    "searchCriteriaIds": {
      "type": "array",
      "description": "If provided, specifies the exact commit ids of the commits to fetch. May not be combined with other parameters.",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "searchCriteria\\.ids"
    },
    "searchCriteriaIncludeLinks": {
      "type": "boolean",
      "description": "Whether to include the _links field on the shallow references",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "searchCriteria\\.includeLinks"
    },
    "searchCriteriaIncludePushData": {
      "type": "boolean",
      "description": "Whether to include the push information",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "searchCriteria\\.includePushData"
    },
    "searchCriteriaIncludeUserImageUrl": {
      "type": "boolean",
      "description": "Whether to include the image Url for committers and authors",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "searchCriteria\\.includeUserImageUrl"
    },
    "searchCriteriaIncludeWorkItems": {
      "type": "boolean",
      "description": "Whether to include linked work items",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "searchCriteria\\.includeWorkItems"
    },
    "searchCriteriaItemPath": {
      "type": "string",
      "description": "Path of item to search under",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "searchCriteria\\.itemPath"
    },
    "searchCriteriaItemVersionVersion": {
      "type": "string",
      "description": "Version string identifier (name of tag/branch, SHA1 of commit)",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "searchCriteria\\.itemVersion\\.version"
    },
    "searchCriteriaItemVersionVersionOptions": {
      "type": "string",
      "description": "Version options - Specify additional modifiers to version (e.g Previous)",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "searchCriteria\\.itemVersion\\.versionOptions"
    },
    "searchCriteriaItemVersionVersionType": {
      "type": "string",
      "description": "Version type (branch, tag, or commit). Determines how Id is interpreted",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "searchCriteria\\.itemVersion\\.versionType"
    },
    "searchCriteriaShowOldestCommitsFirst": {
      "type": "boolean",
      "description": "If enabled, this option will ignore the itemVersion and compareVersion parameters",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "searchCriteria\\.showOldestCommitsFirst"
    },
    "searchCriteriaToCommitId": {
      "type": "string",
      "description": "If provided, an upper bound for filtering commits alphabetically",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "searchCriteria\\.toCommitId"
    },
    "searchCriteriaToDate": {
      "type": "string",
      "description": "If provided, only include history entries created before this date (string)",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "searchCriteria\\.toDate"
    },
    "searchCriteriaUser": {
      "type": "string",
      "description": "Alias or display name of the committer",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "searchCriteria\\.user"
    },
    "apiVersion": {
      "type": "string",
      "description": "Version of the API to use.  This should be set to '6.1-preview.1' to use this version of the api.",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "api-version"
    }
  },
  "definitions": {}
}