Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
16 changes: 3 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,13 @@
# XPP-api-docs
# XPP API Docs

## What is it?

This the main repository for the XPP Public API documentation.
This the main repository for XPP RESTful API’s documentation.

## Can I contribute?

Anyone is welcome to contribute to the public XPP API documentation by making a pull request into the master repository.


The documentation is split into the following sections:
- Articles
- This section hosts a series of usefull article on:
- how to get started with writing plug-ins for XPP
- how to best use the public APIs
- how to troubleshoot common issues
- API Concepts
- This section hosts the main guidelines on using the Public API along with the API References

### Getting started with your contribution
The documentation is built using a static documentation generator called [DocFX](https://dotnet.github.io/docfx/).
The documentation content is saved in *Markdown* files and then built into a website using [DocFX](https://dotnet.github.io/docfx/). The table of content is saved into separate *toc.yml* files.
Expand All @@ -29,7 +19,7 @@ In order for you to make a contribution directly please follow the next steps:
- You can use tools such as *Notepad++* or *Visual Studio Code* to edit the content
- Create a Pull Request with your changes.
- This pull request will be reviewed for correctness by one of our technical writers
- Once your pull request has been approved and committed into the *main* branch, an automatic pipeline will be triggered which will push your changes to the [live documentation site](https://rws.github.io/studio-api-docs/index.html)
- Once your pull request has been approved and committed into the *main* branch, an automatic pipeline will be triggered which will push your changes to the [live documentation site](https://rws.github.io/xpp-api-docs/index.html)
- if you wish to test your changes locally you can follow the [DOCFX Installation guideline](https://dotnet.github.io/docfx/tutorial/docfx_getting_started.html) and [build the entire solution locally](https://dotnet.github.io/docfx/tutorial/walkthrough/walkthrough_create_a_docfx_project.html)
- Our documentation automatically fills in the product name and other details so you don't have to make the changes manually if we decide to update the product name. Use the '<var:VariableName>' construct to tell our documentation engine to fill in the info for you. Here are the constructs available at this point:

Expand Down
5 changes: 0 additions & 5 deletions api/.gitignore

This file was deleted.

2 changes: 0 additions & 2 deletions api/index.md

This file was deleted.

16 changes: 0 additions & 16 deletions apiconcepts/overview.md

This file was deleted.

2 changes: 0 additions & 2 deletions apiconcepts/toc.yml

This file was deleted.

7 changes: 0 additions & 7 deletions articles/intro.md

This file was deleted.

2 changes: 0 additions & 2 deletions articles/toc.yml

This file was deleted.

26 changes: 5 additions & 21 deletions docfx.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,40 +3,24 @@
"content": [
{
"files": [
"api/**.yml"
]
},
{
"files": [
"articles/**.md",
"articles/**/toc.yml",
"toc.yml",
"*.md"
]
},
{
"files": [
"apiconcepts/**.md",
"apiconcepts/toc.yml"
"index.md"
]
}
],
"resource": [
{
"files": [
"**/images/**",
"**/*.json",
"**/*.html",
"**/*.js",
"**/*.css"
"docs/*.json",
"docs/*.html",
"docs/*.js",
"docs/*.css"
]
}
],
"overwrite": [
{
"files": [
"api/**.md"
],
"exclude": [
"obj/**",
"_site/**"
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
19 changes: 13 additions & 6 deletions index.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,16 @@
# Access the XPP APIs
# XPP RESTful Web Services

## [Learn more about XPP APIs](apiconcepts/overview.md)
Learn more about the APIs and what you can achieve with them.
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.

## [Articles](articles/intro.md)
Read articles on how to get more out of XPP.
## Installation

RWS
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.

## API Documentation

The documentation for all API calls is available in **<a href="docs/index.html" target="_BLANK">this human-readable HTML web app</a>** that provides a structured overview of all endpoints, request/response formats, supported parameters, and example payloads.

## OpenAPI Specification

The documentation above is derived from **<a href="docs/xpp-rest.json" target="_BLANK">this JSON file</a>** that conforms to version 3.1 of the **[OpenAPI Specification](https://spec.openapis.org/oas/v3.1.0.html)**.
6 changes: 1 addition & 5 deletions toc.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,2 @@
- name: XPP
href: index.md
- name: Articles
href: articles/
- name: API
href: apiconcepts/
href: index.md