I2Rest PCML syntax - Revision history

Alexei.baranov: /* Attributes extending PCML Data tag */

2021-05-19T06:11:13Z

‎Attributes extending PCML Data tag

Pavel.lobko at 12:03, 9 July 2020

2020-07-09T12:03:17Z

Pavel.lobko at 11:43, 9 July 2020

2020-07-09T11:43:57Z

Alexei.baranov at 13:27, 25 May 2020

2020-05-25T13:27:29Z

Alexei.baranov: /* openapi30 tag */

2020-05-22T11:19:24Z

‎openapi30 tag

Alexei.baranov: /* openapi30 tag */

2020-05-22T11:18:21Z

‎openapi30 tag

Alexei.baranov: /* Program level openapi30 tag */

2020-05-22T11:05:28Z

‎Program level openapi30 tag

Alexei.baranov: /* assert */

2020-05-22T11:04:30Z

‎assert

Alexei.baranov: /* assert */

2020-05-22T11:04:05Z

‎assert

Alexei.baranov: /* assert */

2020-05-22T11:03:19Z

‎assert

@@ Line 44: / Line 44: @@
 ===exclude===
 This attribute applicable for output-capable data elements (<code>usage="output"</code> or <code>usage="inputoutput"</code>). Elements with exclude attribute will be not included into server response. Exclude attribute can be useful in processing fields with the assert attribute defined. You can omit sending error code field in API response in case of there is no error.
 == openapi30 tag ==

@@ Line 1: / Line 1: @@
 {{DISPLAYTITLE:I2Rest PCML syntax}}
