#2219 Documentation supporting .NET 8-9 (#2258)

* #2217 Answer to How can I configure Ocelot programmatically?

* Update README.md

* Review license and readme.
Check new signing GPG key

* Docs config & Update Introduction docs

* Disable BddfyConfig

* Update README.md

Keep images in the assets branch and read them from raw.githubusercontent.com

* Delete images directory

All images should be located in the ASSETS branch

* Update workflows

* Disable icon embedding

* Update features A-C

* Update Configuration feature doc:
Add schemas
Add Overview section
Organize sections

* Configuration feature doc

* remove namespace

* Delegating Handlers feature

* Dependency Injection feature

* Features E-K

* Load Balancer feature

* Logging feature vs Error Handling one

* Add Metadata sample

* Metadata sample: JSON responder.
Serialize route metadata JSON to HTTP response body

* Metadata sample: Rename to MetadataResponder

* Metadata sample: Test gzip & deflate encodings.
Add OC-Route-Metadata header

* Metadata sample: DONE

* Update metadata.rst

* Metadata feature (complete doc)

* Method Transformation feature

* Review Kubernetes doc after rebasing

* Middleware Injection feature

* Quality of Service feature

* Rate Limiting feature

* Update requestaggregation.rst: Rename to aggregation.rst

* Aggregation feature

* Request ID feature

* Merge Request ID doc into Logging one

* Routing feature

* Service Discovery feature

* Service Fabric feature

* Tracing doc looks good!

* Websockets doc looks good too!

* Update Building Ocelot docs.
Move content of building.rst and tests.rst to overview.rst.
Remove [building.rst, tests.rst] from index

Author: raman-m

.github/workflows/develop.yml

@@ -1,8 +1,6 @@
 # This workflow will build a .NET project
 # For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-net
-
-name: develop
-
+name: Develop
 on:
  push:
    branches: [ "develop" ]
@@ -15,19 +13,20 @@ jobs:
         dotnet-version: [ '8.0', '9.0' ]
 
     steps:
-    - uses: actions/checkout@v4
+    - name: Checkout
+      uses: actions/checkout@v4
     - name: Setup .NET ${{ matrix.dotnet-version }}
       uses: actions/setup-dotnet@v3
       with:
         dotnet-version: ${{ matrix.dotnet-version }}.x
-#    - name: Display dotnet version
-#      run: dotnet --version
+#- name: Display dotnet version
+#  run: dotnet --version
     - name: Restore
       run: dotnet restore ./Ocelot.sln -p:TargetFramework=net${{ matrix.dotnet-version }}
     - name: Build
       run: dotnet build --no-restore ./Ocelot.sln --framework net${{ matrix.dotnet-version }}
-#    - name: Test
-#      run: dotnet test --no-build --verbosity normal ./Ocelot.sln --framework net${{ matrix.dotnet-version }}
+#- name: Test
+#  run: dotnet test --no-build --verbosity normal ./Ocelot.sln --framework net${{ matrix.dotnet-version }}
     - name: Unit Tests
       run: dotnet test --no-restore --no-build --verbosity minimal --framework net${{ matrix.dotnet-version }} ./test/Ocelot.UnitTests/Ocelot.UnitTests.csproj
     - name: Integration Tests

.github/workflows/pr.yml

@@ -1,19 +1,15 @@
 # This workflow will build a .NET project
 # For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-net
-
 name: PR
-
 on: pull_request
-    # branches-ignore:
-    #   - main
-    #   - develop
 
 jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v4
-    - name: Setup .NET 9.0
+    - name: Checkout
+      uses: actions/checkout@v4
+    - name: Setup .NET 9
       uses: actions/setup-dotnet@v3
       with:
         dotnet-version: 9.0.x

LICENSE.md

@@ -1,5 +1,5 @@
 The MIT License (MIT)
-Copyright (c) 2024 Tom Pallister, Raman Maksimchuk and GitHub Ocelot community.
+Copyright © 2016-2025 Tom Gardham-Pallister, Raman Maksimchuk and contributors.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

Ocelot.Release.sln

