Skip to content
This repository was archived by the owner on Nov 29, 2023. It is now read-only.

Commit 7a3b731

Browse files
authored
Update README (#810)
* Update README * Add blurb on API Specs * Typo
1 parent 2d4b308 commit 7a3b731

File tree

1 file changed

+6
-26
lines changed

1 file changed

+6
-26
lines changed

README.md

Lines changed: 6 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,5 @@
11
# API-Docs
22

3-
| ⚠️ Please do not modify API Specs in this repository ⚠️ |
4-
|:---:|
5-
6-
API specs now reside in the [api-specs](https://github.com/Bandwidth/api-specs) repository and code snippets in the [api-docs-code-snippets](https://github.com/Bandwidth/api-docs-code-snippets) repository.
7-
83
## Table of Contents
94

105
1. [API Docs Strategy Overview](#api-docs-strategy-overview)
@@ -26,6 +21,10 @@ API references are the "facts" about the APIs, and will typically be defined by
2621

2722
Guides cover a wide range of possibilities, but typically any step by step process required to use a feature should be a guide. These guides should be written as markdown files, and should link out to any API reference as needed. An example of a guide would be a description of how to respond to an inbound SMS.
2823

24+
## API Specs
25+
26+
The source of truth for all OpenAPI definitions are kept in a private repository - but the spec files in `./site/specs` mirror the source of truth. PRs against those files wont be accepted - but can be migrated to the private repo.
27+
2928
## SDK Docs Strategy Overview
3029

3130
Bandwidth's SDKs will contain thin READMEs that show the basics of getting started with the SDK, and link out to the full API reference. These READMEs will not contain all of the functions within the SDK; that should be defined with the API references.
@@ -58,11 +57,11 @@ or `yarn run cy:open` to open the cypress client and runs tests from the cypress
5857

5958
To add a new spec (or update an existing spec), please head over to our [api-specs](https://github.com/Bandwidth/api-specs) repository, as this is the source of truth for all of Bandwidth's internal and external API Specs. You may also follow the guide [here](https://bandwidth-jira.atlassian.net/wiki/spaces/DX/pages/4098359409/How+to+Update+API+Specifications+and+Contribute+to+Developer+Documentation) that explains in detail how to add new spec files to the `api-specs` repo.
6059

61-
### Versioned Specs
60+
### Versioned Specs
6261

6362
To account for versioned API Documentation we have a [Spec Version Dropdown](./site/src/components/SpecVersionDropdown.js) component that allows you to add a dropdown menu to the api reference page with links to the other versions of your API Specification. In order to implement this feature your spec `.tsx` pages need their own directory within the `./site/src/pages/apis` directory. This will be done for you by the DevX team after you update your changes on the `api-specs` repo.
6463

65-
Sample Directory:
64+
Sample Directory:
6665

6766
```sh
6867
# ./site/src/pages
@@ -289,22 +288,3 @@ The below adds a language switcher in line with text in an MDX file:
289288
</Tabs>
290289

291290
And this text will be rendered after the language switcher
292-
293-
294-
## PR Requirements
295-
296-
## SDK Generation
297-
298-
The `./sdk-generation` directory contains code and config for our SDK generation that supports our public SDKs. Much like the docsite generation, typically you'll interface with this through NPM commands.
299-
300-
`npm run generate -- -l <LANGUAGE> -s <SPEC>` is the command to generate an SDK. The `-s` flag is optional; not including it will default to the SDK with all APIs. The file `./sdk-generation/bandwidth.zip` will contain the generated code.
301-
302-
| Language | Notes |
303-
|--|--|
304-
| python | |
305-
| ruby | |
306-
| csharp | |
307-
| java | |
308-
| php | PHP >= 7.2
309-
| phpold | Does not have XML support |
310-
| node | Highly recommended to generate with a specified spec |

0 commit comments

Comments
 (0)