Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

HPCC-17995 Document ESDL version and default_client_version attributes #10288

Merged
merged 1 commit into from Jul 27, 2017
Merged

HPCC-17995 Document ESDL version and default_client_version attributes #10288

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
40 changes: 40 additions & 0 deletions docs/DynamicESDL/DESDL-Mods/ESDLversion.xml
View file
Open in desktop
@@ -0,0 +1,40 @@
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
<sect1 id="ESDL_Attributes_version">
<title><emphasis role="bold">version <indexterm>
<primary>version</primary>
</indexterm>and default_client_version</emphasis></title>

<para><indexterm>
<primary>default_client_version</primary>
</indexterm>The <emphasis role="bold">version</emphasis> and <emphasis
role="bold">default_client_version</emphasis> attributes (valid only for an
ESPService) allow you to specify the version to use when a version is not
explicitly specified in the request. </para>

<para>The <emphasis role="bold">default_client_version</emphasis> is used
for API requests in SOAP format if the client doesn't specify the version.
The <emphasis role="bold">version</emphasis> is used for requests coming
from a web browser without a version decoration in the URL.</para>

<para>These attributes provide better API backward compatibility while
allowing API developers to see the latest interface using a browser. </para>

<para>If <emphasis role="bold">default_client_version</emphasis> is higher
than <emphasis role="bold">version</emphasis>, the service uses <emphasis
role="bold">default_client_version</emphasis> for all requests that don't
specify a <emphasis role="bold">version</emphasis>.</para>

<para>Even though defaults can be specified for a service, you should still
encourage API developers to specify a version in requests to ensure
compatibility between their application and the service. </para>

<para><emphasis role="bold">Example:</emphasis></para>

<programlisting> ESPservice [version("0.02"), default_client_version("0.01")] EsdlExample
{
ESPmethod EchoPersonInfo(EchoPersonInfoRequest, EchoPersonInfoResponse);
ESPmethod RoxieEchoPersonInfo(RoxieEchoPersonInfoRequest, RoxieEchoPersonInfoResponse);
};</programlisting>
</sect1>
4 changes: 3 additions & 1 deletion docs/DynamicESDL/ESDL_LangRef_Includer.xml
View file
Open in desktop
Expand Up @@ -245,7 +245,9 @@
<xi:include href="DynamicESDL/DESDL-Mods/ESDLdescription.xml"
xpointer="element(/1)"
xmlns:xi="http://www.w3.org/2001/XInclude" />

<xi:include href="DynamicESDL/DESDL-Mods/ESDLversion.xml"
xpointer="element(/1)"
xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="DynamicESDL/DESDL-Mods/ESDLauth_feature.xml"
xpointer="element(/1)"
xmlns:xi="http://www.w3.org/2001/XInclude" />
Expand Down