How to use this documentation

zosConnect-2.0 and zosConnect-3.0 features

z/OS Connect v3 has two base features: zosConnect-2.0 and zosConnect-3.0.

The zosConnect-2.0 feature supports API providers and API requesters conforming to the OpenAPI 2 specification. The zosConnect-3.0 feature supports API providers and API requesters conforming to the OpenAPI 3 specification, and From 3.0.99 it also supports API requesters conforming to the OpenAPI 2 specification.

For more information about the z/OS Connect features, see z/OS Connect features.

For more information about the tags in the z/OS Connect documentation, see the following section.

Documentation tags

Some of the topics in the IBM z/OS Connect documentation are only relevant to a particular feature or capability. These topics are marked with one or more of the following tags.

z/OS Connect documentation migration to one set of documentation

From release 3.0.91, the z/OS Connect OpenAPI 2 documentation and the z/OS Connect OpenAPI 3 documentation are consolidated to be one document.

The previous z/OS Connect OpenAPI 2 documentation and the z/OS Connect OpenAPI 3 documentation structured content around the version of the OpenAPI specification. From z/OS Connect 3.0.91, the content is structured around the z/OS Connect base features: zosConnect-2.0 and zosConnect-3.0. This is to make the z/OS Connect documentation ready for future editions of the OpenAPI specifications with the z/OS Connect capabilities.

The z/OS Connect documentation is tagged to indicate which z/OS Connect base feature the content on the page is applicable to. If the content is applicable to both z/OS Connect base features, the page won't have either the zosConnect-2.0 tag (zosConnect-2.0) or the zosConnect-3.0 tag (zosConnect-3.0). There are other tags that are used throughout the z/OS Connect documentation. For more information on the documentation tagging, see Documentation tags.

As part of the z/OS Connect documentation migration, the terminology has been refined. In the z/OS Connect OpenAPI 3 documentation, a z/OS Connect Server installed on native z/OS was referred to as a z/OS Connect native server. From 3.0.91, the z/OS Connect native server is referred to as the z/OS Connect Server with Started task tagging in the documentation when required.

With the merging of the z/OS Connect OpenAPI 2 documentation and the z/OS Connect OpenAPI 3 documentation, redirects are in place to redirect your bookmarks to the new location. Remember to use the IBM Documentation search feature within IBM Documentation for content searches if you need to relocate any content favorites. For more information about IBM Documentation search, see Using the IBM Documentation search feature.

Finally, remember to use the IBM Documentation feedback facility to let us know what is and isn't working in the z/OS Connect documentation. For more information about the IBM Documentation feedback feature, see Providing feedback on the z/OS Connect document.

Using the IBM Documentation search feature

Use the IBM Documentation search feature on each page in the z/OS Connect document to optimize your search results. The IBM Documentation search engine looks in this document first and then in other IBM collections. This greatly increases the speed with which you can find the content you're looking for.

Icons

The launch icon is used to indicate that a link opens a new tab or window and takes the user out of the z/OS Connect documentation.

Terminology

Terms that are used in this documentation are defined in the Glossary.

Capitalization

Product components are referenced by their legal name by using that capitalization. For example, Podman. Some components use their name to invoke their command-line interface, in which case the name is represented in lowercase; for example, podman.

Messages

Messages for IBM z/OS Connect follow a standard IBM format. See Messages.

IP addresses

The following IPv4 addresses are used in the examples in the documentation:

• 192.0.2.*

The asterisk (*) in the ranges represents any number in the range 0 - 255. When an example requires multiple IP addresses, the asterisk (*) is changed to a number.

Passwords

Passwords that are used in the sample files and commands throughout the IBM z/OS Connect documentation are examples. When using the sample files and documentation, replace the passwords to your own passwords.

Providing feedback on the z/OS Connect document

We welcome any feedback that you have, including comments on the clarity, accuracy, or completeness of the information. Although you will not receive a direct response to your feedback, your comments help improve the content experience. Providing a clear and detailed description in your feedback helps the team understand what is required to improve the content, or, what is good about the content to replicate in other areas of the documentation.

IBM Documentation provides a Was this topic helpful? prompt on each page. Clicking or allows you to leave an optional comment with a maximum of 750 characters. Feedback should be left on the specific page that you have a comment on, in the latest release of the product.

Note: All feedback that is provided with the z/OS Connect document feedback is anonymous and gets sent to the z/OS Connect documentation team.

IBM z/OS Connect offline documentation

If you are in an airgap environment without access to the internet, use our Dark Shop app IBM® Documentation Offline to view downloads of the IBM z/OS Connect product documentation.

To download the app, and the IBM z/OS Connect documentation package, you need to log in to IBM Documentation.

For more information, see IBM Documentation Offline.

Note:

With offline documentation running on your local machine, the online document set indicates when content has been updated or added, and a new download is available.

While logged in, the original document download button updates to let you know whether you are in sync, or an update is available. Download the new documentation set as before, and reupload into the application.