@itentialopensource/adapter-azure_devops 0.1.3 → 0.1.5

package/CHANGELOG.md

@@ -1,4 +1,20 @@
 
+## 0.1.5 [11-22-2022]
+
+* Implement API request Commits – Get Commits
+
+See merge request itentialopensource/adapters/devops-netops/adapter-azure_devops!5
+
+---
+
+## 0.1.4 [11-22-2022]
+
+* Query parameter across all apis showing as “apiVersion” instead of api-version
+
+See merge request itentialopensource/adapters/devops-netops/adapter-azure_devops!4
+
+---
+
 ## 0.1.3 [10-31-2022]
 
 * Azure DevOps Adapter Mixed Path Variables

package/adapter.js

@@ -5003,6 +5003,124 @@ class AzureDevops extends AdapterBaseCl {
     }
   }
 
+  /**
+   * @function commitsGetCommits
+   * @pronghornType method
+   * @name commitsGetCommits
+   * @summary Retrieve git commits for a project.
+   *
+   * @param {string} organization - The name of the Azure DevOps organization.
+   * @param {string} repositoryId - The id or friendly name of the repository. To use the friendly name, projectId must also be specified.
+   * @param {string} project - Project ID or project name
+   * @param {number} [skip] - Number of entries to skip.
+   * @param {number} [top] - Maximum number of entries to retrieve.
+   * @param {string} searchCriteriaAuthor - Alias or display name of the author
+   * @param {string} searchCriteriaCompareVersionVersion - Version string identifier (name of tag/branch, SHA1 of commit)
+   * @param {string} searchCriteriaCompareVersionVersionOptions - Version options - Specify additional modifiers to version (e.g Previous)
+   * @param {string} searchCriteriaCompareVersionVersionType - Version type (branch, tag, or commit). Determines how Id is interpreted
+   * @param {boolean} searchCriteriaExcludeDeletes - This determines whether to exclude delete entries of the specified path.
+   * @param {string} searchCriteriaFromCommitId - If provided, a lower bound for filtering commits alphabetically
+   * @param {string} searchCriteriaFromDate - If provided, only include history entries created after this date
+   * @param {string} searchCriteriaHistoryMode - What Git history mode should be used.
+   * @param {array} searchCriteriaIds - If provided, specifies the exact commit ids of the commits to fetch
+   * @param {boolean} searchCriteriaIncludeLinks - Whether to include the _links field on the shallow references
+   * @param {boolean} searchCriteriaIncludePushData - Whether to include the push information
+   * @param {boolean} searchCriteriaIncludeUserImageUrl - Whether to include the image Url for committers and authors
+   * @param {boolean} searchCriteriaIncludeWorkItems - Whether to include linked work items
+   * @param {string} searchCriteriaItemPath - Path of item to search under
+   * @param {string} searchCriteriaItemVersionVersion - Version string identifier (name of tag/branch, SHA1 of commit)
+   * @param {string} searchCriteriaItemVersionVersionOptions - Version options - Specify additional modifiers to version (e.g Previous)
+   * @param {string} searchCriteriaItemVersionVersionType - Version type (branch, tag, or commit). Determines how Id is interpreted
+   * @param {boolean} searchCriteriaShowOldestCommitsFirst - If enabled, this option will ignore the itemVersion and compareVersion parameters
+   * @param {string} searchCriteriaToCommitId - If provided, an upper bound for filtering commits alphabetically
+   * @param {string} searchCriteriaToDate - If provided, only include history entries created before this date (string)
+   * @param {string} searchCriteriaUser - Alias or display name of the committer
+   * @param {string} apiVersion - Version of the API to use.  This should be set to '7.1-preview.1' to use this version of the api.
+   * @param {getCallback} callback - a callback function to return the result
+   * @return {object} results - An object containing the response of the action
+   *
+   * @route {GET} /commitsGetCommits
+   * @roles admin
+   * @task true
+   */
+  /* YOU CAN CHANGE THE PARAMETERS YOU TAKE IN HERE AND IN THE pronghorn.json FILE */
+  commitsGetCommits(organization, repositoryId, project, skip, top, searchCriteriaAuthor, searchCriteriaCompareVersionVersion, searchCriteriaCompareVersionVersionOptions, searchCriteriaCompareVersionVersionType, searchCriteriaExcludeDeletes, searchCriteriaFromCommitId, searchCriteriaFromDate, searchCriteriaHistoryMode, searchCriteriaIds, searchCriteriaIncludeLinks, searchCriteriaIncludePushData, searchCriteriaIncludeUserImageUrl, searchCriteriaIncludeWorkItems, searchCriteriaItemPath, searchCriteriaItemVersionVersion, searchCriteriaItemVersionVersionOptions, searchCriteriaItemVersionVersionType, searchCriteriaShowOldestCommitsFirst, searchCriteriaToCommitId, searchCriteriaToDate, searchCriteriaUser, apiVersion, callback) {
+    const meth = 'adapter-commitsGetCommits';
+    const origin = `${this.id}-${meth}`;
+    log.trace(origin);
+
+    if (this.suspended && this.suspendMode === 'error') {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'AD.600', [], null, null, null);
+      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+      return callback(null, errorObj);
+    }
+
+    /* HERE IS WHERE YOU VALIDATE DATA */
+    if (organization === undefined || organization === null || organization === '') {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['organization'], null, null, null);
+      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+      return callback(null, errorObj);
+    }
+    if (repositoryId === undefined || repositoryId === null || repositoryId === '') {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['repositoryId'], null, null, null);
+      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+      return callback(null, errorObj);
+    }
+    if (apiVersion === undefined || apiVersion === null || apiVersion === '') {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['apiVersion'], null, null, null);
+      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+      return callback(null, errorObj);
+    }
+
+    /* HERE IS WHERE YOU SET THE DATA TO PASS INTO REQUEST */
+    const queryParamsAvailable = { skip, top, searchCriteriaAuthor, searchCriteriaCompareVersionVersion, searchCriteriaCompareVersionVersionOptions, searchCriteriaCompareVersionVersionType, searchCriteriaExcludeDeletes, searchCriteriaFromCommitId, searchCriteriaFromDate, searchCriteriaHistoryMode, searchCriteriaIds, searchCriteriaIncludeLinks, searchCriteriaIncludePushData, searchCriteriaIncludeUserImageUrl, searchCriteriaIncludeWorkItems, searchCriteriaItemPath, searchCriteriaItemVersionVersion, searchCriteriaItemVersionVersionOptions, searchCriteriaItemVersionVersionType, searchCriteriaShowOldestCommitsFirst, searchCriteriaToCommitId, searchCriteriaToDate, searchCriteriaUser, apiVersion };
+    const queryParams = {};
+    const pathVars = [organization, project, repositoryId];
+    const bodyVars = {};
+
+    // loop in template. long callback arg name to avoid identifier conflicts
+    Object.keys(queryParamsAvailable).forEach((thisKeyInQueryParamsAvailable) => {
+      if (queryParamsAvailable[thisKeyInQueryParamsAvailable] !== undefined && queryParamsAvailable[thisKeyInQueryParamsAvailable] !== null
+          && queryParamsAvailable[thisKeyInQueryParamsAvailable] !== '') {
+        queryParams[thisKeyInQueryParamsAvailable] = queryParamsAvailable[thisKeyInQueryParamsAvailable];
+      }
+    });
+
+    // set up the request object - payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, filter, priority, event
+    // see adapter code documentation for more information on the request object's fields
+    const reqObj = {
+      payload: bodyVars,
+      uriPathVars: pathVars,
+      uriQuery: queryParams
+    };
+
+    try {
+      // Make the call -
+      // identifyRequest(entity, action, requestObj, returnDataFlag, callback)
+      return this.requestHandlerInst.identifyRequest('Commits', 'commitsGetCommits', reqObj, true, (irReturnData, irReturnError) => {
+        // if we received an error or their is no response on the results
+        // return an error
+        if (irReturnError) {
+          /* HERE IS WHERE YOU CAN ALTER THE ERROR MESSAGE */
+          return callback(null, irReturnError);
+        }
+        if (!Object.hasOwnProperty.call(irReturnData, 'response')) {
+          const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Invalid Response', ['commitsGetCommits'], null, null, null);
+          log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+          return callback(null, errorObj);
+        }
+
+        /* HERE IS WHERE YOU CAN ALTER THE RETURN DATA */
+        // return the response
+        return callback(irReturnData, null);
+      });
+    } catch (ex) {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Caught Exception', null, null, null, ex);
+      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+      return callback(null, errorObj);
+    }
+  }
+
   /**
    * @function commitsGetCommitsBatch
    * @pronghornType method

package/entities/AnnotatedTags/schema.json

@@ -2,18 +2,29 @@
   "$id": "schema.json",
   "type": "object",
   "schema": "http://json-schema.org/draft-07/schema#",
-  "translate": false,
+  "translate": true,
   "dynamicfields": true,
   "properties": {
     "ph_request_type": {
       "type": "string",
       "description": "type of request (internal to adapter)",
-      "default": "",
+      "default": "annotatedTagsCreate",
       "enum": [
         "annotatedTagsCreate",
         "annotatedTagsGet"
       ],
       "external_name": "ph_request_type"
+    },
+    "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": {}

package/entities/Blobs/schema.json

@@ -2,18 +2,29 @@
   "$id": "schema.json",
   "type": "object",
   "schema": "http://json-schema.org/draft-07/schema#",
-  "translate": false,
+  "translate": true,
   "dynamicfields": true,
   "properties": {
     "ph_request_type": {
       "type": "string",
       "description": "type of request (internal to adapter)",
-      "default": "",
+      "default": "blobsGetBlobsZip",
       "enum": [
         "blobsGetBlobsZip",
         "blobsGetBlob"
       ],
       "external_name": "ph_request_type"
+    },
+    "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": {}

package/entities/CherryPicks/schema.json

@@ -2,19 +2,30 @@
   "$id": "schema.json",
   "type": "object",
   "schema": "http://json-schema.org/draft-07/schema#",
-  "translate": false,
+  "translate": true,
   "dynamicfields": true,
   "properties": {
     "ph_request_type": {
       "type": "string",
       "description": "type of request (internal to adapter)",
-      "default": "",
+      "default": "cherryPicksCreate",
       "enum": [
         "cherryPicksCreate",
         "cherryPicksGetCherryPickForRefName",
         "cherryPicksGetCherryPick"
       ],
       "external_name": "ph_request_type"
+    },
+    "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": {}

package/entities/Commits/action.json

@@ -63,6 +63,27 @@
         }
       ]
     },
+    {
+      "name": "commitsGetCommits",
+      "protocol": "REST",
+      "method": "GET",
+      "entitypath": "{base_path}/{version}/{pathv1}/{pathv2}/_apis/git/repositories/{pathv3}/commits?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "sendGetBody": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    },
     {
       "name": "commitsGetCommitsBatch",
       "protocol": "REST",

package/entities/Commits/schema.json

@@ -2,20 +2,285 @@
   "$id": "schema.json",
   "type": "object",
   "schema": "http://json-schema.org/draft-07/schema#",
-  "translate": false,
+  "translate": true,
   "dynamicfields": true,
   "properties": {
     "ph_request_type": {
       "type": "string",
       "description": "type of request (internal to adapter)",
-      "default": "",
+      "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": {}

package/entities/Diffs/schema.json

@@ -2,17 +2,28 @@
   "$id": "schema.json",
   "type": "object",
   "schema": "http://json-schema.org/draft-07/schema#",
-  "translate": false,
+  "translate": true,
   "dynamicfields": true,
   "properties": {
     "ph_request_type": {
       "type": "string",
       "description": "type of request (internal to adapter)",
-      "default": "",
+      "default": "diffsGet",
       "enum": [
         "diffsGet"
       ],
       "external_name": "ph_request_type"
+    },
+    "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": {}

package/entities/Forks/schema.json

@@ -2,13 +2,13 @@
   "$id": "schema.json",
   "type": "object",
   "schema": "http://json-schema.org/draft-07/schema#",
-  "translate": false,
+  "translate": true,
   "dynamicfields": true,
   "properties": {
     "ph_request_type": {
       "type": "string",
       "description": "type of request (internal to adapter)",
-      "default": "",
+      "default": "forksList",
       "enum": [
         "forksList",
         "forksCreateForkSyncRequest",
@@ -16,6 +16,17 @@
         "forksGetForkSyncRequest"
       ],
       "external_name": "ph_request_type"
+    },
+    "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": {}

package/entities/ImportRequests/schema.json

@@ -2,13 +2,13 @@
   "$id": "schema.json",
   "type": "object",
   "schema": "http://json-schema.org/draft-07/schema#",
-  "translate": false,
+  "translate": true,
   "dynamicfields": true,
   "properties": {
     "ph_request_type": {
       "type": "string",
       "description": "type of request (internal to adapter)",
-      "default": "",
+      "default": "importRequestsCreate",
       "enum": [
         "importRequestsCreate",
         "importRequestsQuery",
@@ -16,6 +16,17 @@
         "importRequestsUpdate"
       ],
       "external_name": "ph_request_type"
+    },
+    "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": {}

package/entities/Items/mockdatafiles/itemsGetItemsBatch-default.json

@@ -1,5 +1,7 @@
-[
-  [],
-  [],
-  []
-]
+{
+  "value": [
+    [],
+    [],
+    []
+]
+}