OutSystems.Application.ForDocumentation 1.0.1

Prefix Reserved
.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher. 
dotnet add package OutSystems.Application.ForDocumentation --version 1.0.1
                    


                    

                
NuGet\Install-Package OutSystems.Application.ForDocumentation -Version 1.0.1
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="OutSystems.Application.ForDocumentation" Version="1.0.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="OutSystems.Application.ForDocumentation" Version="1.0.1" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="OutSystems.Application.ForDocumentation" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add OutSystems.Application.ForDocumentation --version 1.0.1
                    


                    

                
#r "nuget: OutSystems.Application.ForDocumentation, 1.0.1"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
#:package OutSystems.Application.ForDocumentation@1.0.1
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=OutSystems.Application.ForDocumentation&version=1.0.1
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=OutSystems.Application.ForDocumentation&version=1.0.1
                    


                            Install as a Cake Tool

OutSystems.Application.ForDocumentation

Overview

OutSystems.Application.ForDocumentation is a NuGet package designed to enhance and automate the generation of API documentation for OutSystems applications. The package provides integration points and filters to extend and customize OpenAPI (Swagger) documentation.

This NuGet package enables the use of the -p:ForDoc=true build target, for the OutSystems generated applications, when building.

Features

  • Automatic enrichment of OpenAPI/Swagger docs for OutSystems REST APIs
  • Custom operation filters for request/response data types
  • Support for OutSystems-specific REST attributes (ConsumesRequestType, RestResponseDataType, etc.)
  • Enables dotnet build -p:ForDoc=true for documentation builds

Installation

Install the package via NuGet Package Manager:

Install-Package OutSystems.Application.ForDocumentation

Or via .NET CLI:

dotnet add package OutSystems.Application.ForDocumentation

Usage

To trigger tooling and behaviors specific for documentation purposes, build your project with the following command:

dotnet build -p:ForDoc=true

This will:

  1. Create .config/dotnet-tools.json with the Swashbuckle CLI tool (if it doesn't exist)
  2. Run dotnet tool restore to install the Swagger tool
  3. Generate the Swagger file

You can then run dotnet tool run swagger to validate or serve the OpenAPI documentation without manually installing the tool.

Example

To build the project for documentation:

dotnet build -p:ForDoc=true

License

This project is licensed under the MIT License.

More Information

For more documentation or support, please refer to the official OutSystems documentation.

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
1.0.1 137 3/19/2026