Source: api/projectValidate.js

  1. "use strict";
  3. module.exports = ProjectValidateClient;
  5. /**
  6.  * Used to access Jira REST endpoints in '/rest/api/2/projectvalidate'
  7.  *
  8.  * @param {JiraClient} jiraClient
  9.  * @constructor ProjectValidateClient
  10.  */
  11. function ProjectValidateClient(jiraClient) {
  12.     this.jiraClient = jiraClient;
  14.     /**
  15.      * Validates a project key.  This endpoint is a little wonky, as it returns a list of errors as a valid response;
  16.      * even if the key is invalid, it still returns a 200 response.
  17.      * See {@link https://docs.atlassian.com/jira/REST/latest/#d2e297}
  18.      *
  19.      * @method validateProjectKey
  20.      * @memberOf ProjectValidateClient#
  21.      * @param opts The request options sent to the Jira API.
  22.      * @param opts.projectKey The key of the project.
  23.      * @param [callback] Called when the key has been validated.
  24.      * @return {Promise} Resolved when the key has been validated.
  25.      */
  26.     this.validateProjectKey = function (opts, callback) {
  27.         var options = {
  28.             uri: this.jiraClient.buildURL('/projectvalidate/key'),
  29.             method: 'GET',
  30.             json: true,
  31.             followAllRedirects: true,
  32.             qs: {
  33.                 key: opts.projectKey
  34.             }
  35.         };
  37.         return this.jiraClient.makeRequest(options, callback);
  38.     }
  39. }