ExceptionSDK 1.0.0

Getting Started with Copilot Exception Handling Test API

Introduction

Spec designed to test code-sample exception handling and response-schema selection. Includes 400/401/etc. errors and schemas covering string/int/boolean/object/array/map/json/oneOf/anyOf/allOf/null.

Install the Package

If you are building with .NET CLI tools then you can also use the following command:

dotnet add package ExceptionSDK --version 1.0.0

You can also view the package at: https://www.nuget.org/packages/ExceptionSDK/1.0.0

Initialize the API Client

Note: Documentation for the client can be found here.

The following parameters are configurable for the API Client:

The API client can be initialized as follows:

Code-Based Initialization

using CopilotExceptionHandlingTestApi.Standard;
using CopilotExceptionHandlingTestApi.Standard.Authentication;
using Microsoft.Extensions.Logging;

namespace ConsoleApp;

CopilotExceptionHandlingTestApiClient client = new CopilotExceptionHandlingTestApiClient.Builder()
    .BearerAuthCredentials(
        new BearerAuthModel.Builder(
            "AccessToken"
        )
        .Build())
    .LoggingConfig(config => config
        .LogLevel(LogLevel.Information)
        .RequestConfig(reqConfig => reqConfig.Body(true))
        .ResponseConfig(respConfig => respConfig.Headers(true))
    )
    .Build();

Configuration-Based Initialization

using CopilotExceptionHandlingTestApi.Standard;
using Microsoft.Extensions.Configuration;

namespace ConsoleApp;

// Build the IConfiguration using .NET conventions (JSON, environment, etc.)
var configuration = new ConfigurationBuilder()
    .AddJsonFile("config.json")
    .AddEnvironmentVariables() // [optional] read environment variables
    .Build();

// Instantiate your SDK and configure it from IConfiguration
var client = CopilotExceptionHandlingTestApiClient
    .FromConfiguration(configuration.GetSection("CopilotExceptionHandlingTestApi"));

See the Configuration-Based Initialization section for details.

Authorization

This API uses the following authentication schemes.

• bearerAuth (OAuth 2 Bearer token)

List of APIs

• Users
• Orders
• Auth
• Reports

SDK Infrastructure

Configuration

• Configuration-Based Initialization
• HttpClientConfiguration
• HttpClientConfigurationBuilder
• LogBuilder
• LogRequestBuilder
• LogResponseBuilder
• ProxyConfigurationBuilder

HTTP

• HttpCallback
• HttpContext
• HttpRequest
• HttpResponse
• HttpStringResponse

Utilities

• ApiException
• ApiResponse
• ApiHelper
• CustomDateTimeConverter
• UnixDateTimeConverter