Skip to content

Commit

Permalink
Cleanup Readmes
Browse files Browse the repository at this point in the history
  • Loading branch information
Andrew Omondi committed Jul 5, 2024
1 parent 8283df1 commit 9ada694
Show file tree
Hide file tree
Showing 9 changed files with 15 additions and 25 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/sonarcloud.yml
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ jobs:
CoverletOutputFormat: "opencover" # https://github.com/microsoft/vstest/issues/4014#issuecomment-1307913682
shell: pwsh
run: |
dotnet tool run dotnet-sonarscanner begin /k:"microsoft_kiota-abstractions-dotnet" /o:"microsoft" /d:sonar.token="${{ secrets.SONAR_TOKEN }}" /d:sonar.host.url="https://sonarcloud.io" /d:sonar.cs.opencover.reportsPaths="tests\abstractions\coverage.net8.0.opencover.xml,tests\authentication\azure\coverage.net8.0.opencover.xml,tests\http\httpClient\coverage.net8.0.opencover.xml,tests\serialization\json\coverage.net8.0.opencover.xml,tests\serialization\text\coverage.net8.0.opencover.xml,tests\serialization\form\coverage.net8.0.opencover.xml,tests\serialization\multipart\coverage.net8.0.opencover.xml,"
dotnet tool run dotnet-sonarscanner begin /k:"microsoft_kiota-abstractions-dotnet" /o:"microsoft" /d:sonar.token="${{ secrets.SONAR_TOKEN }}" /d:sonar.host.url="https://sonarcloud.io" /d:sonar.cs.opencover.reportsPaths="tests/abstractions/coverage.net8.0.opencover.xml,tests/authentication/azure/coverage.net8.0.opencover.xml,tests/http/httpClient/coverage.net8.0.opencover.xml,tests/serialization/json/coverage.net8.0.opencover.xml,tests/serialization/text/coverage.net8.0.opencover.xml,tests/serialization/form/coverage.net8.0.opencover.xml,tests/serialization/multipart/coverage.net8.0.opencover.xml"
dotnet workload restore
dotnet build
dotnet test Microsoft.Kiota.sln --no-build --verbosity normal /p:CollectCoverage=true /p:CoverletOutputFormat=opencover --framework net8.0
Expand Down
24 changes: 14 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,28 @@
# Kiota Libraries for dotnet

