@pulumi/github 5.0.0 → 5.2.0-alpha.1673638210

package/getRepositoryFile.d.ts

@@ -1,11 +1,38 @@
 import * as pulumi from "@pulumi/pulumi";
+/**
+ * This data source allows you to read files within a
+ * GitHub repository.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as github from "@pulumi/github";
+ *
+ * const foo = github.getRepositoryFile({
+ *     repository: github_repository.foo.name,
+ *     branch: "main",
+ *     file: ".gitignore",
+ * });
+ * ```
+ */
 export declare function getRepositoryFile(args: GetRepositoryFileArgs, opts?: pulumi.InvokeOptions): Promise<GetRepositoryFileResult>;
 /**
  * A collection of arguments for invoking getRepositoryFile.
  */
 export interface GetRepositoryFileArgs {
+    /**
+     * Git branch (defaults to `main`).
+     * The branch must already exist, it will not be created if it does not already exist.
+     */
     branch?: string;
+    /**
+     * The path of the file to manage.
+     */
     file: string;
+    /**
+     * The repository to create the file in.
+     */
     repository: string;
 }
 /**
@@ -13,10 +40,25 @@ export interface GetRepositoryFileArgs {
  */
 export interface GetRepositoryFileResult {
     readonly branch?: string;
+    /**
+     * Committer author name.
+     */
     readonly commitAuthor: string;
+    /**
+     * Committer email address.
+     */
     readonly commitEmail: string;
+    /**
+     * Commit message when file was last updated.
+     */
     readonly commitMessage: string;
+    /**
+     * The SHA of the commit that modified the file.
+     */
     readonly commitSha: string;
+    /**
+     * The file content.
+     */
     readonly content: string;
     readonly file: string;
     /**
@@ -24,14 +66,44 @@ export interface GetRepositoryFileResult {
      */
     readonly id: string;
     readonly repository: string;
+    /**
+     * The SHA blob of the file.
+     */
     readonly sha: string;
 }
+/**
+ * This data source allows you to read files within a
+ * GitHub repository.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as github from "@pulumi/github";
+ *
+ * const foo = github.getRepositoryFile({
+ *     repository: github_repository.foo.name,
+ *     branch: "main",
+ *     file: ".gitignore",
+ * });
+ * ```
+ */
 export declare function getRepositoryFileOutput(args: GetRepositoryFileOutputArgs, opts?: pulumi.InvokeOptions): pulumi.Output<GetRepositoryFileResult>;
 /**
  * A collection of arguments for invoking getRepositoryFile.
  */
 export interface GetRepositoryFileOutputArgs {
+    /**
+     * Git branch (defaults to `main`).
+     * The branch must already exist, it will not be created if it does not already exist.
+     */
     branch?: pulumi.Input<string>;
+    /**
+     * The path of the file to manage.
+     */
     file: pulumi.Input<string>;
+    /**
+     * The repository to create the file in.
+     */
     repository: pulumi.Input<string>;
 }

package/getRepositoryFile.js

@@ -5,11 +5,25 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getRepositoryFileOutput = exports.getRepositoryFile = void 0;
 const pulumi = require("@pulumi/pulumi");
 const utilities = require("./utilities");
