Skip to content

Commit

Permalink
Merge pull request #3318 from aldesantis/chore/api-contributors-guide
Browse files Browse the repository at this point in the history
Document contribution guidelines for API documentation
  • Loading branch information
spaghetticode authored Sep 3, 2019
2 parents 0ebe0c8 + ba50c8b commit acc7196
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions api/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,17 @@ Run the API tests:
```bash
bundle exec rspec
```

## Documentation

The API documentation is in the [openapi](https://github.com/solidusio/solidus/tree/master/api/openapi)
directory. It follows the OpenAPI specification and it is hosted on
[Stoplight](https://solidus.docs.stoplight.io/).

If you want to contribute, you can use [Stoplight Studio](https://stoplight.io/p/studio),
an OpenAPI editor, to edit the files visually, and copy-paste the
resulting code into the `openapi` directory.

CircleCI automatically syncs our Git repo with Stoplight when a PR is
merged, and automatically publishes a new version on Stoplight when
a new Solidus version is released.

0 comments on commit acc7196

Please sign in to comment.