Skip to content

Commit fc731c5

Browse files
committed
Populate README
1 parent d7521cd commit fc731c5

File tree

2 files changed

+14
-1
lines changed

2 files changed

+14
-1
lines changed

README.md

+8-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,8 @@
1-
# openapi
1+
This repository contains [OpenAPI specifications](https://www.openapis.org/) for [Buttondown](https://buttondown.email)'s API. You can find a more detailed API reference on Buttondown's [documentation site](https://docs.buttondown.email/api-reference/introduction).
2+
3+
In addition to the core OpenAPI spec, this repository contains two supplementary files meant to improve the experience of writing against Buttondown's API:
4+
5+
- `fixtures.json`, which contains test fixtures fore resources in the core spec.
6+
- `enums.json`, which contains detailed information about enums declared within the core spec. (This would ideally be subsumed into the spec itself, but [such a thing is not yet possible](https://github.com/OAI/OpenAPI-Specification/issues/348).)
7+
8+
Changes to the API can be found in the [releases](https://github.com/buttondown-email/openapi/releases) section.

fixtures.json

+6
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,12 @@
66
"url": "s3://buttondown/path-to-export",
77
"status": "completed"
88
},
9+
"BulkActionOutput": {
10+
"creation_date": "2019-08-24T14:15:22Z",
11+
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
12+
"url": "s3://buttondown/path-to-export",
13+
"status": "completed"
14+
},
915
"ErrorMessage": {
1016
"code": "something_went_wrong",
1117
"detail": "Your call is very important to us."

0 commit comments

Comments
 (0)