Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(docs): Fix broken link to API description #7236

Merged
merged 2 commits into from
Sep 3, 2020
Merged

chore(docs): Fix broken link to API description #7236

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ba913f8
Fixed broken link to API description
progmatic-99 Aug 31, 2020
9c91387
Broken link removed from docs
progmatic-99 Aug 31, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,14 @@ When checking in code for models, please update migrations as well.

### API documentation

The api is documented using [api blueprint](https://apiblueprint.org/). Local changes to [the description](https://github.com/fossasia/open-event-server/blob/development/docs/api/api_blueprint.apib) can be viewed using e.g. the [apiary gem](https://help.apiary.io/tools/apiary-cli/):
The api is documented using [api blueprint](https://apiblueprint.org/). First, generate the description/blueprint `.apib` file using:

```bash
npx aglio --input docs/api/api_blueprint_source.apib --compile --output docs/api/api_blueprint.apib # generate the description .apib file

```

Local changes to [the description](https://github.com/fossasia/open-event-server/blob/development/docs/api/api_blueprint.apib) can be viewed using e.g. the [apiary gem](https://help.apiary.io/tools/apiary-cli/):
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please remove the link as it is not present now


```bash
gem install apiaryio # dependency
Expand Down