Skip to content

Commit 48393b5

Browse files
authored
Update README.md to be clearer about the mirror status of this repo
1 parent 1396e28 commit 48393b5

File tree

1 file changed

+9
-14
lines changed

1 file changed

+9
-14
lines changed

README.md

Lines changed: 9 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,25 @@
11
[![Discord](https://dcbadge.vercel.app/api/server/xWRaCDBtW4?style=flat)](https://discord.gg/xWRaCDBtW4)
22

3-
# Deepgram API Specs [Beta]
3+
# Deepgram API Specs
44

5-
This is intended as the single-source-of-truth specification for the Deepgram API, being developed and maintained by the DX team. It includes the specifications of internal and external features.
5+
This repository contains [OpenAPI](https://www.openapis.org) and [AsyncAPI](https://www.asyncapi.com) specifications for the [Deepgram API](https://developers.deepgram.com/reference/deepgram-api-overview).
66

7-
## Status
7+
## Public mirror
88

9-
These API specs are currently in beta release and expected to change frequently as we finalize our specfications for public consumption.
10-
11-
## Publishing Workflow
12-
13-
A public version of the specifications (scrubbed of internal and sensitive data) will be automatically published when any changes are made to our API to this repo.
9+
This is a public mirror of the internal Deepgram API specifications. Pull requests to this spec document will not be merged. In the future, we may enable contributions and corrections via contribution to the spec, but for now they cannot be accepted. Thank you!
1410

1511
## Latest Public Version
1612

17-
Check out the [openapi.yml](openapi.yml) file for the latest public version of the REST API spec.
18-
19-
Check out the [asyncapi.yml](asyncapi.yml) file for the latest public version of the WebSocket spec.
13+
Check out the [openapi.yml](openapi.yml) file for the latest public version of the OpenAPI spec.
2014

15+
Check out the [asyncapi.yml](asyncapi.yml) file for the latest public version of the AsyncAPI spec.
2116

2217
## Development and Contributing
2318

24-
* Directly modifying these API spec files in not allowed. Any API spec change should be done in the upstream Internal API Spec repository.
25-
* Direct contributions to our Internal API specs are reserved to Deepgram Employees only.
19+
* Directly modifying these API spec files in not allowed. Any API spec change should be done in the upstream internal Deepgram API specifications.
20+
* Direct contributions a restricted to stakeholders only.
2621

27-
## Getting Help
22+
## Getting Help
2823

2924
We love to hear from you so if you have questions, comments or find a bug in the project, let us know! You can either:
3025

0 commit comments

Comments
 (0)