Skip to main content
Introduction to updating API operations

API development

R
Written by Riku Virtanen
Updated over 10 months ago

Introduction to updating API operations

During the life cycle of an API, there is often need to modify the interface as requirements change or testing brings up needs for improving the API's interface. In practice, API's interface is changed by modifying API's OpenAPI Specification.

Interface change in the OpenAPI Specification can be one or many of the following:

  • change to the existing API operations by

    • adding, changing or deleting operation's parameter

    • change to API operation's path

    • change to data structure received by the API operation

    • change to data structure returned by the API operation

    • adding, changing or deleting API operation's return codes (like HTTP 200 - ok, HTTP 400 - bad request)

  • create new API operations

  • delete existing API operations.

All the listed changes effect the API triggers of changed API operations and the API trigger needs to be updated to the linked processes.


​

Did this answer your question?