Skip to content

Commit

Permalink
Update README.md (#112)
Browse files Browse the repository at this point in the history
Modernize the readme a bit

Signed-off-by: Henrik Areskoug <67931019+hareskoug@users.noreply.github.com>
  • Loading branch information
hareskoug authored Sep 20, 2024
1 parent d411a53 commit 9d4fc5c
Showing 1 changed file with 8 additions and 3 deletions.
11 changes: 8 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,17 @@
## Overview
Visier, Inc. publishes the [OpenAPI v3](https://spec.openapis.org/oas/latest.html) definitions of a growing list of its public APIs to ease the development of client applications against the Visier platform. OpenAPI v3 is a language-agnostic definition, enabling (among other things) the programmatic generation of client-level interface wrappers that substantially reduce the amount of code that has to otherwise be written manually in libraries or directly in applications.

Presently, OpenAPI v3 definitions are available of Visier's Authentication APIs as well as Query and Data Model APIs.
Visier's Public APIs are classified according to:
* **Administration** - APIs to perform administrative tasks such as managing permissions.
* **Authentication** - Get secure access to the Visier platform.
* **Data-In** - APIs for loading data and monitoring jobs.
* **Data-Out** - Query and data extraction APIs.
* **Modeling** - Query the Visier catalog for object metadata.

## Usage
At present time, only the OpenAPI v3 definitions are published; at present time, Visier does not publish additional libraries and samples that are geared towards a particular kind of wrapper.
Visier usese these definitions to generate end-user content like reference documentation as well as SDKs (currently Python is available).

Developers are required to generate the API wrappers using a tool of their choice and then write their application to make Visier public API calls using these wrappers.
Developers using other languages are encouraged to generate the API wrappers using a tool of their choice and then write their application to make Visier public API calls using these wrappers.

OpenAPI v3 client-wrappers can be generated using freely available tools as well as using commercially supported options.

Expand Down

0 comments on commit 9d4fc5c

Please sign in to comment.