Component Links

Demonstrates how to define reusable link components to describe relationships between operations.

Note: This feature is currently not yet implemented in Kestrun. The example below is a placeholder for future support.

Full source

File: pwsh/tutorial/examples/10.10-OpenAPI-Component-Link.ps1

<#
    Sample: OpenAPI Link Components
    Purpose: Demonstrate reusable request header components with multiple content types.
    File:    10.10-OpenAPI-Component-Link.ps1
    Notes:   Shows class inheritance, component wrapping, and content type negotiation.
#>

throw "This example is not yet implemented."

Step-by-step

  1. Not Implemented: This feature is planned for a future release.
  2. Concept: Links allow describing how the output of one operation can be used as input for another (e.g., createUser returns an ID used in getUser).

Try it

This example cannot be executed yet.

Troubleshooting

Issue: Feature not implemented.

  • Status: This feature is planned for a future release of Kestrun.
  • Workaround: Document operation relationships in your API guide or README. Use external documentation links with Add-KrOpenApiExternalDoc to point to guides explaining operation dependencies.

References

Previous / Next

Previous: Component Headers Next: Component Callbacks