Interface SchemaRestPullRequestActivityCommented

Type Declaration

• Optional Readonlyanchor?: {
      diffType?: "COMMIT" | "EFFECTIVE" | "RANGE";
      fileType?: "FROM" | "TO";
      fromHash?: string;
      line?: number;
      lineType?: "ADDED" | "CONTEXT" | "REMOVED";
      multilineMarker?: {
          startLine?: number;
          startLineType: "ADDED" | "CONTEXT" | "REMOVED";
      };
      path?: {
          components?: readonly string[];
          extension?: string;
          name?: string;
          parent?: string;
      };
      pullRequest?: {
          closed?: boolean;
          closedDate?: number;
          createdDate?: number;
          description?: string;
          descriptionAsHtml?: string;
          draft?: boolean;
          fromRef?: {
              displayId?: string;
              id?: string;
              latestCommit?: string;
              repository?: {
                  archived?: (...)
                  | (...)
                  | (...);
                  defaultBranch?: (...) | (...);
                  description?: (...) | (...);
                  forkable?: (...) | (...) | (...);
                  hierarchyId?: (...) | (...);
                  id?: (...) | (...);
                  links?: (...) | (...);
                  name?: (...) | (...);
                  origin?: (...) | (...);
                  partition?: (...) | (...);
                  project?: (...) | (...);
                  public?: (...) | (...) | (...);
                  relatedLinks?: (...) | (...);
                  scmId?: (...) | (...);
                  scope?: (...) | (...);
                  slug?: (...) | (...);
                  state?: (...) | (...) | (...) | (...) | (...);
                  statusMessage?: (...) | (...);
              };
              type?: "BRANCH"
              | "TAG";
          };
          htmlDescription?: string;
          id?: number;
          links?: Record<string, unknown>;
          locked?: boolean;
          open?: boolean;
          participants?: readonly {
              approved?: boolean;
              lastReviewedCommit?: string;
              role?: "PARTICIPANT" | "REVIEWER" | "AUTHOR";
              status?: "APPROVED" | "NEEDS_WORK" | "UNAPPROVED";
              user?: {
                  active?: ...;
                  avatarUrl?: ...;
                  displayName?: ...;
                  emailAddress?: ...;
                  id?: ...;
                  links?: ...;
                  name?: ...;
                  slug?: ...;
                  type?: ...;
              };
          }[];
          reviewers?: readonly {
              approved?: boolean;
              lastReviewedCommit?: string;
              role?: "PARTICIPANT"
              | "REVIEWER"
              | "AUTHOR";
              status?: "APPROVED" | "NEEDS_WORK" | "UNAPPROVED";
              user?: {
                  active?: ...;
                  avatarUrl?: ...;
                  displayName?: ...;
                  emailAddress?: ...;
                  id?: ...;
                  links?: ...;
                  name?: ...;
                  slug?: ...;
                  type?: ...;
              };
          }[];
          state?: "DECLINED"
          | "MERGED"
          | "OPEN";
          title?: string;
          toRef?: {
              displayId?: string;
              id?: string;
              latestCommit?: string;
              repository?: {
                  archived?: (...) | (...) | (...);
                  defaultBranch?: (...) | (...);
                  description?: (...) | (...);
                  forkable?: (...) | (...) | (...);
                  hierarchyId?: (...) | (...);
                  id?: (...) | (...);
                  links?: (...) | (...);
                  name?: (...) | (...);
                  origin?: (...) | (...);
                  partition?: (...) | (...);
                  project?: (...) | (...);
                  public?: (...) | (...) | (...);
                  relatedLinks?: (...) | (...);
                  scmId?: (...) | (...);
                  scope?: (...) | (...);
                  slug?: (...) | (...);
                  state?: (...) | (...) | (...) | (...) | (...);
                  statusMessage?: (...) | (...);
              };
              type?: "BRANCH"
              | "TAG";
          };
          updatedDate?: number;
          version?: number;
      };
      srcPath?: {
          components?: readonly string[];
          extension?: string;
          name?: string;
          parent?: string;
      };
      toHash?: string;
  }

  • Optional ReadonlydiffType?: "COMMIT" | "EFFECTIVE" | "RANGE"

  • Optional ReadonlyfileType?: "FROM" | "TO"

  • Optional ReadonlyfromHash?: string

    Example

    62a0505e8204115b8b9c8a95bfa264a8c0896a93
    Copy

  • Optional Readonlyline?: number

    Format: int32

    Example

    98
    Copy

  • Optional ReadonlylineType?: "ADDED" | "CONTEXT" | "REMOVED"

  • Optional ReadonlymultilineMarker?: { startLine?: number; startLineType: "ADDED" | "CONTEXT" | "REMOVED" }

    • Optional ReadonlystartLine?: number

      Format: int32

      Description

      The line number where the multiline comment will begin

    • ReadonlystartLineType: "ADDED" | "CONTEXT" | "REMOVED"

      Description

      The segment type of the start line of the multiline comment

  • Optional Readonlypath?: {
        components?: readonly string[];
        extension?: string;
        name?: string;
        parent?: string;
    }

    • Optional Readonlycomponents?: readonly string[]

      Example

      [
            "path",
            "to",
            "file.txt"
          ]
      Copy

    • Optional Readonlyextension?: string

      Example

      txt
      Copy

    • Optional Readonlyname?: string

      Example

      file.txt
      Copy

    • Optional Readonlyparent?: string

      Example

      path/to
      Copy

  • Optional ReadonlypullRequest?: {
        closed?: boolean;
        closedDate?: number;
        createdDate?: number;
        description?: string;
        descriptionAsHtml?: string;
        draft?: boolean;
        fromRef?: {
            displayId?: string;
            id?: string;
            latestCommit?: string;
            repository?: {
                archived?: (...) | (...) | (...);
                defaultBranch?: (...) | (...);
                description?: (...) | (...);
                forkable?: (...) | (...) | (...);
                hierarchyId?: (...) | (...);
                id?: (...) | (...);
                links?: (...) | (...);
                name?: (...) | (...);
                origin?: (...) | (...);
                partition?: (...) | (...);
                project?: (...) | (...);
                public?: (...) | (...) | (...);
                relatedLinks?: (...) | (...);
                scmId?: (...) | (...);
                scope?: (...) | (...);
                slug?: (...) | (...);
                state?: (...) | (...) | (...) | (...) | (...);
                statusMessage?: (...) | (...);
            };
            type?: "BRANCH"
            | "TAG";
        };
        htmlDescription?: string;
        id?: number;
        links?: Record<string, unknown>;
        locked?: boolean;
        open?: boolean;
        participants?: readonly {
            approved?: boolean;
            lastReviewedCommit?: string;
            role?: "PARTICIPANT" | "REVIEWER" | "AUTHOR";
            status?: "APPROVED" | "NEEDS_WORK" | "UNAPPROVED";
            user?: {
                active?: ...;
                avatarUrl?: ...;
                displayName?: ...;
                emailAddress?: ...;
                id?: ...;
                links?: ...;
                name?: ...;
                slug?: ...;
                type?: ...;
            };
        }[];
        reviewers?: readonly {
            approved?: boolean;
            lastReviewedCommit?: string;
            role?: "PARTICIPANT"
            | "REVIEWER"
            | "AUTHOR";
            status?: "APPROVED" | "NEEDS_WORK" | "UNAPPROVED";
            user?: {
                active?: ...;
                avatarUrl?: ...;
                displayName?: ...;
                emailAddress?: ...;
                id?: ...;
                links?: ...;
                name?: ...;
                slug?: ...;
                type?: ...;
            };
        }[];
        state?: "DECLINED"
        | "MERGED"
        | "OPEN";
        title?: string;
        toRef?: {
            displayId?: string;
            id?: string;
            latestCommit?: string;
            repository?: {
                archived?: (...) | (...) | (...);
                defaultBranch?: (...) | (...);
                description?: (...) | (...);
                forkable?: (...) | (...) | (...);
                hierarchyId?: (...) | (...);
                id?: (...) | (...);
                links?: (...) | (...);
                name?: (...) | (...);
                origin?: (...) | (...);
                partition?: (...) | (...);
                project?: (...) | (...);
                public?: (...) | (...) | (...);
                relatedLinks?: (...) | (...);
                scmId?: (...) | (...);
                scope?: (...) | (...);
                slug?: (...) | (...);
                state?: (...) | (...) | (...) | (...) | (...);
                statusMessage?: (...) | (...);
            };
            type?: "BRANCH"
            | "TAG";
        };
        updatedDate?: number;
        version?: number;
    }

    • Optional Readonlyclosed?: boolean

    • Optional ReadonlyclosedDate?: number

      Format: int64

      Example

      19990759200
      Copy

    • Optional ReadonlycreatedDate?: number

      Format: int64

      Example

      13590759200
      Copy

    • Optional Readonlydescription?: string

      Example

      It is a kludge, but put the tuple from the database in the cache.
      Copy

    • Optional ReadonlydescriptionAsHtml?: string

    • Optional Readonlydraft?: boolean

    • Optional ReadonlyfromRef?: {
          displayId?: string;
          id?: string;
          latestCommit?: string;
          repository?: {
              archived?: (...) | (...) | (...);
              defaultBranch?: (...) | (...);
              description?: (...) | (...);
              forkable?: (...) | (...) | (...);
              hierarchyId?: (...) | (...);
              id?: (...) | (...);
              links?: (...) | (...);
              name?: (...) | (...);
              origin?: (...) | (...);
              partition?: (...) | (...);
              project?: (...) | (...);
              public?: (...) | (...) | (...);
              relatedLinks?: (...) | (...);
              scmId?: (...) | (...);
              scope?: (...) | (...);
              slug?: (...) | (...);
              state?: (...) | (...) | (...) | (...) | (...);
              statusMessage?: (...) | (...);
          };
          type?: "BRANCH"
          | "TAG";
      }

      • Optional ReadonlydisplayId?: string

        Example

        feature-ABC-1233
        Copy

      • Optional Readonlyid?: string

        Example

        refs/heads/feature-ABC-123
        Copy

      • Optional ReadonlylatestCommit?: string

        Example

        babecafebabecafebabecafebabecafebabecafe
        Copy

      • Optional Readonlyrepository?: {
            archived?: (...) | (...) | (...);
            defaultBranch?: (...) | (...);
            description?: (...) | (...);
            forkable?: (...) | (...) | (...);
            hierarchyId?: (...) | (...);
            id?: (...) | (...);
            links?: (...) | (...);
            name?: (...) | (...);
            origin?: (...) | (...);
            partition?: (...) | (...);
            project?: (...) | (...);
            public?: (...) | (...) | (...);
            relatedLinks?: (...) | (...);
            scmId?: (...) | (...);
            scope?: (...) | (...);
            slug?: (...) | (...);
            state?: (...) | (...) | (...) | (...) | (...);
            statusMessage?: (...) | (...);
        }

        • Optional Readonlyarchived?: (...) | (...) | (...)

        • Optional ReadonlydefaultBranch?: (...) | (...)

          Example

          main
          Copy

        • Optional Readonlydescription?: (...) | (...)

          Example

          My repo description
          Copy

        • Optional Readonlyforkable?: (...) | (...) | (...)

        • Optional ReadonlyhierarchyId?: (...) | (...)

          Example

          e3c939f9ef4a7fae272e
          Copy

        • Optional Readonlyid?: (...) | (...)

          Format: int32

        • Optional Readonlylinks?: (...) | (...)

        • Optional Readonlyname?: (...) | (...)

          Example

          My repo
          Copy

        • Optional Readonlyorigin?: (...) | (...)

        • Optional Readonlypartition?: (...) | (...)

          Format: int32

        • Optional Readonlyproject?: (...) | (...)

        • Optional Readonlypublic?: (...) | (...) | (...)

        • Optional ReadonlyrelatedLinks?: (...) | (...)

        • Optional ReadonlyscmId?: (...) | (...)

          Example

          git
          Copy

        • Optional Readonlyscope?: (...) | (...)

          Example

          REPOSITORY
          Copy

        • Optional Readonlyslug?: (...) | (...)

          Example

          my-repo
          Copy

        • Optional Readonlystate?: (...) | (...) | (...) | (...) | (...)

        • Optional ReadonlystatusMessage?: (...) | (...)

          Example

          Available
          Copy

      • Optional Readonlytype?: "BRANCH" | "TAG"

    • Optional ReadonlyhtmlDescription?: string

    • Optional Readonlyid?: number

      Format: int64

      Example

      1
      Copy

    • Optional Readonlylinks?: Record<string, unknown>

    • Optional Readonlylocked?: boolean

    • Optional Readonlyopen?: boolean

    • Optional Readonlyparticipants?: readonly {
          approved?: boolean;
          lastReviewedCommit?: string;
          role?: "PARTICIPANT" | "REVIEWER" | "AUTHOR";
          status?: "APPROVED" | "NEEDS_WORK" | "UNAPPROVED";
          user?: {
              active?: ...;
              avatarUrl?: ...;
              displayName?: ...;
              emailAddress?: ...;
              id?: ...;
              links?: ...;
              name?: ...;
              slug?: ...;
              type?: ...;
          };
      }[]

    • Optional Readonlyreviewers?: readonly {
          approved?: boolean;
          lastReviewedCommit?: string;
          role?: "PARTICIPANT" | "REVIEWER" | "AUTHOR";
          status?: "APPROVED" | "NEEDS_WORK" | "UNAPPROVED";
          user?: {
              active?: ...;
              avatarUrl?: ...;
              displayName?: ...;
              emailAddress?: ...;
              id?: ...;
              links?: ...;
              name?: ...;
              slug?: ...;
              type?: ...;
          };
      }[]

    • Optional Readonlystate?: "DECLINED" | "MERGED" | "OPEN"

    • Optional Readonlytitle?: string

      Example

      Talking Nerdy
      Copy

    • Optional ReadonlytoRef?: {
          displayId?: string;
          id?: string;
          latestCommit?: string;
          repository?: {
              archived?: (...) | (...) | (...);
              defaultBranch?: (...) | (...);
              description?: (...) | (...);
              forkable?: (...) | (...) | (...);
              hierarchyId?: (...) | (...);
              id?: (...) | (...);
              links?: (...) | (...);
              name?: (...) | (...);
              origin?: (...) | (...);
              partition?: (...) | (...);
              project?: (...) | (...);
              public?: (...) | (...) | (...);
              relatedLinks?: (...) | (...);
              scmId?: (...) | (...);
              scope?: (...) | (...);
              slug?: (...) | (...);
              state?: (...) | (...) | (...) | (...) | (...);
              statusMessage?: (...) | (...);
          };
          type?: "BRANCH"
          | "TAG";
      }

      • Optional ReadonlydisplayId?: string

        Example

        feature-ABC-1233
        Copy

      • Optional Readonlyid?: string

        Example

        refs/heads/feature-ABC-123
        Copy

      • Optional ReadonlylatestCommit?: string

        Example

        babecafebabecafebabecafebabecafebabecafe
        Copy

      • Optional Readonlyrepository?: {
            archived?: (...) | (...) | (...);
            defaultBranch?: (...) | (...);
            description?: (...) | (...);
            forkable?: (...) | (...) | (...);
            hierarchyId?: (...) | (...);
            id?: (...) | (...);
            links?: (...) | (...);
            name?: (...) | (...);
            origin?: (...) | (...);
            partition?: (...) | (...);
            project?: (...) | (...);
            public?: (...) | (...) | (...);
            relatedLinks?: (...) | (...);
            scmId?: (...) | (...);
            scope?: (...) | (...);
            slug?: (...) | (...);
            state?: (...) | (...) | (...) | (...) | (...);
            statusMessage?: (...) | (...);
        }

        • Optional Readonlyarchived?: (...) | (...) | (...)

        • Optional ReadonlydefaultBranch?: (...) | (...)

          Example

          main
          Copy

        • Optional Readonlydescription?: (...) | (...)

          Example

          My repo description
          Copy

        • Optional Readonlyforkable?: (...) | (...) | (...)

        • Optional ReadonlyhierarchyId?: (...) | (...)

          Example

          e3c939f9ef4a7fae272e
          Copy

        • Optional Readonlyid?: (...) | (...)

          Format: int32

        • Optional Readonlylinks?: (...) | (...)

        • Optional Readonlyname?: (...) | (...)

          Example

          My repo
          Copy

        • Optional Readonlyorigin?: (...) | (...)

        • Optional Readonlypartition?: (...) | (...)

          Format: int32

        • Optional Readonlyproject?: (...) | (...)

        • Optional Readonlypublic?: (...) | (...) | (...)

        • Optional ReadonlyrelatedLinks?: (...) | (...)

        • Optional ReadonlyscmId?: (...) | (...)

          Example

          git
          Copy

        • Optional Readonlyscope?: (...) | (...)

          Example

          REPOSITORY
          Copy

        • Optional Readonlyslug?: (...) | (...)

          Example

          my-repo
          Copy

        • Optional Readonlystate?: (...) | (...) | (...) | (...) | (...)

        • Optional ReadonlystatusMessage?: (...) | (...)

          Example

          Available
          Copy

      • Optional Readonlytype?: "BRANCH" | "TAG"

    • Optional ReadonlyupdatedDate?: number

      Format: int64

      Example

      14490759200
      Copy

    • Optional Readonlyversion?: number

      Format: int32

  • Optional ReadonlysrcPath?: {
        components?: readonly string[];
        extension?: string;
        name?: string;
        parent?: string;
    }

    • Optional Readonlycomponents?: readonly string[]

      Example

      [
            "path",
            "to",
            "file.txt"
          ]
      Copy

    • Optional Readonlyextension?: string

      Example

      txt
      Copy

    • Optional Readonlyname?: string

      Example

      file.txt
      Copy

    • Optional Readonlyparent?: string

      Example

      path/to
      Copy

  • Optional ReadonlytoHash?: string

    Example

    3cdd5d19178a54d2e51b5098d43b57571241d0ab
    Copy

