Milestone API

The Milestone API allows you to create, retrieve, update, and delete milestones for your project. Below is a detailed guide to the available endpoints and their usage.

Endpoints Overview

  • GET /milestone: Retrieve a list of all milestones.
  • POST /milestone: Create a new milestone.
  • GET /milestone/:milestoneId: Retrieve details of a specific milestone.
  • PUT /milestone/:milestoneId: Update an existing milestone.
  • DELETE /milestone/:milestoneId: Delete a milestone.

Create a New Milestone

Use this endpoint to create a new milestone. The following fields are required:

  • name (string, required): The name of the milestone.
  • description (string, required): A brief description of the milestone.
  • estimate (date, required): The target date to complete the milestone.

Example Request

curl -X POST "https://api.meetandrock.com/milestone" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
  "name": "Launch MVP",
  "description": "Milestone to launch the minimum viable product",
  "estimate": "2024-01-15T00:00:00Z"
}'

Retrieve All Milestones

Use this endpoint to retrieve a list of all milestones associated with your project.

curl -X GET "https://api.meetandrock.com/milestone" \
-H "Authorization: Bearer YOUR_API_KEY"

Retrieve Milestone by ID

Retrieve details of a specific milestone using its unique ID.

curl -X GET "https://api.meetandrock.com/milestone/:milestoneId" \
-H "Authorization: Bearer YOUR_API_KEY"

Update an Existing Milestone

Update the details of an existing milestone by providing the updated fields.

  • name (string, required): The updated name of the milestone.
  • description (string, required): The updated description of the milestone.
  • estimate (date, required): The updated target completion date.
curl -X PUT "https://api.meetandrock.com/milestone/:milestoneId" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
  "name": "Updated MVP Launch",
  "description": "Updated milestone description",
  "estimate": "2024-01-20T00:00:00Z"
}'

Delete a Milestone

Use this endpoint to delete a milestone by its ID.

curl -X DELETE "https://api.meetandrock.com/milestone/:milestoneId" \
-H "Authorization: Bearer YOUR_API_KEY"

Contents