Skip to Main Content
IBM Z Software


This portal is to open public enhancement requests against IBM Z Software products. To view all of your ideas submitted to IBM, create and manage groups of Ideas, or create an idea explicitly set to be either visible by all (public) or visible only to you and IBM (private), use the IBM Unified Ideas Portal (https://ideas.ibm.com).


Shape the future of IBM!

We invite you to shape the future of IBM, including product roadmaps, by submitting ideas that matter to you the most. Here's how it works:

Search existing ideas

Start by searching and reviewing ideas and requests to enhance a product or service. Take a look at ideas others have posted, and add a comment, vote, or subscribe to updates on them if they matter to you. If you can't find what you are looking for,

Post your ideas
  1. Post an idea.

  2. Get feedback from the IBM team and other customers to refine your idea.

  3. Follow the idea through the IBM Ideas process.


Specific links you will want to bookmark for future use

Welcome to the IBM Ideas Portal (https://www.ibm.com/ideas) - Use this site to find out additional information and details about the IBM Ideas process and statuses.

IBM Unified Ideas Portal (https://ideas.ibm.com) - Use this site to view all of your ideas, create new ideas for any IBM product, or search for ideas across all of IBM.

ideasibm@us.ibm.com - Use this email to suggest enhancements to the Ideas process or request help from IBM for submitting your Ideas.

Status Not under consideration
Workspace z/OS Connect
Created by Guest
Created on Jul 10, 2024

Ignore unexpected fields in the Response to apiRequester call in Open API V2

We have CICS Transactions issuing apiRequester calls to various distributed applications.

Occasionally we find that these distributed applications may add new fields to the response as part of a new release, often without notifying the applications that are calling them.

When the response containing the new / unexpected field (even if it's 'null') is received by z/OS Connect an error message is issued e.g.

DFHPI1007 JSON to data transformation failed because of incorrect input (UNDEFINED_ELEMENT rewardProgramList).

The CICS application then needs to recreate their apiRequester / archive file to add the new fields even if they aren't interested in them.

Currently we are using Open API V2, I believe in V3 this situation is handled differently and the unexpected fields are just ignored - could Open API 2 be updated to also ignore the unexpected field or at least not cause the request to fail.

Idea priority Low
  • Admin
    Demelza Farrer
    Reply
    |
    Jul 23, 2024

    This requirement has been evaluated, and is being reject on the following basis:

    Unfortunately it is not possible to back port the Open API 3 capability to tolerate new fields added by the API endpoint to Open API 2 API requester.

    We recommend using the following method to achieve the requirement:

    However, it is possible to convert the swagger document, provided by the API endpoint, to Open API 3 and then call the API using the new Open API 3 API requester capability. This can be achieved by using a tool such as https://editor.swagger.io/ and select Edit > Convert to OpenAPI 3 from the menu.

    As well as tolerating the API endpoint adding new fields, the calling application would also benefit from the additional following enhancements https://www.ibm.com/docs/en/zos-connect/zos-connect/3.0?topic=requester-zos-connect-api-enhancements.

    Alternatively, the API requester should be regenerated using the updated swagger document to enable it to accept the new field(s).