-
Notifications
You must be signed in to change notification settings - Fork 203
API Endpoints Overview
Travis Prescott edited this page Jun 23, 2025
·
2 revisions
-
POST
/api/APIRevisions
— Endpoint used by Client SPA for listing API Revisions. -
PUT
/api/APIRevisions/delete
— Endpoint used by Client SPA for Deleting APIRevisions. -
PUT
/api/APIRevisions/restore
— Endpoint used by Client SPA for Restoring Deleted APIRevisions. -
POST
/api/APIRevisions/{apiRevisionId}/toggleViewedBy
— Endpoint used by Client SPA toggling ViewdBy property -
POST
/api/APIRevisions/{reviewId}/generateReview
— GenerateAIReview -
GET
/api/APIRevisions/{reviewId}/latest
— Get the APIRevisions for a Review filtered by query parameters -
POST
/api/APIRevisions/{reviewId}/{apiRevisionId}
— Endpoint used by Client SPA for Toggling APIRevision Approval -
POST
/api/APIRevisions/{reviewId}/{apiRevisionId}/reviewers
— Endpoint used by Client SPA for Requesting Reviewers
-
GET
/api/Auth
— -
GET
/api/Auth/AppVersion
—
-
POST
/api/Comments
— Create a new Comment -
DELETE
/api/Comments/{apiRevisionId}/clearAutoComments
— Soft Delete all auto generated comments -
GET
/api/Comments/{reviewId}
— Retrieve comments for a review. -
PATCH
/api/Comments/{reviewId}/resolveComments
— Resolve comments in a comment thread -
PATCH
/api/Comments/{reviewId}/unResolveComments
— UnResolve comments in a comment thread -
GET
/api/Comments/{reviewId}/{apiRevisionId}
— Retrieve conversation information -
DELETE
/api/Comments/{reviewId}/{commentId}
— Soft Delete a Comment -
PATCH
/api/Comments/{reviewId}/{commentId}/toggleCommentDownVote
— Toggle comment downvote -
PATCH
/api/Comments/{reviewId}/{commentId}/toggleCommentUpVote
— Toggle comment upvote -
PATCH
/api/Comments/{reviewId}/{commentId}/updateCommentText
— Create a new Comment
-
GET
/api/PullRequests
— Retrieves API Revision information associated with a Pull Request and commitSHA -
GET
/api/PullRequests/CreateAPIRevisionIfAPIHasChanges
— Check if there are changes in API surface between new and existing API revisions Create new API revision based on presence of API changes -
GET
/api/PullRequests/{reviewId}/{apiRevisionId}
— Retrieves Pull Requests associated with an API Revision -
GET
/api/PullRequests/{reviewId}/{apiRevisionId}/prsofassociatedapirevisions
— Retrieves Pull Requests of all API Revisions associated with a Review
-
GET
/api/Reviews
— Retrieves a list of reviews grouped by pages -
POST
/api/Reviews
— Create a Reviews -
GET
/api/Reviews/allowedApprovers
— AllowedApprovers -
GET
/api/Reviews/{reviewId}
— Retrieves a review by its id -
GET
/api/Reviews/{reviewId}/content
— Retrieve the Content (codeLines and Navigation) of a review -
GET
/api/Reviews/{reviewId}/preferredApprovers
— PreferredApprovers -
POST
/api/Reviews/{reviewId}/toggleSubscribe
— Endpoint used by Client SPA toggling Subscription to a review -
POST
/api/Reviews/{reviewId}/{apiRevisionId}
— Endpoint used by Client SPA for Toggling Review Approval
-
POST
/api/SamplesRevisions
— Endpoint used by Client SPA for listing samples revisions. -
PUT
/api/SamplesRevisions/delete
— Endpoint used by Client SPA for Deleting Usage Sample. -
GET
/api/SamplesRevisions/{reviewId}/content
— -
POST
/api/SamplesRevisions/{reviewId}/create
— Create usage sample revision -
GET
/api/SamplesRevisions/{reviewId}/latest
— Get the APIRevisions for a Review filtered by query parameters -
PATCH
/api/SamplesRevisions/{reviewId}/update
— Update usage sample revision
-
GET
/api/UserProfile
— -
PUT
/api/UserProfile
— UpdateUserProfile -
PUT
/api/UserProfile/preference
— UpdateUserPreference