Skip to content

Release 1.6a #5

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

Merged
kvantassell-rws merged 2 commits into from
Jul 23, 2025
Merged

Release 1.6a #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9bcdcf2
Fix typo and add hyperlink to OAS file
jason-heiser-rws Jul 22, 2025
21d3e9f
Improve overview
jason-heiser-rws Jul 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 10 additions & 9 deletions apiconcepts/overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,16 @@
# Welcome to the XPP RESTful Web Services developer documentation #
# XPP RESTful Web Services

This site serves as the comprehensive reference for developers working with XPP RESTful Web Services.
Here, you will find detailed installation guides, configuration instructions, usage examples, and best practices for integrating and extending the capabilities of XPP through its RESTful APIs.
Welcome! This site is for developers building tools with XPP RESTful Web Services.
Here you will find installation guides, configuration instructions, usage examples, and best practices for integrating and extending the capabilities of XPP through its RESTful APIs.

For complete installation and setup information, please refer to the XPP Technical Documentation available on the official RWS documentation portal at docs.rws.com **[XPP technical documentation](https://docs.rws.com/en-US/xpp-restful-web-services-1-6-1248383/welcome-to-the-xpp-restful-web-services-documentation-411242)**.
## Installation

## Current release: XPP RESTful Web Services 1.6 ##
For complete installation and setup information, please refer to the **[XPP Technical Documentation](https://docs.rws.com/en-US/xpp-restful-web-services-1-6-1248383/welcome-to-the-xpp-restful-web-services-documentation-411242)** on the official RWS documentation portal.

The latest supported version is XPP RESTful Web Services 1.6, which includes enhancements for improved performance, stability, and broader integration capabilities. Please ensure you are reviewing the documentation that corresponds to this release to take full advantage of the most recent updates.
## API Documentation

The full OpenAPI documentation for XPP RESTful Web Services is available The OpenAPI documentation is available [here](documentation/index.html).
This resource provides a structured overview of all available endpoints, request/response formats, supported parameters, and example payloads, enabling you to quickly explore and integrate the services into your workflows.
The documentation for all API calls is available in **[this human-readable HTML web app](documentation/index.html)** that provides a structured overview of all endpoints, request/response formats, supported parameters, and example payloads.

Whether you are setting up a new environment, migrating from an earlier version, or developing custom solutions that interface with XPP, this documentation is designed to support you at every step.
## OpenAPI Specification

The documentation above is derived from **[this JSON file](documentation/xpp-rest.json)** that conforms to version 3.1 of the **[OpenAPI Specification](https://spec.openapis.org/oas/v3.1.0.html)**.
4 changes: 3 additions & 1 deletion docfx.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,9 @@
"files": [
"**/images/**",
"**/*.json",
"**/*.html"
"**/*.html",
"**/*.js",
"**/*.css"
]
}
],
Expand Down