Endevor 19.0 REST API Documentation Improvements

[Sam Beckwith]

As part of an initiative to standardize REST API documentation across Broadcom mainframe products, the Endevor 19.0 Web Services/REST API doc has been reorganized.

The enhancements include:

• Co-locating all configuration and integration content under Installing.
• Adding more examples and outcomes to configuration and using articles.
• Adding multiple verification steps to ensure that you can move to the next step or procedure with confidence.
• Improving architectural and workflow images to ensure an understanding of the API structure and the configuration scope.
• Adding Address Zowe Requirements and Address REST API and SOAP API Requirements (Web Services) topics to identify all prerequisites.

As part of these enhancements, the following topics have been renamed:

• "Install Web Services" is now Configure REST API and SOAP API (Web Services) and can be found in the "Complete Configuration Tasks" subsection of "Installing".
  This topic has been merged with its child topic, "Create a New Deployment of Web Services".
• "Optional: Integrate REST API with the Zowe API Mediation Layer" is now Optional: Integrate with Zowe API Mediation Layer
  Information on SAF keyrings has been moved to a new child page, Using SAF Keyrings during Zowe API ML Registration
• "Using the REST API" is now Use the REST API
• "RESTful API v1" is now REST API v1
• "Open API Specification for RESTful API v1" is now Open API Specification for REST API v1
• "RESTful API v2" is now REST API v2
• "Open API Specification for RESTful API v2" is now Open API Specification for REST API v2

Information about Endevor REST API actions now resides in the Swagger files in OpenAPI Specification for REST API v1 and OpenAPI Specification for REST API v2 and the following topics have been removed:

• "Repository Actions for RESTful API v1"
• "Element Actions for RESTful API v1"
• "List (Inventory) Actions for RESTful API v1"
• "Submit SCL Action for RESTful API v1"
• "Package Actions for RESTful API v1"
• "Authentication Actions for RESTful API v1"
• "Element Actions for RESTful API v1"
• "Repository Actions for RESTful API v2"
• "Element Actions for RESTful API v2"
• "Member Actions for RESTful API v2"
• "List (Inventory) Actions for RESTful API v2"
• "Submit SCL Action for RESTful API v2"
• "Package Actions for RESTful API v2"
• "Authentication Actions for RESTful API v2"
• "Check Actions for RESTful API v2"
• "Report Actions for RESTful API v2"
• "Asynchronous Task Actions for RESTful API v2"

The Endevor 18.1 REST API documentation is unaffected by these changes.

------------------------------
Sam Beckwith
Technical Writer
Endevor®
------------------------------