-i2Rest Server uses the PCML format as the basis for describing call parameters for IBM i programs to expose them as OpenAPI services. PCML format described in details [https://www.ibm.com/support/knowledgecenter/ssw_ibm_i_73/rzahh/pcml.htm on IBM site]. PCML description of your RPGLE programs can be created manually in any text editor, or generated automatically as a result of the CRTRPGMOD command (PGMINFO and INFOSTMF parameters). i2Rest Server has full support of the PCML syntax, and also can use several advanced attributes and tags.
+i2Rest Server uses the PCML format as the basis for describing call parameters for IBM i programs to expose them as OpenAPI services. PCML format described in details [https://www.ibm.com/support/knowledgecenter/ssw_ibm_i_73/rzahh/pcml.htm on IBM site]. PCML description of your RPGLE programs can be created manually in any text editor, or generated automatically as a result of the CRTRPGMOD command (PGMINFO and INFOSTMF parameters). i2Rest Server has full support of the PCML syntax, and also can use several advanced attributes and tags to improve interaction between API and a client.
 You have to [[I2Rest_API_Implementation|deploy PCML description file]] to i2Rest Server in order to be able to call programs as an OpenAPIs

@@ Line 1: / Line 1: @@
 {{DISPLAYTITLE:I2Rest PCML syntax}}
-<span style="color:red">i2Rest Server использует формат PCML как основу для описания параметров вызова программ IBM i и expose them as OpenAPI services. Формат PCML подробно описан [https://www.ibm.com/support/knowledgecenter/ssw_ibm_i_73/rzahh/pcml.htm on IBM site]. PCML описание ваших RPGLE программ может быть создано вручную в любом текстовом редакторе, или сгенерировано автоматически как результат выполнения команды CRTRPGMOD (параметры PGMINFO и INFOSTMF). i2Rest Server понимает все параметры PCML синтаксиса. В дополнении к стандартным, в i2Rest Server можно применять несколько расширенных атрибутов и тегов, направленных на улучшение взаимодействия клиента с вашими API</span>
+i2Rest Server uses the PCML format as the basis for describing call parameters for IBM i programs to expose them as OpenAPI services. PCML format described in details [https://www.ibm.com/support/knowledgecenter/ssw_ibm_i_73/rzahh/pcml.htm on IBM site]. PCML description of your RPGLE programs can be created manually in any text editor, or generated automatically as a result of the CRTRPGMOD command (PGMINFO and INFOSTMF parameters). i2Rest Server has full support of the PCML syntax, and also can use several advanced attributes and tags.
 You have to [[I2Rest_API_Implementation|deploy PCML description file]] to i2Rest Server in order to be able to call programs as an OpenAPIs

@@ Line 1: / Line 1: @@
 {{DISPLAYTITLE:I2Rest PCML syntax}}
 <span style="color:red">i2Rest Server использует формат PCML как основу для описания параметров вызова программ IBM i и expose them as OpenAPI services. Формат PCML подробно описан [https://www.ibm.com/support/knowledgecenter/ssw_ibm_i_73/rzahh/pcml.htm on IBM site]. PCML описание ваших RPGLE программ может быть создано вручную в любом текстовом редакторе, или сгенерировано автоматически как результат выполнения команды CRTRPGMOD (параметры PGMINFO и INFOSTMF). i2Rest Server понимает все параметры PCML синтаксиса. В дополнении к стандартным, в i2Rest Server можно применять несколько расширенных атрибутов и тегов, направленных на улучшение взаимодействия клиента с вашими API</span>
 __TOC__

@@ Line 46: / Line 46: @@
 This tag is not about processing of remote program call like native PCML tags. It can enhance API description according to OpenAPI Specification (OAS), which allows both humans and computers to discover and understand the capabilities of the service without access to source code or documentation. An OpenAPI definition can then be used by documentation generation tools to display the API, code generation tools to generate servers and clients in various programming languages, testing tools, and many other use cases.
-i2Rest Server generates OpenAPI specification automatically for each deployed PCML API service. OpenAPI specification in format 3.0 is available for each PCML API at address:
+i2Rest Server generates OpenAPI specification automatically for each deployed PCML API service. OpenAPI specification in format 3.0 is available for each PCML API at address (main and management gates):
 <pre>http[s]://<your_i2rest_server_instance>/openapi30/<API_mount_point></pre>

@@ Line 97: / Line 97: @@
           <requestExamples>
              <nowiki><!-- This will come to paths/<your API>/post/requestBody/content/"application/json"/examples --></nowiki>
-             <example name="exmalpe1" summary="Summary of example 1" description="Description of example 1">
+             <example name="example1" summary="Summary of example 1" description="Description of example 1">
                 <![CDATA[{
                    "input": {"echo": 0},
@@ Line 105: / Line 105: @@
                 }]]>
              </example>
-             <example name="exmalpe2" summary="Summary of example 2" description="Description of example 2">Second Example</example>
+             <example name="example2" summary="Summary of example 2" description="Description of example 2">Second Example</example>
           </requestExamples>
        </openapi30>

@@ Line 38: / Line 38: @@
 |}
-i2Rest Server installation includes assert user exit I2RESTA_EC, that can be used to check error code fields in ERRC0100 error code format (see [https://www.ibm.com/support/knowledgecenter/ssw_ibm_i_71/apiref/errorcodeformat.htm description])
+i2Rest Server installation includes assert user exit I2RESTA_EC, which can be used to check error code fields in ERRC0100 error code format (see [https://www.ibm.com/support/knowledgecenter/ssw_ibm_i_71/apiref/errorcodeformat.htm description])
 ===exclude===

@@ Line 26: / Line 26: @@
 This attribute specifies the path to program, that should be used as error checking procedure for current <data> output-capable element. i2Rest Server will process data fields with assert exit program first, to ensure that returned data is consistent. Assert user exit can inform i2Rest Server about error in data field, in this case i2Rest Server will stop further processing of output parameters and will return error message to the client of API.<br/>
 Example:
-<pre> <data name="ERMSG"       type="struct" usage="output"      struct="KSM" assert="/qsys.lib/%libl%.lib/jpcmla_eq.pgm" exclude="true"/> </pre>
+<pre> <data name="ERMSG"       type="struct" usage="output"      struct="KSM" assert="/QSYS.LIB/%LIBL%.LIB/I2RESTA_EQ.PGM" exclude="true"/> </pre>
 Parameters passed to trimarray exit program as follows:
 {| class="wikitable" style="width: 70%"

@@ Line 37: / Line 37: @@
 |Error message || CHAR(1024) || OUTPUT || Text of error message. Blank value means no error in current field, in other case i2Rest Server will stop processing of output parameters and will return this error message to the client
 |}
 ===exclude===