Project related beans renamed in Jira Cloud OpenAPI specs

Hi devs!

This is Adam from the Jira Cloud ecosystem team.

I am letting you know that on Monday 17th of May I am about to rename some beans that are published in our OpenAPI spec. That change may affect you if you generate client code automatically from the OpenAPI spec.

What is changing?

Before this change is implemented both Create Project and Update Project endpoints use bean (scheme) named ProjectInputBean. From now on Create Project will use CreateProjectDetails and Update Project will use UpdateProjectDetails. There is no breaking change in the request payload. Change affects only names of beans.

Why is it changing?

This change is motivated to provide cleaner documentation on , i.e. to get rid of fields that behave differently on update and on creation.

What do I need to do?

If you generate client code from Atlassian OpenAPI spec, then you have to download new spec, regenerate your client code, and if your code doesn’t compile anymore, rename beans. Bean used in create is now named CreateProjectDetails and bean used in update is named UpdateProjectDetails.

By when do I need to do it?

OpenAPI specs will be updated on May 17th, 2021.


This topic was automatically closed 30 days after the last reply. New replies are no longer allowed.