mirror of https://github.com/hashicorp/boundary
Consolidate client/API information to a new section (#630)
parent
837e9eb0cc
commit
e162f9f183
@ -1,14 +1,14 @@
|
||||
---
|
||||
layout: docs
|
||||
page_title: HTTP API Standards
|
||||
sidebar_title: HTTP API Standards
|
||||
page_title: API
|
||||
sidebar_title: API
|
||||
description: |-
|
||||
Boundary's HTTP API standards
|
||||
---
|
||||
|
||||
# HTTP API Standards
|
||||
# API
|
||||
|
||||
Boundary's HTTP API adheres to a set of standards that are rigidly followed. At its core, it is a standards-compliant JSON API for both input and output.
|
||||
Boundary's API is a a JSON-based HTTP API that adheres to a set of standards that are rigidly followed. At its core, it is a standards-compliant JSON API for both input and output.
|
||||
|
||||
Before reading this page, it is useful to understand Boundary's [domain model](/docs/concetps/domain-model) to be aware of the terminology used here.
|
||||
|
||||
@ -0,0 +1,14 @@
|
||||
---
|
||||
layout: docs
|
||||
page_title: API/Clients
|
||||
sidebar_title: API/Clients
|
||||
description: |-
|
||||
An introduction to Boundary's API and clients.
|
||||
---
|
||||
|
||||
|
||||
# Clients
|
||||
|
||||
Boundary is a purely-API-driven system. This section contains information
|
||||
describing its API norms and the clients that HashiCorp provide (apart from the
|
||||
web UI), which include a CLI and a Go SDK.
|
||||
@ -1,12 +0,0 @@
|
||||
---
|
||||
layout: docs
|
||||
page_title: API
|
||||
sidebar_title: API
|
||||
description: |-
|
||||
An introduction to Boundary's API.
|
||||
---
|
||||
|
||||
# Boundary API
|
||||
|
||||
This section covers our API, including information about its underlying model
|
||||
and how the CLI implements support for the API.
|
||||
@ -1,19 +0,0 @@
|
||||
---
|
||||
layout: docs
|
||||
page_title: SDK
|
||||
sidebar_title: SDK
|
||||
description: |-
|
||||
Reference documentation for the Boundary SDK
|
||||
---
|
||||
|
||||
# Overview
|
||||
|
||||
The Boundary SDK is written in Go and the reference documentation here assumes basic Go experience including a local
|
||||
environment for developing Go code bases.
|
||||
|
||||
## Getting Started
|
||||
|
||||
Download the latest `main` branch revision of our [project on GitHub](https://github.com/hashicorp/boundary).
|
||||
|
||||
As a developer, the most common package within this project that you'll interact is our [API package](https://github.com/hashicorp/boundary/tree/main/api).
|
||||
This package contains all the common client libraries that you'll need to interact with the Boundary platform.
|
||||
Loading…
Reference in new issue