@@ -82,6 +82,8 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Ocelot.Samples.ServiceFabri
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Ocelot.Samples.Web", "samples\Web\Ocelot.Samples.Web.csproj", "{1A00E87D-2B0B-4D61-A606-3D747C1E43F8}"
 EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Ocelot.Samples.Metadata", "samples\Metadata\Ocelot.Samples.Metadata.csproj", "{8A48F777-89D7-B17F-F352-CF57E49E5EF5}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -322,6 +324,14 @@ Global
 		{1A00E87D-2B0B-4D61-A606-3D747C1E43F8}.Release|Any CPU.Build.0 = Release|Any CPU
 		{1A00E87D-2B0B-4D61-A606-3D747C1E43F8}.Release|x64.ActiveCfg = Release|Any CPU
 		{1A00E87D-2B0B-4D61-A606-3D747C1E43F8}.Release|x64.Build.0 = Release|Any CPU
+		{8A48F777-89D7-B17F-F352-CF57E49E5EF5}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{8A48F777-89D7-B17F-F352-CF57E49E5EF5}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{8A48F777-89D7-B17F-F352-CF57E49E5EF5}.Debug|x64.ActiveCfg = Debug|Any CPU
+		{8A48F777-89D7-B17F-F352-CF57E49E5EF5}.Debug|x64.Build.0 = Debug|Any CPU
+		{8A48F777-89D7-B17F-F352-CF57E49E5EF5}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{8A48F777-89D7-B17F-F352-CF57E49E5EF5}.Release|Any CPU.Build.0 = Release|Any CPU
+		{8A48F777-89D7-B17F-F352-CF57E49E5EF5}.Release|x64.ActiveCfg = Release|Any CPU
+		{8A48F777-89D7-B17F-F352-CF57E49E5EF5}.Release|x64.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
@@ -356,6 +366,7 @@ Global
 		{D991C694-01F0-4F04-8135-5C133DC8E029} = {8FA0CBA0-0338-48EB-B37F-83CA5022237C}
 		{AD09D124-7DD7-4C9E-9BCC-782B579B1786} = {8FA0CBA0-0338-48EB-B37F-83CA5022237C}
 		{1A00E87D-2B0B-4D61-A606-3D747C1E43F8} = {8FA0CBA0-0338-48EB-B37F-83CA5022237C}
+		{8A48F777-89D7-B17F-F352-CF57E49E5EF5} = {8FA0CBA0-0338-48EB-B37F-83CA5022237C}
 	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution
 		SolutionGuid = {21476EFF-778A-4F97-8A56-D1AF1CEC0C48}

README.md

@@ -1,29 +1,30 @@
-![Ocelot Logo](/images/ocelot_logo.png)
+![Ocelot Logo](https://raw.githubusercontent.com/ThreeMammals/Ocelot/refs/heads/assets/images/ocelot_logo.png)
 
-[![.NET](https://github.com/ThreeMammals/Ocelot/actions/workflows/develop.yml/badge.svg)](https://github.com/ThreeMammals/Ocelot/actions/workflows/develop.yml)
-
-<!-- [![Coverage Status](https://coveralls.io/repos/github/ThreeMammals/Ocelot/badge.svg)](https://coveralls.io/github/ThreeMammals/Ocelot) -->
+[![develop](https://github.com/ThreeMammals/Ocelot/actions/workflows/develop.yml/badge.svg)](https://github.com/ThreeMammals/Ocelot/actions/workflows/develop.yml)
+[![ReadTheDocs](https://readthedocs.org/projects/ocelot/badge/?version=latest&style=flat-default)](https://app.readthedocs.org/projects/ocelot/builds/?version__slug=latest)
+[![Coveralls](https://coveralls.io/repos/github/ThreeMammals/Ocelot/badge.svg)](https://coveralls.io/github/ThreeMammals/Ocelot)
 
 ## About
+Ocelot is a .NET [API gateway](https://www.bing.com/search?q=API+gateway).
+This project is aimed at people using .NET running a microservices (service-oriented) architecture that needs a unified point of entry into their system.
+However, it will work with anything that speaks HTTP(S) and runs on any platform that [ASP.NET Core](https://learn.microsoft.com/en-us/aspnet/core/) supports.
 
-Ocelot is a .NET API Gateway. This project is aimed at people using .NET running a microservices / service-oriented architecture 
-that need a unified point of entry into their system. However it will work with anything that speaks HTTP(S) and run on any platform that ASP.NET Core supports.
-
+<!--
 In particular we want easy integration with [IdentityServer](https://github.com/IdentityServer) reference and [Bearer](https://oauth.net/2/bearer-tokens/) tokens. 
 We have been unable to find this in our current workplace without having to write our own Javascript middlewares to handle the IdentityServer reference tokens.
 We would rather use the IdentityServer code that already exists to do this.
+-->
 
-Ocelot is a bunch of middlewares in a specific order.
+Ocelot consists of a series of ASP.NET Core [middlewares](https://learn.microsoft.com/en-us/aspnet/core/fundamentals/middleware/) arranged in a specific order.
 
-Ocelot manipulates the `HttpRequest` object into a state specified by its configuration until it reaches a request builder middleware, where it creates a `HttpRequestMessage` object which is used to make a request to a downstream service.
+Ocelot [custom middlewares](https://learn.microsoft.com/en-us/aspnet/core/fundamentals/middleware/write) manipulate the `HttpRequest` object into a state specified by its configuration until it reaches a request builder middleware, where it creates a `HttpRequestMessage` object, which is used to make a request to a downstream service.
 The middleware that makes the request is the last thing in the Ocelot pipeline. It does not call the next middleware.
-The response from the downstream service is retrieved as the requests goes back up the Ocelot pipeline.
-There is a piece of middleware that maps the `HttpResponseMessage` onto the `HttpResponse` object and that is returned to the client.
-That is basically it with a bunch of other features!
+The response from the downstream service is retrieved as the request goes back up the Ocelot pipeline.
+There is a piece of middleware that maps the `HttpResponseMessage` onto the `HttpResponse` object, and that is returned to the client.
+That is basically it, with a bunch of other features!
 
 ## Features
-
-A quick list of Ocelot's capabilities, for more information see the [Documentation](#documentation).
+A concise list of Ocelot's capabilities, for further details refer to [Documentation](#documentation)
 
 * [Routing](https://ocelot.readthedocs.io/en/latest/features/routing.html)
 * [Request Aggregation](https://ocelot.readthedocs.io/en/latest/features/requestaggregation.html)
@@ -45,46 +46,44 @@ A quick list of Ocelot's capabilities, for more information see the [Documentati
 * [Platform](https://ocelot.readthedocs.io/en/latest/building/building.html?highlight=Platform#building) & Cloud Agnostic [Building](https://ocelot.readthedocs.io/en/latest/building/building.html)
 
 ## Install
+Ocelot is designed to work with [ASP.NET Core](https://learn.microsoft.com/en-us/aspnet/core/) and it targets `net8.0` [LTS](https://dotnet.microsoft.com/en-us/platform/support/policy/dotnet-core#release-types) and `net9.0` [STS](https://dotnet.microsoft.com/en-us/platform/support/policy/dotnet-core#release-types) target framework monikers ([TFMs](https://learn.microsoft.com/en-us/dotnet/standard/frameworks#supported-target-frameworks)). [^4]
 
-Ocelot is designed to work with ASP.NET Core and it targets `net6.0`, `net7.0` and `net8.0` frameworks. [^4]
-
-Install [Ocelot package](https://www.nuget.org/packages/Ocelot) and its dependencies using NuGet Package Manager:
+Install [Ocelot](https://www.nuget.org/packages/Ocelot) package and its dependencies using NuGet package manager:
 ```powershell
 Install-Package Ocelot
 ```
 Or via the .NET CLI:
 ```shell
 dotnet add package Ocelot
 ```
-All versions can be found [on nuget](https://www.nuget.org/packages/Ocelot#versions-body-tab).
+All versions are available [on NuGet](https://www.nuget.org/packages/Ocelot#versions-body-tab).
 
 ## Documentation
-- [Ocelot documentation — Read the Docs](https://ocelot.readthedocs.io)
-  <br/>This includes lots of information and will be helpful if you want to understand the features Ocelot currently offers.
-- [Ocelot RST Docs](https://github.com/ThreeMammals/Ocelot/tree/develop/docs)
-  <br/>This includes source code of documentation as **.rst** files which are up to date for current development.
-- [Ask Ocelot Guru](https://gurubase.io/g/ocelot)
-  <br/>It's a Ocelot-focused AI to answer your questions.
+- [RST-sources](https://github.com/ThreeMammals/Ocelot/tree/develop/docs):
+  This includes the source code of the documentation as **.rst**-files, which are up to date for current development.
+- [Read the Docs](https://ocelot.readthedocs.io):
+  This includes a lot of information and will be helpful if you want to understand the features Ocelot currently offers.
+- [Ask Ocelot Guru](https://gurubase.io/g/ocelot):
+  It is an Ocelot-focused AI designed to answer your questions. [^5]
 
 ## Coming up
-You can see what we are working on in [backlog](https://github.com/ThreeMammals/Ocelot/issues).
+You can see what we are working on in the [backlog](https://github.com/ThreeMammals/Ocelot/issues).
 
 ## Contributing
+We love to receive contributions from the community, so please keep them coming.
+Pull requests, issues, and commentary welcome! <img src="https://raw.githubusercontent.com/ThreeMammals/Ocelot/refs/heads/assets/images/octocat.png" alt="octocat" height="20">
 
-We love to receive contributions from the community, so please keep them coming :octocat: 
-<br/>Pull requests, issues and commentary welcome!
-
-Please complete the relevant [template](https://github.com/ThreeMammals/Ocelot/tree/main/.github) for [issues](https://github.com/ThreeMammals/Ocelot/blob/main/.github/ISSUE_TEMPLATE.md) and [PRs](https://github.com/ThreeMammals/Ocelot/blob/main/.github/PULL_REQUEST_TEMPLATE.md).
+Please complete the relevant [template](https://github.com/ThreeMammals/Ocelot/tree/main/.github) for [issues](https://github.com/ThreeMammals/Ocelot/blob/main/.github/ISSUE_TEMPLATE.md) and [pull requests](https://github.com/ThreeMammals/Ocelot/blob/main/.github/PULL_REQUEST_TEMPLATE.md).
 Sometimes it's worth getting in touch with us to [discuss](https://github.com/ThreeMammals/Ocelot/discussions) changes before doing any work in case this is something we are already doing or it might not make sense.
-We can also give advice on the easiest way to do things :octocat: 
+We can also give advice on the easiest way to do things <img src="https://raw.githubusercontent.com/ThreeMammals/Ocelot/refs/heads/assets/images/octocat.png" alt="octocat" height="20">
 
 Finally, we mark all existing issues as [![label: help wanted][~helpwanted]](https://github.com/ThreeMammals/Ocelot/labels/help%20wanted)
 [![label: small effort][~smalleffort]](https://github.com/ThreeMammals/Ocelot/labels/small%20effort)
 [![label: medium effort][~mediumeffort]](https://github.com/ThreeMammals/Ocelot/labels/medium%20effort)
-[![label: large effort][~largeeffort]](https://github.com/ThreeMammals/Ocelot/labels/large%20effort). [^5]
-<br/>If you want to contribute for the first time, we suggest looking at a [![label: help wanted][~helpwanted]](https://github.com/ThreeMammals/Ocelot/labels/help%20wanted) 
+[![label: large effort][~largeeffort]](https://github.com/ThreeMammals/Ocelot/labels/large%20effort). [^6]
+If you want to contribute for the first time, we suggest looking at a [![label: help wanted][~helpwanted]](https://github.com/ThreeMammals/Ocelot/labels/help%20wanted) 
 [![label: small effort][~smalleffort]](https://github.com/ThreeMammals/Ocelot/labels/small%20effort) 
-[![label: good first issue][~goodfirstissue]](https://github.com/ThreeMammals/Ocelot/labels/good%20first%20issue) :octocat: 
+[![label: good first issue][~goodfirstissue]](https://github.com/ThreeMammals/Ocelot/labels/good%20first%20issue) <img src="https://raw.githubusercontent.com/ThreeMammals/Ocelot/refs/heads/assets/images/octocat.png" alt="octocat" height="20">
 
 [~helpwanted]: https://img.shields.io/badge/-help%20wanted-128A0C.svg
 [~smalleffort]: https://img.shields.io/badge/-small%20effort-fef2c0.svg
@@ -93,8 +92,9 @@ Finally, we mark all existing issues as [![label: help wanted][~helpwanted]](htt
 [~goodfirstissue]: https://img.shields.io/badge/-good%20first%20issue-ffc4d8.svg
 
 ### Notes
-[^1]: Ocelot doesn’t directly support [GraphQL](https://graphql.org/). Developers can easily integrate the [GraphQL for .NET](/graphql-dotnet/graphql-dotnet) library.
-[^2]: Ocelot does support [Consul](https://www.consul.io/), [Netflix Eureka](https://www.nuget.org/packages/Steeltoe.Discovery.Eureka), [Service Fabric](https://azure.microsoft.com/en-us/products/service-fabric/) service discovery providers, and special modes like [Dynamic Routing](/ThreeMammals/Ocelot/blob/main/docs/features/servicediscovery.rst#dynamic-routing) and [Custom Providers](/ThreeMammals/Ocelot/blob/main/docs/features/servicediscovery.rst#custom-providers).
+[^1]: Ocelot does not directly support [GraphQL](https://graphql.org/). Developers can easily integrate the [GraphQL for .NET](https://github.com/graphql-dotnet/graphql-dotnet) library. 
+[^2]: Ocelot supports [Consul](https://www.consul.io/), [Netflix Eureka](https://www.nuget.org/packages/Steeltoe.Discovery.Eureka), [Service Fabric](https://azure.microsoft.com/en-us/products/service-fabric/) service discovery providers, as well as special modes like [Dynamic Routing](/ThreeMammals/Ocelot/blob/main/docs/features/servicediscovery.rst#dynamic-routing) and [Custom Providers](/ThreeMammals/Ocelot/blob/main/docs/features/servicediscovery.rst#custom-providers).
 [^3]: Retry policies only via [Polly](/App-vNext/Polly) library.
-[^4]: Starting with [v21.0](https://github.com/ThreeMammals/Ocelot/releases/tag/21.0.0), the solution's code base supports [Multitargeting](https://learn.microsoft.com/en-us/visualstudio/msbuild/msbuild-multitargeting-overview) as SDK-style projects. It should be easier for teams to move between (migrate to) .NET 6, 7 and 8 frameworks. Also, new features will be available for all .NET SDKs which we support via multitargeting. Find out more here: [Target frameworks in SDK-style projects](https://learn.microsoft.com/en-us/dotnet/standard/frameworks)
-[^5]: See all [labels](https://github.com/ThreeMammals/Ocelot/issues/labels) of the repository.
+[^4]: Starting with version [21.0](https://github.com/ThreeMammals/Ocelot/releases/tag/21.0.0), the solution's code base supports [Multitargeting](https://learn.microsoft.com/en-us/visualstudio/msbuild/msbuild-multitargeting-overview) as SDK-style projects. It should be easier for teams to migrate to the currently supported [.NET 8 and 9](https://dotnet.microsoft.com/en-us/platform/support/policy/dotnet-core#lifecycle) frameworks. Also, new features will be available for all .NET SDKs that we support via multitargeting. Find out more here: [Target frameworks in SDK-style projects](https://learn.microsoft.com/en-us/dotnet/standard/frameworks)
+[^5]: [Ocelot Guru](https://gurubase.io/g/ocelot) is an unofficial tool to get answers regarding Ocelot: please consider it an advanced search tool. Thus, we have an official [Questions & Answers](https://github.com/ThreeMammals/Ocelot/discussions/categories/q-a) category in the [Discussions](https://github.com/ThreeMammals/Ocelot/discussions) space.
+[^6]: See all [labels](https://github.com/ThreeMammals/Ocelot/issues/labels) for the repository, which are useful for searching and filtering.