Skip to content

Commit

Permalink
Merge pull request #16 from RWS/SCTCM-3488-Add-OpenAPI-apispec
Browse files Browse the repository at this point in the history
Sctcm 3488 add open api apispec
  • Loading branch information
mpanhuijsen authored Oct 4, 2024
2 parents 2fca8f0 + 464f12d commit f1c8ca5
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 7 deletions.
2 changes: 2 additions & 0 deletions apiconcepts/Tridion_Docs_15.1/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ This section contains information for developers to develop applications on top

You can only use the API classes and functions that are available from this page. Any other API functions are subject to change and not supported externally, so you should not use them.

To directly access the API specification for Tridion Docs OpenAPI, go [here](../api/15.1/index.html)

## PowerShell modules

### [ISHDeploy](https://docs.rws.com/TridionDocs15.1/ISHDeploy/)
Expand Down
16 changes: 9 additions & 7 deletions apiconcepts/Tridion_Docs_15/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,23 @@
## [Content Manager Web Services API](https://docs.rws.com/TridionDocs15/WebServicesAPI) ##
This section contains information for developers to develop applications on top of the Content Manager Web Services API.

Only described API classes and functions are supported and can be used. Do not use any other API function, because they are subject to change.
You can only use the API classes and functions that are available from this page. Any other API functions are subject to change and not supported externally, so you should not use them.

To directly access the API specification for Tridion Docs OpenAPI, go [here](../api/15.0/index.html)

## PowerShell modules

### [ISHDeploy](https://docs.rws.com/TridionDocs15/ISHDeploy/)
ISHDeploy is a PowerShell module that enables the code-as-configuration concept for Tridion Docs, starting from version 13.0.0, up to and including 15.1.0.
ISHDeploy is a PowerShell module that enables the code-as-configuration concept for Tridion Docs, starting from version 13.0.0, up to and including 15.0.0.

### [ISHRemote](https://github.com/RWS/ISHRemote)
ISHRemote is a PowerShell module on top of Tridion Docs Content Manager. Its goal is business automation on top of the Component Content Management System.

### [ISHServer](https://github.com/RWS/ISHServer)
ISHServer is a PowerShell module to help automate installation of prerequisites for Tridion Docs
ISHServer is a PowerShell module to help automate installation of prerequisites for Tridion Docs.

### [ISHBootstrap](https://github.com/RWS/ISHBootstrap)
ISHBootstrap is a bootstrapper for deployments of Tridion Docs Content Manager
ISHBootstrap is a bootstrapper for deployments of Tridion Docs Content Manager.

## Tridion DXA ##
This section is intended for developers wanting to extend DXA functionality using its open-source .NET and Java APIs.
Expand All @@ -32,16 +34,16 @@ Set up a .NET development environment to customize or extend the DXA .NET web ap
Set up a Java development environment to customize or extend the DXA Java web application.

[Using RWS's public APIs](https://docs.rws.com/784837/679912/sdl-digital-experience-accelerator-2-2/using-sdl-s-public-apis)
Use the available public APIs to extend and customize the behavior DXA.
Use the available public APIs to extend and customize the behavior of DXA.

[Creating the folder structure for a custom module](https://docs.rws.com/784837/651695/sdl-digital-experience-accelerator-2-2/creating-the-folder-structure-for-a-custom-module)
A custom module implements a distinct piece of functionality that is only relevant to some implementations. When you want to add a module to RWS Digital Experience Accelerator, you need to create a folder structure in Content Manager.
A custom module implements a distinct piece of functionality that is only relevant to some implementations. When you want to add a module to DXA, you need to create a folder structure in Content Manager.

[Model mapping and semantics](https://docs.rws.com/784837/695734/sdl-digital-experience-accelerator-2-2/model-mapping-and-semantics)
Domain (Content Manager) Models are mapped to the Presentation (View) Models using Model Semantics so that web developers can work with data structures optimized for the Views they are creating without having to have a deep understanding of the underlying content model.

### API reference documentation downloads ###
Links to download the API reference documentation for RWS Digital Experience Accelerator.
Links to download the API reference documentation for DXA.
- [DXA API for .NET](https://docs.sdl.com/DXA/DotNET/2.2/APIDOC/)
- [DXA API for Java](https://docs.sdl.com/DXA/Java/2.2/APIDOC/)
- [Content Delivery's Public Content API](https://docs.rws.com/TridionDocs15/PublicContentAPIReference)

0 comments on commit f1c8ca5

Please sign in to comment.