From 9bcdcf286463bc56f69a5e915ff9cf8147cdaea4 Mon Sep 17 00:00:00 2001 From: Jason Heiser Date: Tue, 22 Jul 2025 17:44:59 -0500 Subject: [PATCH 1/2] Fix typo and add hyperlink to OAS file --- apiconcepts/overview.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/apiconcepts/overview.md b/apiconcepts/overview.md index 1d03da2..39038fe 100644 --- a/apiconcepts/overview.md +++ b/apiconcepts/overview.md @@ -9,7 +9,6 @@ For complete installation and setup information, please refer to the XPP Technic 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. -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 XPP RESTful Web Services is derived from an [OpenAPI-compatible (v3.1) specification](documentation/xpp-rest.json). This specification then produces [a human-readable HTML web app](documentation/index.html) that provides a structured overview of all available endpoints, request/response formats, supported parameters, and example payloads, enabling you to easily understand how to use XPP RESTful Web Services. 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. \ No newline at end of file From 21d3e9fe5bb1f66aed4c60575b83c636761845f8 Mon Sep 17 00:00:00 2001 From: Jason Heiser Date: Wed, 23 Jul 2025 16:44:31 -0500 Subject: [PATCH 2/2] Improve overview Include JS and CSS files --- apiconcepts/overview.md | 18 ++++++++++-------- docfx.json | 4 +++- 2 files changed, 13 insertions(+), 9 deletions(-) diff --git a/apiconcepts/overview.md b/apiconcepts/overview.md index 39038fe..116803a 100644 --- a/apiconcepts/overview.md +++ b/apiconcepts/overview.md @@ -1,14 +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 documentation for XPP RESTful Web Services is derived from an [OpenAPI-compatible (v3.1) specification](documentation/xpp-rest.json). This specification then produces [a human-readable HTML web app](documentation/index.html) that provides a structured overview of all available endpoints, request/response formats, supported parameters, and example payloads, enabling you to easily understand how to use XPP RESTful Web Services. +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. \ No newline at end of file +## 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)**. diff --git a/docfx.json b/docfx.json index 3a4d495..feac0c2 100644 --- a/docfx.json +++ b/docfx.json @@ -26,7 +26,9 @@ "files": [ "**/images/**", "**/*.json", - "**/*.html" + "**/*.html", + "**/*.js", + "**/*.css" ] } ],