• Optional Readonlyanchored?: boolean

• Optional Readonlyauthor?: {
      active?: boolean;
      avatarUrl?: string;
      displayName?: string;
      emailAddress?: string;
      id?: number;
      links?: Record<string, unknown>;
      name?: string;
      slug?: string;
      type?: "NORMAL" | "SERVICE";
  }

  • Optional Readonlyactive?: boolean

  • Optional ReadonlyavatarUrl?: string

  • Optional ReadonlydisplayName?: string

    Example

    Jane Citizen
    Copy

  • Optional ReadonlyemailAddress?: string

    Example

    jane@example.com
    Copy

  • Optional Readonlyid?: number

    Format: int32

    Example

    101
    Copy

  • Optional Readonlylinks?: Record<string, unknown>

  • Optional Readonlyname?: string

    Example

    jcitizen
    Copy

  • Optional Readonlyslug?: string

    Example

    jcitizen
    Copy

  • Optional Readonlytype?: "NORMAL" | "SERVICE"

• Optional Readonlycomments?: readonly (
      { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; }
  )[]

• Optional ReadonlycreatedDate?: number

  Format: int64

  Example

  1359075920
  Copy

• Optional Readonlyhtml?: string

• Optional Readonlyid?: number

  Format: int64

  Example

  1
  Copy

