client

package module
v1.0.0-beta.4 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 9, 2020 License: Apache-2.0 Imports: 0 Imported by: 4

README

datadog-api-client-go

codecov

This repository contains a Go API client for the Datadog API. The code is generated using openapi-generator and apigentools.

Layout

This repository contains per-major-version API client packages. Right now, Datadog only has one API version - v1 - so that is the only module present. If/when there is another version of the API, we will add a different package for it. The end goal is to be able to use API clients for different major versions of the API side-by-side.

The Datadog API v1 Client

The client library for Datadog API v1 is located in the api/v1/datadog directory. Import it with

import "github.com/DataDog/datadog-api-client-go/api/v1/datadog"

All the documentation for this package is available through api/v1/datadog/README.md.

Unstable Endpoints

This client includes access to Datadog API endpoints while they are in an unstable state and may undergo breaking changes. An extra configuration step is required to enable these endpoints:

Client(ctx).GetConfig().SetUnstableOperationEnabled("<OperationName>", true)

where <OperationName> is the name of the method used to interact with that endpoint. For example: GetLogsIndex, or UpdateLogsIndex

Contributing

As most of the code in this repository is generated, we will only accept PRs for files that are not modified by our code-generation machinery (changes to the generated files would get overwritten). We happily accept contributions to files that are not autogenerated, such as tests and development tooling.

Documentation

Index

Constants

View Source
const Version = "1.0.0-beta.4"

Version used in User-Agent header.

Variables

This section is empty.

Functions

This section is empty.

Types

This section is empty.

Directories

Path Synopsis
api

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL