Skip to Main Content
IBM Power Ideas Portal


This portal is to open public enhancement requests against IBM Power Systems products, including IBM i. 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 Future consideration
Workspace IBM i
Categories Web Serving
Created by Guest
Created on Sep 12, 2017

Allow documenting of fields and structures in PCML

It would be great if a PCML had a documentation attribute for fields and structures. This would allow to generate a much better Swagger documentation using the apiDiscovery Liberty feature.


Use Case:

Provided Swagger documentation would not only be a raw description of input/output data, but would also provide more detailed information about fields and structures, making it easier for clients to consume those APIs.


Idea priority Low
  • Guest
    Reply
    |
    Jun 17, 2021

    IBM understand this requirement and will consider this in a future release.

  • Guest
    Reply
    |
    Sep 21, 2017

    I am requesting new feature in PCML, for example (notice the doc attributes in and nodes):









    restConsumes="application/xml, application/json" restHttpRequestMethod="POST"
    restProduces="application/xml, application/json"
    threadsafe="false" wrapInputParams="true" wrapOutputParam="true">





    Then I would like those doc attributes to be included in swagger.json generated by IWS (/qibm/ProdData/OS/WebServices/bin/installWebService.sh script), so the swagger.json looks somewhat like this (notice the "description" attributes):

    {
    "swagger": "2.0",
    "info": {
    "title": "iacgtcud8f APIs",
    "description": "APIs available for iacgtcud8f",
    "version": "1.0.0"
    },
    "basePath": "/icbsKlnt/iacgtcud8f",
    "tags": [
    {
    "name": "iacgtcud8f APIs",
    "description": "APIs available for iacgtcud8f"
    }
    ],
    "definitions": {
    "iaigtcusdd": {
    "type": "object",
    "description": "some structure description",
    "properties": {
    "nrkli": {
    "type": "string",
    "maxLength": 10,
    "description": "some field description"
    },
    "nrgrid": {
    "type": "number"
    }
    }
    },
    "iaogtcud8f": {
    "type": "object",
    "description": "some structure description",
    "properties": {
    "retstat": {
    "type": "string",
    "maxLength": 1,
    "description": "some field description"
    }
    }
    },
    "iacgtcud8fInput": {
    "type": "object",
    "properties": {
    "iaigtcusdd": {
    "$ref": "#/definitions/iaigtcusdd"
    }
    }
    },
    "iacgtcud8fResult": {
    "type": "object",
    "properties": {
    "iaogtcud8f": {
    "$ref": "#/definitions/iaogtcud8f"
    }
    }
    }
    },
    "paths": {
    "/": {
    "post": {
    "tags": [
    "iacgtcud8f APIs"
    ],
    "operationId": "iacgtcud8f",
    "consumes": [
    "application/xml",
    "application/json"
    ],
    "produces": [
    "application/xml",
    "application/json"
    ],
    "parameters": [
    {
    "name": "body",
    "in": "body",
    "required": true,
    "schema": {
    "$ref": "#/definitions/iacgtcud8fInput"
    }
    }
    ],
    "responses": {
    "200": {
    "description": "Successful operation",
    "schema": {
    "$ref": "#/definitions/iacgtcud8fResult"
    }
    }
    }
    }
    }
    }
    }

    I have no idea how this could be achieved for PCMLs generated by RPG compiler but it would be a greate feature too. Maybe get that data from some comments preceding type declaration in code, or take from DSPFFD?

  • Guest
    Reply
    |
    Sep 20, 2017

    Are you requesting a new feature for the PCML language itself, or are you requesting that the RPG and COBOL compilers add the ability to understand Swagger annotations in the source code so they can be added as comments in the PCML that the compilers generate?

    If you are requesting a new feature for PCML, please add a small example of how you would like to code the PCML.