• Optional Readonlyparent?: {
      anchor?: {
          diffType?: "COMMIT" | "EFFECTIVE" | "RANGE";
          fileType?: "FROM" | "TO";
          fromHash?: string;
          line?: number;
          lineType?: "ADDED" | "CONTEXT" | "REMOVED";
          multilineMarker?: {
              startLine?: number;
              startLineType: "ADDED" | "CONTEXT" | "REMOVED";
          };
          path?: {
              components?: readonly string[];
              extension?: string;
              name?: string;
              parent?: string;
          };
          pullRequest?: {
              closed?: boolean;
              closedDate?: number;
              createdDate?: number;
              description?: string;
              descriptionAsHtml?: string;
              draft?: boolean;
              fromRef?: {
                  displayId?: (...)
                  | (...);
                  id?: (...) | (...);
                  latestCommit?: (...) | (...);
                  repository?: (...) | (...);
                  type?: (...) | (...) | (...);
              };
              htmlDescription?: string;
              id?: number;
              links?: Record<string, unknown>;
              locked?: boolean;
              open?: boolean;
              participants?: readonly {
                  approved?: ...;
                  lastReviewedCommit?: ...;
                  role?: ...;
                  status?: ...;
                  user?: ...;
              }[];
              reviewers?: readonly {
                  approved?: ...;
                  lastReviewedCommit?: ...;
                  role?: ...;
                  status?: ...;
                  user?: ...;
              }[];
              state?: "DECLINED"
              | "MERGED"
              | "OPEN";
              title?: string;
              toRef?: {
                  displayId?: (...) | (...);
                  id?: (...) | (...);
                  latestCommit?: (...) | (...);
                  repository?: (...) | (...);
                  type?: (...) | (...) | (...);
              };
              updatedDate?: number;
              version?: number;
          };
          srcPath?: {
              components?: readonly string[];
              extension?: string;
              name?: string;
              parent?: string;
          };
          toHash?: string;
      };
      anchored?: boolean;
      author?: {
          active?: boolean;
          avatarUrl?: string;
          displayName?: string;
          emailAddress?: string;
          id?: number;
          links?: Record<string, unknown>;
          name?: string;
          slug?: string;
          type?: "NORMAL" | "SERVICE";
      };
      comments?: readonly (
          { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; }
      )[];
      createdDate?: number;
      html?: string;
      id?: number;
      pending?: boolean;
      properties?: Record<string, unknown>;
      reply?: boolean;
      resolvedDate?: number;
      resolver?: {
          active?: boolean;
          avatarUrl?: string;
          displayName?: string;
          emailAddress?: string;
          id?: number;
          links?: Record<string, unknown>;
          name?: string;
          slug?: string;
          type?: "NORMAL" | "SERVICE";
      };
      severity?: string;
      state?: string;
      text?: string;
      threadResolved?: boolean;
      threadResolvedDate?: number;
      threadResolver?: {
          active?: boolean;
          avatarUrl?: string;
          displayName?: string;
          emailAddress?: string;
          id?: number;
          links?: Record<string, unknown>;
          name?: string;
          slug?: string;
          type?: "NORMAL" | "SERVICE";
      };
      updatedDate?: number;
      version?: number;
  }

  • Optional Readonlyanchor?: {
        diffType?: "COMMIT" | "EFFECTIVE" | "RANGE";
        fileType?: "FROM" | "TO";
        fromHash?: string;
        line?: number;
        lineType?: "ADDED" | "CONTEXT" | "REMOVED";
        multilineMarker?: {
            startLine?: number;
            startLineType: "ADDED" | "CONTEXT" | "REMOVED";
        };
        path?: {
            components?: readonly string[];
            extension?: string;
            name?: string;
            parent?: string;
        };
        pullRequest?: {
            closed?: boolean;
            closedDate?: number;
            createdDate?: number;
            description?: string;
            descriptionAsHtml?: string;
            draft?: boolean;
            fromRef?: {
                displayId?: (...)
                | (...);
                id?: (...) | (...);
                latestCommit?: (...) | (...);
                repository?: (...) | (...);
                type?: (...) | (...) | (...);
            };
            htmlDescription?: string;
            id?: number;
            links?: Record<string, unknown>;
            locked?: boolean;
            open?: boolean;
            participants?: readonly {
                approved?: ...;
                lastReviewedCommit?: ...;
                role?: ...;
                status?: ...;
                user?: ...;
            }[];
            reviewers?: readonly {
                approved?: ...;
                lastReviewedCommit?: ...;
                role?: ...;
                status?: ...;
                user?: ...;
            }[];
            state?: "DECLINED"
            | "MERGED"
            | "OPEN";
            title?: string;
            toRef?: {
                displayId?: (...) | (...);
                id?: (...) | (...);
                latestCommit?: (...) | (...);
                repository?: (...) | (...);
                type?: (...) | (...) | (...);
            };
            updatedDate?: number;
            version?: number;
        };
        srcPath?: {
            components?: readonly string[];
            extension?: string;
            name?: string;
            parent?: string;
        };
        toHash?: string;
    }

    • Optional ReadonlydiffType?: "COMMIT" | "EFFECTIVE" | "RANGE"

    • Optional ReadonlyfileType?: "FROM" | "TO"

    • Optional ReadonlyfromHash?: string

      Example

      62a0505e8204115b8b9c8a95bfa264a8c0896a93
      Copy

    • Optional Readonlyline?: number

      Format: int32

      Example

      98
      Copy

    • Optional ReadonlylineType?: "ADDED" | "CONTEXT" | "REMOVED"

    • Optional ReadonlymultilineMarker?: { startLine?: number; startLineType: "ADDED" | "CONTEXT" | "REMOVED" }

      • Optional ReadonlystartLine?: number

        Format: int32

        Description

        The line number where the multiline comment will begin

      • ReadonlystartLineType: "ADDED" | "CONTEXT" | "REMOVED"

        Description

        The segment type of the start line of the multiline comment

    • Optional Readonlypath?: {
          components?: readonly string[];
          extension?: string;
          name?: string;
          parent?: string;
      }

      • Optional Readonlycomponents?: readonly string[]

        Example

        [
              "path",
              "to",
              "file.txt"
            ]
        Copy

      • Optional Readonlyextension?: string

        Example

        txt
        Copy

      • Optional Readonlyname?: string

        Example

        file.txt
        Copy

      • Optional Readonlyparent?: string

        Example

        path/to
        Copy

    • Optional ReadonlypullRequest?: {
          closed?: boolean;
          closedDate?: number;
          createdDate?: number;
          description?: string;
          descriptionAsHtml?: string;
          draft?: boolean;
          fromRef?: {
              displayId?: (...) | (...);
              id?: (...) | (...);
              latestCommit?: (...) | (...);
              repository?: (...) | (...);
              type?: (...) | (...) | (...);
          };
          htmlDescription?: string;
          id?: number;
          links?: Record<string, unknown>;
          locked?: boolean;
          open?: boolean;
          participants?: readonly {
              approved?: ...;
              lastReviewedCommit?: ...;
              role?: ...;
              status?: ...;
              user?: ...;
          }[];
          reviewers?: readonly {
              approved?: ...;
              lastReviewedCommit?: ...;
              role?: ...;
              status?: ...;
              user?: ...;
          }[];
          state?: "DECLINED"
          | "MERGED"
          | "OPEN";
          title?: string;
          toRef?: {
              displayId?: (...) | (...);
              id?: (...) | (...);
              latestCommit?: (...) | (...);
              repository?: (...) | (...);
              type?: (...) | (...) | (...);
          };
          updatedDate?: number;
          version?: number;
      }

      • Optional Readonlyclosed?: boolean

      • Optional ReadonlyclosedDate?: number

        Format: int64

        Example

        19990759200
        Copy

      • Optional ReadonlycreatedDate?: number

        Format: int64

        Example

        13590759200
        Copy

      • Optional Readonlydescription?: string

        Example

        It is a kludge, but put the tuple from the database in the cache.
        Copy

      • Optional ReadonlydescriptionAsHtml?: string

      • Optional Readonlydraft?: boolean

      • Optional ReadonlyfromRef?: {
            displayId?: (...) | (...);
            id?: (...) | (...);
            latestCommit?: (...) | (...);
            repository?: (...) | (...);
            type?: (...) | (...) | (...);
        }

        • Optional ReadonlydisplayId?: (...) | (...)

          Example

          feature-ABC-1233
          Copy

        • Optional Readonlyid?: (...) | (...)

          Example

          refs/heads/feature-ABC-123
          Copy

        • Optional ReadonlylatestCommit?: (...) | (...)

          Example

          babecafebabecafebabecafebabecafebabecafe
          Copy

        • Optional Readonlyrepository?: (...) | (...)

        • Optional Readonlytype?: (...) | (...) | (...)

      • Optional ReadonlyhtmlDescription?: string

      • Optional Readonlyid?: number

        Format: int64

        Example

        1
        Copy

      • Optional Readonlylinks?: Record<string, unknown>

      • Optional Readonlylocked?: boolean

      • Optional Readonlyopen?: boolean

      • Optional Readonlyparticipants?: readonly {
            approved?: ...;
            lastReviewedCommit?: ...;
            role?: ...;
            status?: ...;
            user?: ...;
        }[]

      • Optional Readonlyreviewers?: readonly {
            approved?: ...;
            lastReviewedCommit?: ...;
            role?: ...;
            status?: ...;
            user?: ...;
        }[]

      • Optional Readonlystate?: "DECLINED" | "MERGED" | "OPEN"

      • Optional Readonlytitle?: string

        Example

        Talking Nerdy
        Copy

      • Optional ReadonlytoRef?: {
            displayId?: (...) | (...);
            id?: (...) | (...);
            latestCommit?: (...) | (...);
            repository?: (...) | (...);
            type?: (...) | (...) | (...);
        }

        • Optional ReadonlydisplayId?: (...) | (...)

          Example

          feature-ABC-1233
          Copy

        • Optional Readonlyid?: (...) | (...)

          Example

          refs/heads/feature-ABC-123
          Copy

        • Optional ReadonlylatestCommit?: (...) | (...)

          Example

          babecafebabecafebabecafebabecafebabecafe
          Copy

        • Optional Readonlyrepository?: (...) | (...)

        • Optional Readonlytype?: (...) | (...) | (...)

      • Optional ReadonlyupdatedDate?: number

        Format: int64

        Example

        14490759200
        Copy

      • Optional Readonlyversion?: number

        Format: int32

    • Optional ReadonlysrcPath?: {
          components?: readonly string[];
          extension?: string;
          name?: string;
          parent?: string;
      }

      • Optional Readonlycomponents?: readonly string[]

        Example

        [
              "path",
              "to",
              "file.txt"
            ]
        Copy

      • Optional Readonlyextension?: string

        Example

        txt
        Copy

      • Optional Readonlyname?: string

        Example

        file.txt
        Copy

      • Optional Readonlyparent?: string

        Example

        path/to
        Copy

    • Optional ReadonlytoHash?: string

      Example

      3cdd5d19178a54d2e51b5098d43b57571241d0ab
      Copy

  • Optional Readonlyanchored?: boolean

  • Optional Readonlyauthor?: {
        active?: boolean;
        avatarUrl?: string;
        displayName?: string;
        emailAddress?: string;
        id?: number;
        links?: Record<string, unknown>;
        name?: string;
        slug?: string;
        type?: "NORMAL" | "SERVICE";
    }

    • Optional Readonlyactive?: boolean

    • Optional ReadonlyavatarUrl?: string

    • Optional ReadonlydisplayName?: string

      Example

      Jane Citizen
      Copy

    • Optional ReadonlyemailAddress?: string

      Example

      jane@example.com
      Copy

    • Optional Readonlyid?: number

      Format: int32

      Example

      101
      Copy

    • Optional Readonlylinks?: Record<string, unknown>

    • Optional Readonlyname?: string

      Example

      jcitizen
      Copy

    • Optional Readonlyslug?: string

      Example

      jcitizen
      Copy

    • Optional Readonlytype?: "NORMAL" | "SERVICE"

  • Optional Readonlycomments?: readonly (
        { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; }
    )[]

  • Optional ReadonlycreatedDate?: number

    Format: int64

    Example

    1359075920
    Copy

  • Optional Readonlyhtml?: string

  • Optional Readonlyid?: number

    Format: int64

    Example

    1
    Copy

  • Optional Readonlypending?: boolean

  • Optional Readonlyproperties?: Record<string, unknown>

  • Optional Readonlyreply?: boolean

  • Optional ReadonlyresolvedDate?: number

    Format: int64

    Example

    1239075920
    Copy

  • Optional Readonlyresolver?: {
        active?: boolean;
        avatarUrl?: string;
        displayName?: string;
        emailAddress?: string;
        id?: number;
        links?: Record<string, unknown>;
        name?: string;
        slug?: string;
        type?: "NORMAL" | "SERVICE";
    }

    • Optional Readonlyactive?: boolean

    • Optional ReadonlyavatarUrl?: string

    • Optional ReadonlydisplayName?: string

      Example

      Jane Citizen
      Copy

    • Optional ReadonlyemailAddress?: string

      Example

      jane@example.com
      Copy

    • Optional Readonlyid?: number

      Format: int32

      Example

      101
      Copy

    • Optional Readonlylinks?: Record<string, unknown>

    • Optional Readonlyname?: string

      Example

      jcitizen
      Copy

    • Optional Readonlyslug?: string

      Example

      jcitizen
      Copy

    • Optional Readonlytype?: "NORMAL" | "SERVICE"

  • Optional Readonlyseverity?: string

    Example

    NORMAL
    Copy

  • Optional Readonlystate?: string

    Example

    OPEN
    Copy

  • Optional Readonlytext?: string

    Example

    An insightful comment.
    Copy

  • Optional ReadonlythreadResolved?: boolean

    Description

    Indicates if this comment thread has been marked as resolved or not

  • Optional ReadonlythreadResolvedDate?: number

    Format: int64

    Example

    1569075920
    Copy

  • Optional ReadonlythreadResolver?: {
        active?: boolean;
        avatarUrl?: string;
        displayName?: string;
        emailAddress?: string;
        id?: number;
        links?: Record<string, unknown>;
        name?: string;
        slug?: string;
        type?: "NORMAL" | "SERVICE";
    }

    • Optional Readonlyactive?: boolean

    • Optional ReadonlyavatarUrl?: string

    • Optional ReadonlydisplayName?: string

      Example

      Jane Citizen
      Copy

    • Optional ReadonlyemailAddress?: string

      Example

      jane@example.com
      Copy

    • Optional Readonlyid?: number

      Format: int32

      Example

      101
      Copy

    • Optional Readonlylinks?: Record<string, unknown>

    • Optional Readonlyname?: string

      Example

      jcitizen
      Copy

    • Optional Readonlyslug?: string

      Example

      jcitizen
      Copy

    • Optional Readonlytype?: "NORMAL" | "SERVICE"

  • Optional ReadonlyupdatedDate?: number

    Format: int64

    Example

    1449075920
    Copy

  • Optional Readonlyversion?: number

    Format: int32

    Example

    1
    Copy

