"Reserving" new REST API methods?

David Henshaw

When developing OScript modules - in particular new subtypes, audit events etc - OpenText provided a registry for customers and vendors to effectively "reserve" ranges of IDs to mitigate developers competing/overlapping.

What is the "practice" for REST APIs - specifically, if a Partner needed to develop a new method (for example extending the Node REST API), how would we go about "reserving" URLS for the resources we're implementing?

Ferdinand Prantl

There is no such registry today. I would recommend you using a reasonable prefix for the resources that you would introduce. For example, if I developed a product called LiveShare, I could create resources like these:

api/v1/nodes/:id/lsrelations
api/v1/lsallshares

It can come to a conflict with some other product, of course. But the prefix above makes it less likely to happen, than if you used common names like these:

api/v1/nodes/:id/relations
api/v1/allshares