Skip to content

Commit

Permalink
rebase (#180)
Browse files Browse the repository at this point in the history
* Test: cli directory with styled man pages (#157)

* man

* cli commands

* removing dob property

* more cli commands

* more cli

* updates

* more

* more

* Added missing cli commands to the pretty cli doc. The only one that's left (that I know of) is generate-dataset

* resolving merge conflicts

Co-authored-by: douglas fulton <dfulton@ad1.systemadmin.com>
Co-authored-by: Kelly Huang <kelly@ethyca.com>

* Fixing stylesheet so dark mode headers can be a separate color from the default light theme (#177)

Co-authored-by: Adrian Galvan <adrian@ethyca.com>

* Added more extensive help doc to cli.py and options.py. (#175)

* Added more extensive help doc to cli.py and options.py.
* updating CLI docs
* Update options.py
* Update cli.py

black didn't like the whitespace.

Co-authored-by: douglas fulton <dfulton@ad1.systemadmin.com>
Co-authored-by: Kelly Huang <kelly@ethyca.com>

* API CSS (#178)

* Added more extensive help doc to cli.py and options.py.
* updating CLI docs
* Update options.py
* Update cli.py
black didn't like the whitespace.
* api and css
* Update index.md

Co-authored-by: douglas fulton <dfulton@ad1.systemadmin.com>
Co-authored-by: Kelly Huang <kelly@ethyca.com>

* Standardizing css with fidesops

* Update fides-logo.svg

Co-authored-by: douglas fulton <dfulton@ad1.systemadmin.com>
Co-authored-by: Kelly Huang <kelly@ethyca.com>
Co-authored-by: Adrian Galvan <adriang430@gmail.com>
Co-authored-by: Adrian Galvan <adrian@ethyca.com>
Co-authored-by: kelly <85575406+iamkelllly@users.noreply.github.com>
  • Loading branch information
6 people authored Oct 26, 2021
1 parent a452378 commit a6d93e7
Show file tree
Hide file tree
Showing 27 changed files with 4,696 additions and 125 deletions.
36 changes: 31 additions & 5 deletions docs/fides/docs/api/index.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,35 @@
# API Reference
# Fides Control API

You can view the live, interactive [Swagger](https://swagger.io/docs/) API docs for Fidesctl by visiting `/docs` on a running instance. This is a great way to experiment with the APIs using Swagger's built-in "Try it out" functionality.
The `fidesctl` API is exceedingly formulaic, so much so that it's easier to grasp the API by understanding the formula, rather than reading through a list of endpoints. The fundamental idea is that there's a set of five endpoints for each Fides resource. These endpoints let you...

Below, we've embedded the latest release's API documentation as a living reference. These work largely the same, but since this documentation site isn't connected to a live instance, the "Try it out" and "Authorize" buttons won't work, sorry!
| Purpose | Example | Success code |
| --- | --- | --- |
| Create an instance of a particular resource type. | `POST /policy` | `201` |
| Retrieve all instances of a resource type. | `GET /policy` | `200` |
| Retrieve the resource identified by the `fides_key` path parameter. |`GET /policy/{fides_key}` | `200`|
| Completely overwrite the `fides_key` resource. |`POST /policy/{fides_key}`| `200` |
| Delete the `fides_key` resource. | `DELETE /policy/{fides_key}`| `204`|

## Swagger API Docs
* The URLs of the endpoints emulate the names of the resources: `/organization`, `/policy`, `/registry`, `/system`, `/dataset`, `/data_category`, `/data_use`, `/data_subject`, `/data_qualifier`.

* Except for the `DELETE`, the endpoints accept and/or return JSON objects that represent the named resource. The structure of these objects is given in the [Fides Language: Resources chapter](../language/resources.html) -- it's the same structure that's used in the resource manifest files.

That's about all there is to it. There are an additional four endpoints that we'll look at below, but the sets of quintuplet endpoints listed above make up the core of the `fidesctl` API.

After a brief review of the four addition endpoints, we'll provide a complete API reference followed by a set of cURL calls that you can use to exercise the API on your system.


## Other endpoints

The four additional endpoints are:

* `GET /health` pings the API server to see if it's up and running. The call returns `200` if it's up and ready to receive messages, and `404` if not.

* Three of the taxonomic resources, `/data_category`, `/data_use`, and `/data_qualifier` (but _not_ `/data_subject`) define a `GET /resource_type/visualize/{figure_type}` endpoint that returns a graph of the resource's taxonomy. For details, see the **API Reference**, below.


## API Reference
---
!!swagger openapi.json!!
!!swagger openapi.json!!

## cURL Calls
Loading

0 comments on commit a6d93e7

Please sign in to comment.