• Optional Readonlypending?: boolean

• Optional Readonlyproperties?: Record<string, unknown>

• Optional Readonlyreply?: boolean

• Optional ReadonlyresolvedDate?: number

  Format: int64

  Example

  1239075920
  Copy

• Optional Readonlyresolver?: {
      active?: boolean;
      avatarUrl?: string;
      displayName?: string;
      emailAddress?: string;
      id?: number;
      links?: Record<string, unknown>;
      name?: string;
      slug?: string;
      type?: "NORMAL" | "SERVICE";
  }

  • Optional Readonlyactive?: boolean

  • Optional ReadonlyavatarUrl?: string

  • Optional ReadonlydisplayName?: string

    Example

    Jane Citizen
    Copy

  • Optional ReadonlyemailAddress?: string

    Example

    jane@example.com
    Copy

  • Optional Readonlyid?: number

    Format: int32

    Example

    101
    Copy

  • Optional Readonlylinks?: Record<string, unknown>

  • Optional Readonlyname?: string

    Example

    jcitizen
    Copy

  • Optional Readonlyslug?: string

    Example

    jcitizen
    Copy

  • Optional Readonlytype?: "NORMAL" | "SERVICE"

• Optional Readonlyseverity?: string

  Example

  NORMAL
  Copy

• Optional Readonlystate?: string

  Example

  OPEN
  Copy

