Difference between revisions of "I2Rest PCML syntax"
Pavel.lobko (talk | contribs) |
Pavel.lobko (talk | contribs) |
||
| Line 9: | Line 9: | ||
assert - specifies the path to programm, that should handle some way data passed in current <data> element. As example | assert - specifies the path to programm, that should handle some way data passed in current <data> element. As example | ||
<code><pre> <data name="ERMSG" type="struct" usage="output" struct="KSM" assert="/qsys.lib/%libl%.lib/jpcmla_eq.pgm" exclude="true"/> </pre></code> | <code><pre> <data name="ERMSG" type="struct" usage="output" struct="KSM" assert="/qsys.lib/%libl%.lib/jpcmla_eq.pgm" exclude="true"/> </pre></code> | ||
| − | jpcmla_eq - is the program that comes in the package with i2Rest Server. It examine data in ERMSG element and | + | jpcmla_eq - is the program that comes in the package with i2Rest Server. It examine data in ERMSG element and, if KSM or errormessage is found, . When PCML parser recieve flag from jpcmla_eq it stops handling PCML tags. That prevents possible failures, which could occur if incorrect data was transferred with such response. |
| + | |||
| + | exclude - attribute applicable for <code>usage="output"</code> or <code>usage="inputoutput"</code> elements. Elements with exclude attribute will be not included into server response. | ||
| − | |||
== Open Api 3.0 tag == | == Open Api 3.0 tag == | ||
Revision as of 11:56, 12 May 2020
Additional PCML data tags
Three more attributes in PCML data tag - trimarray, assert, exclude. attributes was added in order to improve response processing on server side.
trimarray - specifies the path to programm, that should handle array been passed in current element.
<data name="CCY" type="char" length="3" trimarray="/qsys.lib/%libl%.lib/jpcmlt_bl.pgm"/>
jpcmlt_bl -
assert - specifies the path to programm, that should handle some way data passed in current element. As example
<data name="ERMSG" type="struct" usage="output" struct="KSM" assert="/qsys.lib/%libl%.lib/jpcmla_eq.pgm" exclude="true"/>
jpcmla_eq - is the program that comes in the package with i2Rest Server. It examine data in ERMSG element and, if KSM or errormessage is found, . When PCML parser recieve flag from jpcmla_eq it stops handling PCML tags. That prevents possible failures, which could occur if incorrect data was transferred with such response.
exclude - attribute applicable for usage="output" or usage="inputoutput" elements. Elements with exclude attribute will be not included into server response.
Open Api 3.0 tag
The OpenAPI Specification (OAS) defines a standard, language-agnostic interface to RESTful APIs which allows both humans and computers to discover and understand the capabilities of the service without access to source code, documentation, or through network traffic inspection. When properly defined, a consumer can understand and interact with the remote service with a minimal amount of implementation logic.
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.
