Update OpenAPI Specification

.gitignore

@@ -0,0 +1,45 @@
+# Logs
+logs
+*.log
+
+# Runtime data
+pids
+*.pid
+*.seed
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (http://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directory
+# https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git-
+node_modules
+
+# Debug log from npm
+npm-debug.log
+
+# OSX hidden files
+.DS_Store
+
+# Default ignored files
+/shelf/
+/workspace.xml
+# Editor-based HTTP Client requests
+/httpRequests/
+# Datasource local storage ignored files
+/dataSources/
+/dataSources.local.xml
+
+#Auto generated files
+/bin/dist/

README.md

@@ -1 +1,17 @@
-# openapi
+# Circle's OpenAPI Specification
+
+This repository contains [OpenAPI specifications][openapi] for Circle's API.
+
+[Changelog](https://github.com/circlefin/openapi/releases/)
+
+
+Files can be found in the `openapi/{json or yaml}` directory:
+
+* `account-doc.{json,yaml}:` OpenAPI 3.0 spec for APIs to manage your account balance.
+* `accounts-doc.{json,yaml}:` OpenAPI 3.0 spec for APIs to manage custodial wallets.
+* `general-doc.{json,yaml}:` OpenAPI 3.0 spec for common endpoints shared across all Circle APIs.
+* `payments-doc.{json,yaml}:` OpenAPI 3.0 spec for APIs for accepting payments.
+* `payouts-doc.{json,yaml}:` OpenAPI 3.0 spec for APIs for making payouts.
+
+
+[openapi]: https://www.openapis.org/