API Changelog

Change log and deprecations

Rowan Savage avatar
Written by Rowan Savage
Updated over a week ago

Runn is currently at v0 of it's API. This means we regularly update and change our API.

We do our best to ensure a 3 month warning period for any breaking changes with the exception of _unstable APIs.
โ€‹
Runn is planning to transition to v1. After the full release of v1, we will provide continued support of v0 for at least 6 months.

Upcoming Deprecations

  • None

Changes

2023-05-22

  • NEW: Add GET projects/:id/other_expenses for showing project expenses

  • NEW: Add POST projects/:id/other_expenses for creating project expenses

  • NEW: Add PUT projects/:id/other_expenses/:expense_id for updating project expenses

  • NEW: Add DELETE projects/:id/other_expenses/:expense_id for deleting project expenses

  • NEW: Add PUT projects/:id/lock_timesheets to lock a specific project timesheet to a date.

2023-04-24

  • All skills_unstable can now be accessed as skills - this is a straight change with no breaking changes.

  • NEW: Add GET /skills for listing skills

  • NEW: Add POST /skills for creating skills

  • NEW: Add GET /skills/:id for a single skill

  • NEW: Add PUT /skills/:id for updating a single skill

  • NEW: Add DELETE /skills/:id for deleting a single skill

  • NEW: Add skills property to people

  • FUTURE DEPRECATION: From 2023-05-29 all skill_unstable endpoints will be removed. They have now been hidden from documentation and swagger.

2022-10-31

  • DEPRECATED: All endpoints are now paginated.

2022-09-05

  • NEW: Add GET /skills_unstable for listing skills

  • NEW: Add POST /skills_unstable for creating skills

  • NEW: Add GET /skills_unstable/:id for a single skill

  • NEW: Add PUT /skills_unstable/:id for updating a single skill

  • NEW: Add DELETE /skills_unstable/:id for deleting a single skill

  • NEW: Add skills_unstable property to people

  • DEPRECATED: Removed total_minutes on assignments

2022-07-25

  • FUTURE DEPRECATION: From 2022-10-24 all get requests will have pagination added to them.

2022-07-18

  • NEW: Pagination now follows the RFC5988 specifications

  • FUTURE DEPRECATION: From 2022-08-15 total_minutes will be removed from the assignments model

2022-05-16

  • NEW: Add PUT /roles/:id for updating existing roles

  • NEW: Add POST /teams for creating a team

  • NEW: Add PUT /teams/:ids for updating a team

  • NEW: Add DELETE /teams/:id for deleting a team

  • FIX: Fix bug in POST /people/:id/contracts that failed when no current contract exists

2022-05-02

  • DEPRECATED: Removed people.projects as being automatically returned from GET /people - you can continue with this behaviour by using ?include_projects=true however this does come with a performance penalty.

2022-04-13

  • NEW: Add GET /actuals

  • FIX: Correct some types showing id as number instead of string

  • FIX: Fix bug in POST /people/:id/contracts that failed when no current contract exists

2022-03-20

  • NEW: Add DELETE /people/{id}/contracts/{contract_id}

  • ADDITION: Add sent_date to GET /invitations

2022-02-14

  • NEW: Add GET /milestones

2022-01-17

  • FUTURE DEPRECATION: From 2022-04-19 GET /people will no longer return projects that people are working on by default. You will need to pass ?include_projects=true - this will result in a 3x speed increase for those who do not need this data.

  • ADDITION: You may now add include_projects=false to GET /people to increase the speed of this request.

Did this answer your question?