Comment on page
All notable changes to the REST API will be documented in this page.
We have changed the way we compute the feedback score based on user ratings which is affecting the following endpoint:
scoreis now calculated this way. This is done to reinforce negative ratings and help surfacing content that may require updates.
ratingis now computed this way
'good'whenever the score is > 0
'ok'whenever the score is 0
'bad'whenever the score is < 0
ponderedScoreis computed by multiplying the
scoreby the total amount of ratings given by visitors.
Note: The GitBook app is displaying
ponderedScoreinside of the Insights section.
We are introducing a collection of API endpoints to automate the management of members and teams in an organization:
/v1/owners/:id/spaceshas been removed and replaced by:
/v1/orgs/:id/spacesfor an organization
/v1/users/:id/spacesfor a user
Page previously had only one
pathproperty representing the page slug in its direct page parent. Pages will now include 2 properties:
slug: representing the page's slug in its direct parent
path: representing the complete page's path in the revision
Requests on page using a URL will now require a URL encoded page's path. For example the previous request:
should now be:
POST /v1/spaces/:space/change-requestswas only returning the ID of the newly created change-request.
The response will now contain the entire change-request object. A property
changeRequestis appended for compatibility, but marked as deprecated and will be removed in the near future.
Last modified 23d ago