• Optional Readonlytext?: string

  Example

  An insightful comment.
  Copy

• Optional ReadonlythreadResolved?: boolean

  Description

  Indicates if this comment thread has been marked as resolved or not

• Optional ReadonlythreadResolvedDate?: number

  Format: int64

  Example

  1569075920
  Copy

• Optional ReadonlythreadResolver?: {
      active?: boolean;
      avatarUrl?: string;
      displayName?: string;
      emailAddress?: string;
      id?: number;
      links?: Record<string, unknown>;
      name?: string;
      slug?: string;
      type?: "NORMAL" | "SERVICE";
  }

  • Optional Readonlyactive?: boolean

  • Optional ReadonlyavatarUrl?: string

  • Optional ReadonlydisplayName?: string

    Example

    Jane Citizen
    Copy

  • Optional ReadonlyemailAddress?: string

    Example

    jane@example.com
    Copy

  • Optional Readonlyid?: number

    Format: int32

    Example

    101
    Copy

  • Optional Readonlylinks?: Record<string, unknown>

  • Optional Readonlyname?: string

    Example

    jcitizen
    Copy

  • Optional Readonlyslug?: string

    Example

    jcitizen
    Copy

  • Optional Readonlytype?: "NORMAL" | "SERVICE"

• Optional ReadonlyupdatedDate?: number

  Format: int64

  Example

  1449075920
  Copy

• Optional Readonlyversion?: number

  Format: int32

  Example

  1
  Copy