+/**
+ * This data source allows you to read files within a
+ * GitHub repository.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as github from "@pulumi/github";
+ *
+ * const foo = github.getRepositoryFile({
+ *     repository: github_repository.foo.name,
+ *     branch: "main",
+ *     file: ".gitignore",
+ * });
+ * ```
+ */
 function getRepositoryFile(args, opts) {
-    if (!opts) {
-        opts = {};
-    }
-    opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
+    opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
     return pulumi.runtime.invoke("github:index/getRepositoryFile:getRepositoryFile", {
         "branch": args.branch,
         "file": args.file,
@@ -17,8 +31,25 @@ function getRepositoryFile(args, opts) {
     }, opts);
 }
 exports.getRepositoryFile = getRepositoryFile;
+/**
+ * This data source allows you to read files within a
+ * GitHub repository.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as github from "@pulumi/github";
+ *
+ * const foo = github.getRepositoryFile({
+ *     repository: github_repository.foo.name,
+ *     branch: "main",
+ *     file: ".gitignore",
+ * });
+ * ```
+ */
 function getRepositoryFileOutput(args, opts) {
-    return pulumi.output(args).apply(a => getRepositoryFile(a, opts));
+    return pulumi.output(args).apply((a) => getRepositoryFile(a, opts));
 }
 exports.getRepositoryFileOutput = getRepositoryFileOutput;
 //# sourceMappingURL=getRepositoryFile.js.map

package/getRepositoryFile.js.map

@@ -1 +1 @@
-{"version":3,"file":"getRepositoryFile.js","sourceRoot":"","sources":["../getRepositoryFile.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AACzC,yCAAyC;AAEzC,SAAgB,iBAAiB,CAAC,IAA2B,EAAE,IAA2B;IACtF,IAAI,CAAC,IAAI,EAAE;QACP,IAAI,GAAG,EAAE,CAAA;KACZ;IAED,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,CAAC,CAAC;IACnE,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,kDAAkD,EAAE;QAC7E,QAAQ,EAAE,IAAI,CAAC,MAAM;QACrB,MAAM,EAAE,IAAI,CAAC,IAAI;QACjB,YAAY,EAAE,IAAI,CAAC,UAAU;KAChC,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AAXD,8CAWC;AA8BD,SAAgB,uBAAuB,CAAC,IAAiC,EAAE,IAA2B;IAClG,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,iBAAiB,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAA;AACrE,CAAC;AAFD,0DAEC"}
+{"version":3,"file":"getRepositoryFile.js","sourceRoot":"","sources":["../getRepositoryFile.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AACzC,yCAAyC;AAEzC;;;;;;;;;;;;;;;;GAgBG;AACH,SAAgB,iBAAiB,CAAC,IAA2B,EAAE,IAA2B;IAEtF,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,kDAAkD,EAAE;QAC7E,QAAQ,EAAE,IAAI,CAAC,MAAM;QACrB,MAAM,EAAE,IAAI,CAAC,IAAI;QACjB,YAAY,EAAE,IAAI,CAAC,UAAU;KAChC,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AARD,8CAQC;AAyDD;;;;;;;;;;;;;;;;GAgBG;AACH,SAAgB,uBAAuB,CAAC,IAAiC,EAAE,IAA2B;IAClG,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,CAAM,EAAE,EAAE,CAAC,iBAAiB,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAA;AAC5E,CAAC;AAFD,0DAEC"}

package/getRepositoryMilestone.d.ts

@@ -1,18 +1,49 @@
 import * as pulumi from "@pulumi/pulumi";
+/**
+ * Use this data source to retrieve information about a specific GitHub milestone in a repository.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as github from "@pulumi/github";
+ *
+ * const example = github.getRepositoryMilestone({
+ *     number: 1,
+ *     owner: "example-owner",
+ *     repository: "example-repository",
+ * });
+ * ```
+ */
 export declare function getRepositoryMilestone(args: GetRepositoryMilestoneArgs, opts?: pulumi.InvokeOptions): Promise<GetRepositoryMilestoneResult>;
 /**
  * A collection of arguments for invoking getRepositoryMilestone.
  */
 export interface GetRepositoryMilestoneArgs {
+    /**
+     * The number of the milestone.
+     */
     number: number;
+    /**
+     * Owner of the repository.
+     */
     owner: string;
+    /**
+     * Name of the repository to retrieve the milestone from.
+     */
     repository: string;
 }
 /**
  * A collection of values returned by getRepositoryMilestone.
  */
 export interface GetRepositoryMilestoneResult {
+    /**
+     * Description of the milestone.
+     */
     readonly description: string;
+    /**
+     * The milestone due date (in ISO-8601 `yyyy-mm-dd` format).
+     */
     readonly dueDate: string;
     /**
      * The provider-assigned unique ID for this managed resource.
@@ -21,15 +52,46 @@ export interface GetRepositoryMilestoneResult {
     readonly number: number;
     readonly owner: string;
     readonly repository: string;
+    /**
+     * State of the milestone.
+     */
     readonly state: string;
+    /**
+     * Title of the milestone.
+     */
     readonly title: string;
 }
+/**
+ * Use this data source to retrieve information about a specific GitHub milestone in a repository.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as github from "@pulumi/github";
+ *
+ * const example = github.getRepositoryMilestone({
+ *     number: 1,
+ *     owner: "example-owner",
+ *     repository: "example-repository",
+ * });
+ * ```
+ */
 export declare function getRepositoryMilestoneOutput(args: GetRepositoryMilestoneOutputArgs, opts?: pulumi.InvokeOptions): pulumi.Output<GetRepositoryMilestoneResult>;
 /**
  * A collection of arguments for invoking getRepositoryMilestone.
  */
 export interface GetRepositoryMilestoneOutputArgs {
+    /**
+     * The number of the milestone.
+     */
     number: pulumi.Input<number>;
+    /**
+     * Owner of the repository.
+     */
     owner: pulumi.Input<string>;
+    /**
+     * Name of the repository to retrieve the milestone from.
+     */
     repository: pulumi.Input<string>;
 }

package/getRepositoryMilestone.js

@@ -5,11 +5,24 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getRepositoryMilestoneOutput = exports.getRepositoryMilestone = void 0;
 const pulumi = require("@pulumi/pulumi");
 const utilities = require("./utilities");
+/**
+ * Use this data source to retrieve information about a specific GitHub milestone in a repository.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as github from "@pulumi/github";
+ *
+ * const example = github.getRepositoryMilestone({
+ *     number: 1,
+ *     owner: "example-owner",
+ *     repository: "example-repository",
+ * });
+ * ```
+ */
 function getRepositoryMilestone(args, opts) {
-    if (!opts) {
-        opts = {};
-    }
-    opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
+    opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
     return pulumi.runtime.invoke("github:index/getRepositoryMilestone:getRepositoryMilestone", {
         "number": args.number,
         "owner": args.owner,
@@ -17,8 +30,24 @@ function getRepositoryMilestone(args, opts) {
     }, opts);
 }
 exports.getRepositoryMilestone = getRepositoryMilestone;
+/**
+ * Use this data source to retrieve information about a specific GitHub milestone in a repository.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as github from "@pulumi/github";
+ *
+ * const example = github.getRepositoryMilestone({
+ *     number: 1,
+ *     owner: "example-owner",
+ *     repository: "example-repository",
+ * });
+ * ```
+ */
 function getRepositoryMilestoneOutput(args, opts) {
-    return pulumi.output(args).apply(a => getRepositoryMilestone(a, opts));
+    return pulumi.output(args).apply((a) => getRepositoryMilestone(a, opts));
 }
 exports.getRepositoryMilestoneOutput = getRepositoryMilestoneOutput;
 //# sourceMappingURL=getRepositoryMilestone.js.map

package/getRepositoryMilestone.js.map

@@ -1 +1 @@
-{"version":3,"file":"getRepositoryMilestone.js","sourceRoot":"","sources":["../getRepositoryMilestone.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AACzC,yCAAyC;AAEzC,SAAgB,sBAAsB,CAAC,IAAgC,EAAE,IAA2B;IAChG,IAAI,CAAC,IAAI,EAAE;QACP,IAAI,GAAG,EAAE,CAAA;KACZ;IAED,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,CAAC,CAAC;IACnE,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,4DAA4D,EAAE;QACvF,QAAQ,EAAE,IAAI,CAAC,MAAM;QACrB,OAAO,EAAE,IAAI,CAAC,KAAK;QACnB,YAAY,EAAE,IAAI,CAAC,UAAU;KAChC,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AAXD,wDAWC;AA4BD,SAAgB,4BAA4B,CAAC,IAAsC,EAAE,IAA2B;IAC5G,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,sBAAsB,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAA;AAC1E,CAAC;AAFD,oEAEC"}
+{"version":3,"file":"getRepositoryMilestone.js","sourceRoot":"","sources":["../getRepositoryMilestone.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AACzC,yCAAyC;AAEzC;;;;;;;;;;;;;;;GAeG;AACH,SAAgB,sBAAsB,CAAC,IAAgC,EAAE,IAA2B;IAEhG,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,4DAA4D,EAAE;QACvF,QAAQ,EAAE,IAAI,CAAC,MAAM;QACrB,OAAO,EAAE,IAAI,CAAC,KAAK;QACnB,YAAY,EAAE,IAAI,CAAC,UAAU;KAChC,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AARD,wDAQC;AAgDD;;;;;;;;;;;;;;;GAeG;AACH,SAAgB,4BAA4B,CAAC,IAAsC,EAAE,IAA2B;IAC5G,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,CAAM,EAAE,EAAE,CAAC,sBAAsB,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAA;AACjF,CAAC;AAFD,oEAEC"}

package/getRepositoryPullRequest.d.ts

@@ -1,46 +1,136 @@
 import * as pulumi from "@pulumi/pulumi";
+/**
+ * Use this data source to retrieve information about a specific GitHub Pull Request in a repository.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as github from "@pulumi/github";
+ *
+ * const example = github.getRepositoryPullRequest({
+ *     baseRepository: "example_repository",
+ *     number: 1,
+ * });
+ * ```
+ */
 export declare function getRepositoryPullRequest(args: GetRepositoryPullRequestArgs, opts?: pulumi.InvokeOptions): Promise<GetRepositoryPullRequestResult>;
 /**
  * A collection of arguments for invoking getRepositoryPullRequest.
  */
 export interface GetRepositoryPullRequestArgs {
+    /**
+     * Name of the base repository to retrieve the Pull Request from.
+     */
     baseRepository: string;
+    /**
+     * The number of the Pull Request within the repository.
+     */
     number: number;
+    /**
+     * Owner of the repository. If not provided, the provider's default owner is used.
+     */
     owner?: string;
 }
 /**
  * A collection of values returned by getRepositoryPullRequest.
  */
 export interface GetRepositoryPullRequestResult {
+    /**
+     * Name of the ref (branch) of the Pull Request base.
+     */
     readonly baseRef: string;
     readonly baseRepository: string;
+    /**
+     * Head commit SHA of the Pull Request base.
+     */
     readonly baseSha: string;
+    /**
+     * Body of the Pull Request.
+     */
     readonly body: string;
+    /**
+     * Indicates Whether this Pull Request is a draft.
+     */
     readonly draft: boolean;
+    /**
+     * Owner of the Pull Request head repository.
+     */
     readonly headOwner: string;
     readonly headRef: string;
+    /**
+     * Name of the Pull Request head repository.
+     */
     readonly headRepository: string;
+    /**
+     * Head commit SHA of the Pull Request head.
+     */
     readonly headSha: string;
     /**
      * The provider-assigned unique ID for this managed resource.
      */
     readonly id: string;
+    /**
+     * List of label names set on the Pull Request.
+     */
     readonly labels: string[];
+    /**
+     * Indicates whether the base repository maintainers can modify the Pull Request.
+     */
     readonly maintainerCanModify: boolean;
     readonly number: number;
+    /**
+     * Unix timestamp indicating the Pull Request creation time.
+     */
     readonly openedAt: number;
+    /**
+     * GitHub login of the user who opened the Pull Request.
+     */
     readonly openedBy: string;
     readonly owner?: string;
+    /**
+     * the current Pull Request state - can be "open", "closed" or "merged".
+     */
     readonly state: string;
+    /**
+     * The title of the Pull Request.
+     */
     readonly title: string;
+    /**
+     * The timestamp of the last Pull Request update.
+     */
     readonly updatedAt: number;
 }
+/**
+ * Use this data source to retrieve information about a specific GitHub Pull Request in a repository.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as github from "@pulumi/github";
+ *
+ * const example = github.getRepositoryPullRequest({
+ *     baseRepository: "example_repository",
+ *     number: 1,
+ * });
+ * ```
+ */
 export declare function getRepositoryPullRequestOutput(args: GetRepositoryPullRequestOutputArgs, opts?: pulumi.InvokeOptions): pulumi.Output<GetRepositoryPullRequestResult>;
 /**
  * A collection of arguments for invoking getRepositoryPullRequest.
  */
 export interface GetRepositoryPullRequestOutputArgs {
+    /**
+     * Name of the base repository to retrieve the Pull Request from.
+     */
     baseRepository: pulumi.Input<string>;
+    /**
+     * The number of the Pull Request within the repository.
+     */
     number: pulumi.Input<number>;
+    /**
+     * Owner of the repository. If not provided, the provider's default owner is used.
+     */
     owner?: pulumi.Input<string>;
 }

package/getRepositoryPullRequest.js

@@ -5,11 +5,23 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getRepositoryPullRequestOutput = exports.getRepositoryPullRequest = void 0;
 const pulumi = require("@pulumi/pulumi");
 const utilities = require("./utilities");
+/**
+ * Use this data source to retrieve information about a specific GitHub Pull Request in a repository.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as github from "@pulumi/github";
+ *
+ * const example = github.getRepositoryPullRequest({
+ *     baseRepository: "example_repository",
+ *     number: 1,
+ * });
+ * ```
+ */
 function getRepositoryPullRequest(args, opts) {
-    if (!opts) {
-        opts = {};
-    }
-    opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
+    opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
     return pulumi.runtime.invoke("github:index/getRepositoryPullRequest:getRepositoryPullRequest", {
         "baseRepository": args.baseRepository,
         "number": args.number,
@@ -17,8 +29,23 @@ function getRepositoryPullRequest(args, opts) {
     }, opts);
 }
 exports.getRepositoryPullRequest = getRepositoryPullRequest;
+/**
+ * Use this data source to retrieve information about a specific GitHub Pull Request in a repository.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as github from "@pulumi/github";
+ *
+ * const example = github.getRepositoryPullRequest({
+ *     baseRepository: "example_repository",
+ *     number: 1,
+ * });
+ * ```
+ */
 function getRepositoryPullRequestOutput(args, opts) {
-    return pulumi.output(args).apply(a => getRepositoryPullRequest(a, opts));
+    return pulumi.output(args).apply((a) => getRepositoryPullRequest(a, opts));
 }
 exports.getRepositoryPullRequestOutput = getRepositoryPullRequestOutput;
 //# sourceMappingURL=getRepositoryPullRequest.js.map

package/getRepositoryPullRequest.js.map

@@ -1 +1 @@
-{"version":3,"file":"getRepositoryPullRequest.js","sourceRoot":"","sources":["../getRepositoryPullRequest.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AACzC,yCAAyC;AAEzC,SAAgB,wBAAwB,CAAC,IAAkC,EAAE,IAA2B;IACpG,IAAI,CAAC,IAAI,EAAE;QACP,IAAI,GAAG,EAAE,CAAA;KACZ;IAED,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,CAAC,CAAC;IACnE,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,gEAAgE,EAAE;QAC3F,gBAAgB,EAAE,IAAI,CAAC,cAAc;QACrC,QAAQ,EAAE,IAAI,CAAC,MAAM;QACrB,OAAO,EAAE,IAAI,CAAC,KAAK;KACtB,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AAXD,4DAWC;AAuCD,SAAgB,8BAA8B,CAAC,IAAwC,EAAE,IAA2B;IAChH,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,wBAAwB,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAA;AAC5E,CAAC;AAFD,wEAEC"}
+{"version":3,"file":"getRepositoryPullRequest.js","sourceRoot":"","sources":["../getRepositoryPullRequest.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AACzC,yCAAyC;AAEzC;;;;;;;;;;;;;;GAcG;AACH,SAAgB,wBAAwB,CAAC,IAAkC,EAAE,IAA2B;IAEpG,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,gEAAgE,EAAE;QAC3F,gBAAgB,EAAE,IAAI,CAAC,cAAc;QACrC,QAAQ,EAAE,IAAI,CAAC,MAAM;QACrB,OAAO,EAAE,IAAI,CAAC,KAAK;KACtB,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AARD,4DAQC;AAyFD;;;;;;;;;;;;;;GAcG;AACH,SAAgB,8BAA8B,CAAC,IAAwC,EAAE,IAA2B;IAChH,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,CAAM,EAAE,EAAE,CAAC,wBAAwB,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAA;AACnF,CAAC;AAFD,wEAEC"}

package/getRepositoryPullRequests.d.ts

@@ -1,45 +1,135 @@
 import * as pulumi from "@pulumi/pulumi";
-import { output as outputs } from "./types";
+import * as outputs from "./types/output";
+/**
+ * Use this data source to retrieve information about multiple GitHub Pull Requests in a repository.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as github from "@pulumi/github";
+ *
+ * const example = github.getRepositoryPullRequests({
+ *     baseRef: "main",
+ *     baseRepository: "example-repository",
+ *     sortBy: "updated",
+ *     sortDirection: "desc",
+ *     state: "open",
+ * });
+ * ```
+ */
 export declare function getRepositoryPullRequests(args: GetRepositoryPullRequestsArgs, opts?: pulumi.InvokeOptions): Promise<GetRepositoryPullRequestsResult>;
 /**
  * A collection of arguments for invoking getRepositoryPullRequests.
  */
 export interface GetRepositoryPullRequestsArgs {
+    /**
+     * If set, filters Pull Requests by base branch name.
+     */
     baseRef?: string;
+    /**
+     * Name of the base repository to retrieve the Pull Requests from.
+     */
     baseRepository: string;
+    /**
+     * If set, filters Pull Requests by head user or head organization and branch name in the format of "user:ref-name" or "organization:ref-name". For example: "github:new-script-format" or "octocat:test-branch".
+     */
     headRef?: string;
+    /**
+     * Owner of the repository. If not provided, the provider's default owner is used.
+     */
     owner?: string;
+    /**
+     * If set, indicates what to sort results by. Can be either "created", "updated", "popularity" (comment count) or "long-running" (age, filtering by pulls updated in the last month). Default: "created".
+     */
     sortBy?: string;
+    /**
+     * If set, controls the direction of the sort. Can be either "asc" or "desc". Default: "asc".
+     */
     sortDirection?: string;
+    /**
+     * If set, filters Pull Requests by state. Can be "open", "closed", or "all". Default: "open".
+     */
     state?: string;
 }
 /**
  * A collection of values returned by getRepositoryPullRequests.
  */
 export interface GetRepositoryPullRequestsResult {
+    /**
+     * Name of the ref (branch) of the Pull Request base.
+     */
     readonly baseRef?: string;
     readonly baseRepository: string;
+    /**
+     * Value of the Pull Request `HEAD` reference.
+     */
     readonly headRef?: string;
     /**
      * The provider-assigned unique ID for this managed resource.
      */
     readonly id: string;
     readonly owner?: string;
+    /**
+     * Collection of Pull Requests matching the filters. Each of the results conforms to the following scheme:
+     */
     readonly results: outputs.GetRepositoryPullRequestsResult[];
     readonly sortBy?: string;
     readonly sortDirection?: string;
+    /**
+     * the current Pull Request state - can be "open", "closed" or "merged".
+     */
     readonly state?: string;
 }
+/**
+ * Use this data source to retrieve information about multiple GitHub Pull Requests in a repository.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as github from "@pulumi/github";
+ *
+ * const example = github.getRepositoryPullRequests({
+ *     baseRef: "main",
+ *     baseRepository: "example-repository",
+ *     sortBy: "updated",
+ *     sortDirection: "desc",
+ *     state: "open",
+ * });
+ * ```
+ */
 export declare function getRepositoryPullRequestsOutput(args: GetRepositoryPullRequestsOutputArgs, opts?: pulumi.InvokeOptions): pulumi.Output<GetRepositoryPullRequestsResult>;
 /**
  * A collection of arguments for invoking getRepositoryPullRequests.
  */
 export interface GetRepositoryPullRequestsOutputArgs {
+    /**
+     * If set, filters Pull Requests by base branch name.
+     */
     baseRef?: pulumi.Input<string>;
+    /**
+     * Name of the base repository to retrieve the Pull Requests from.
+     */
     baseRepository: pulumi.Input<string>;
+    /**
+     * If set, filters Pull Requests by head user or head organization and branch name in the format of "user:ref-name" or "organization:ref-name". For example: "github:new-script-format" or "octocat:test-branch".
+     */
     headRef?: pulumi.Input<string>;
+    /**
+     * Owner of the repository. If not provided, the provider's default owner is used.
+     */
     owner?: pulumi.Input<string>;
+    /**
+     * If set, indicates what to sort results by. Can be either "created", "updated", "popularity" (comment count) or "long-running" (age, filtering by pulls updated in the last month). Default: "created".
+     */
     sortBy?: pulumi.Input<string>;
+    /**
+     * If set, controls the direction of the sort. Can be either "asc" or "desc". Default: "asc".
+     */
     sortDirection?: pulumi.Input<string>;
+    /**
+     * If set, filters Pull Requests by state. Can be "open", "closed", or "all". Default: "open".
+     */
     state?: pulumi.Input<string>;
 }