The Kiota abstractions Library for dotnet is the dotnet library defining the basic constructs Kiota projects need once an SDK has been generated from an OpenAPI definition.
[![Build, Test, CodeQl](https://github.com/microsoft/kiota-abstractions-dotnet/actions/workflows/build-and-test.yml/badge.svg?branch=main)](https://github.com/microsoft/kiota-abstractions-dotnet/actions/workflows/build-and-test.yml)

A [Kiota](https://github.com/microsoft/kiota) generated project will need a reference to the abstraction package to build and run.
The Kiota abstractions libraries define the basic constructs Kiota projects need once an SDK has been generated from an OpenAPI definition.

A [Kiota](https://github.com/microsoft/kiota) generated project will need a reference to the libraries to build and run by providing default implementations for serialization and http transport.

Read more about Kiota [here](https://github.com/microsoft/kiota/blob/main/README.md).

## Libraries

1. [Abstractions](./src/abstractions/README.md)
1. [Authentication - Azure](./src/authentication/azure/README.md)
1. [Http - HttpClient](./src/http/httpClient/README.md)
1. [Serialization - JSON](./src/serialization/json/README.md)
1. [Serialization - FORM](./src/serialization/form/README.md)
1. [Serialization - TEXT](./src/serialization/text/README.md)
1. [Serialization - MULTIPART](./src/serialization/multipart/README.md)
| Library | Nuget Release |
| ------ | ------ |
| [Abstractions](./src/abstractions/README.md) | [![NuGet Version](https://buildstats.info/nuget/Microsoft.Kiota.Abstractions?includePreReleases=true)](https://www.nuget.org/packages/Microsoft.Kiota.Abstractions/) |
| [Authentication - Azure](./src/authentication/azure/README.md) | [![NuGet Version](https://buildstats.info/nuget/Microsoft.Kiota.Authentication.Azure?includePreReleases=true)](https://www.nuget.org/packages/Microsoft.Kiota.Authentication.Azure/) |
| [Http - HttpClientLibrary](./src/http/httpClient/README.md) | [![NuGet Version](https://buildstats.info/nuget/Microsoft.Kiota.Http.HttpClientLibrary?includePreReleases=true)](https://www.nuget.org/packages/Microsoft.Kiota.Http.HttpClientLibrary/) |
| [Serialization - JSON](./src/serialization/json/README.md) | [![NuGet Version](https://buildstats.info/nuget/Microsoft.Kiota.Serialization.Json?includePreReleases=true)](https://www.nuget.org/packages/Microsoft.Kiota.Serialization.Json/) |
| [Serialization - FORM](./src/serialization/form/README.md) | [![NuGet Version](https://buildstats.info/nuget/Microsoft.Kiota.Serialization.Form?includePreReleases=true)](https://www.nuget.org/packages/Microsoft.Kiota.Serialization.Form/) |
| [Serialization - TEXT](./src/serialization/text/README.md) | [![NuGet Version](https://buildstats.info/nuget/Microsoft.Kiota.Serialization.Text?includePreReleases=true)](https://www.nuget.org/packages/Microsoft.Kiota.Serialization.Text/) |
| [Serialization - MULTIPART](./src/serialization/multipart/README.md) | [![NuGet Version](https://buildstats.info/nuget/Microsoft.Kiota.Serialization.Multipart?includePreReleases=true)](https://www.nuget.org/packages/Microsoft.Kiota.Serialization.Multipart/) |

## Debugging

If you are using Visual Studio Code as your IDE, the **launch.json** file already contains the configuration to build and test the library. Otherwise, you can open the **Microsoft.Kiota.Abstractions.sln** with Visual Studio.
If you are using Visual Studio Code as your IDE, the **launch.json** file already contains the configuration to build and test the library. Otherwise, you can open the **Microsoft.Kiota.sln** with Visual Studio.

## Contributing

Expand Down
2 changes: 0 additions & 2 deletions src/abstractions/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# Kiota Abstractions Library for dotnet

[![Build, Test, CodeQl](https://github.com/microsoft/kiota-abstractions-dotnet/actions/workflows/build-and-test.yml/badge.svg?branch=main)](https://github.com/microsoft/kiota-abstractions-dotnet/actions/workflows/build-and-test.yml) [![NuGet Version](https://buildstats.info/nuget/Microsoft.Kiota.Abstractions?includePreReleases=true)](https://www.nuget.org/packages/Microsoft.Kiota.Abstractions/)

The Kiota abstractions Library for dotnet is the dotnet library defining the basic constructs Kiota projects need once an SDK has been generated from an OpenAPI definition.

A [Kiota](https://github.com/microsoft/kiota) generated project will need a reference to the abstraction package to build and run.
Expand Down
2 changes: 0 additions & 2 deletions src/authentication/azure/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# Kiota Azure Identity authentication provider library for dotnet

[![Build and Test](https://github.com/microsoft/kiota-authentication-azure-dotnet/actions/workflows/build-and-test.yml/badge.svg?branch=main)](https://github.com/microsoft/kiota-authentication-azure-dotnet/actions/workflows/build-and-test.yml) [![NuGet Version](https://buildstats.info/nuget/Microsoft.Kiota.Authentication.Azure?includePreReleases=true)](https://www.nuget.org/packages/Microsoft.Kiota.Authentication.Azure/)

The Kiota Azure Identity authentication provider library for dotnet is the authentication provider implementation with [Azure.Identity](https://docs.microsoft.com/en-us/dotnet/api/overview/azure/identity-readme).

A [Kiota](https://github.com/microsoft/kiota) generated project will need a reference to a authentication provider library to authenticate HTTP requests to an API endpoint.
Expand Down
2 changes: 0 additions & 2 deletions src/http/httpClient/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# Kiota Http Library for dotnet

[![Build and Test](https://github.com/microsoft/kiota-http-dotnet/actions/workflows/build-and_test.yml/badge.svg?branch=main)](https://github.com/microsoft/kiota-http-dotnet/actions/workflows/build-and_test.yml) [![NuGet Version](https://buildstats.info/nuget/Microsoft.Kiota.Http.HttpClientLibrary?includePreReleases=true)](https://www.nuget.org/packages/Microsoft.Kiota.Http.HttpClientLibrary/)

The Kiota HTTP Library for dotnet is the dotnet HTTP library implementation with [HttpClient](https://docs.microsoft.com/en-us/dotnet/api/system.net.http.httpclient?view=net-6.0).

A [Kiota](https://github.com/microsoft/kiota) generated project will need a reference to a HTTP package to make HTTP requests to an API endpoint.
Expand Down
2 changes: 0 additions & 2 deletions src/serialization/form/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# Kiota URI Form Encoded Serialization Library for dotnet

[![Build and Test](https://github.com/microsoft/kiota-serialization-form-dotnet/actions/workflows/build-and_test.yml/badge.svg?branch=main)](https://github.com/microsoft/kiota-serialization-form-dotnet/actions/workflows/build-and_test.yml) [![NuGet Version](https://buildstats.info/nuget/Microsoft.Kiota.Serialization.Form?includePreReleases=true)](https://www.nuget.org/packages/Microsoft.Kiota.Serialization.Form/)

The Form Serialization Library for dotnet is the dotnet `application/x-www-form-urlencoded` serialization library implementation.

A [Kiota](https://github.com/microsoft/kiota) generated project will need a reference to a form serialization package to handle `application/x-www-form-urlencoded` payloads from a supporting API endpoint.
Expand Down
2 changes: 0 additions & 2 deletions src/serialization/json/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# Kiota Json Serialization Library for dotnet

[![Build and Test](https://github.com/microsoft/kiota-serialization-json-dotnet/actions/workflows/build-and_test.yml/badge.svg?branch=main)](https://github.com/microsoft/kiota-serialization-json-dotnet/actions/workflows/build-and_test.yml) [![NuGet Version](https://buildstats.info/nuget/Microsoft.Kiota.Serialization.Json?includePreReleases=true)](https://www.nuget.org/packages/Microsoft.Kiota.Serialization.Json/)

The Json Serialization Library for dotnet is the dotnet JSON serialization library implementation with System.Text.Json

A [Kiota](https://github.com/microsoft/kiota) generated project will need a reference to a json serialization package to handle json payloads from an API endpoint.
Expand Down
2 changes: 0 additions & 2 deletions src/serialization/multipart/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# Kiota Multipart Serialization Library for dotnet

[![Build and Test](https://github.com/microsoft/kiota-serialization-multipart-dotnet/actions/workflows/build-and_test.yml/badge.svg?branch=main)](https://github.com/microsoft/kiota-serialization-multipart-dotnet/actions/workflows/build-and_test.yml) [![NuGet Version](https://buildstats.info/nuget/Microsoft.Kiota.Serialization.Multipart?includePreReleases=true)](https://www.nuget.org/packages/Microsoft.Kiota.Serialization.Multipart/)

The Multipart Serialization Library for dotnet is the dotnet Multipart serialization library implementation.

A [Kiota](https://github.com/microsoft/kiota) generated project will need a reference to a multipart serialization package to handle multipart payloads from an API endpoint.
Expand Down
2 changes: 0 additions & 2 deletions src/serialization/text/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# Kiota Text Serialization Library for dotnet

[![Build and Test](https://github.com/microsoft/kiota-serialization-text-dotnet/actions/workflows/build-and_test.yml/badge.svg?branch=main)](https://github.com/microsoft/kiota-serialization-text-dotnet/actions/workflows/build-and_test.yml) [![NuGet Version](https://buildstats.info/nuget/Microsoft.Kiota.Serialization.Text?includePreReleases=true)](https://www.nuget.org/packages/Microsoft.Kiota.Serialization.Text/)

The Text Serialization Library for dotnet is the dotnet Text serialization library implementation to handle text/plain responses.

A [Kiota](https://github.com/microsoft/kiota) generated project will need a reference to a Text serialization package to handle text/plain payloads from an API endpoint.
Expand Down

0 comments on commit 9ada694

Please sign in to comment.