Skip to content

chore: update readme (#64) #69

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
kheiner wants to merge 1 commit into
base: main
Choose a base branch
from
+19 −1
Open

chore: update readme (#64) #69

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 19 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
# Directus' OpenAPI Specification

This repo contains the OpenAPI specifications for Directus' API.
This repo contains the OpenAPI specifications for [Directus' API](https://www.directus.io/docs/api).

The static spec in this repo contains all the system endpoints and a definition for a generic `/items/{collection}` endpoint.

> [!IMPORTANT]
> If you are experiencing issues with the OpenAPI Specification on your cloud or self hosted instance (https://your-instance.directus.cloud/server/specs/oas), report the issue [Directus/Directus](https://github.com/directus/directus).

## Usage

The spec is exported in 3 formats: `.yaml`, `.json`, and `.js`. The JS file is just an `export` of the same JSON but parsed into JS for ease of use in JS projects.
Expand All @@ -24,6 +27,21 @@ Key that maps a system endpoint to its corresponding system collection.

Examples of how to use the equivalent of the documented REST endpoint in the JS SDK and/or GraphQL endpoint.

## Adding an Endpoint

Endpoints that allow for requests that createSingular and createMultiple on the same path have an invisible special character appended to their record at `openapi/index.yaml`. Copy the code block below and change `<endpoint>` to the path of your endpoint.

```yaml
"/<endpoint>":
$ref: paths/<endpoint>/index.yaml
"/<endpoint>‎":
$ref: paths/<endpoint>/singular/index.yaml
"/<endpoint>/{id}":
$ref: paths/<endpoint>/_id/index.yaml
```

Take extra care not to delete the special character by using Find and Replace in your IDE.

## Deploying Releases

To deploy a new release to npm:
Expand Down