From ba913f8daa3d51cbebcb394843fb64461d011859 Mon Sep 17 00:00:00 2001 From: Shubham Upreti Date: Mon, 31 Aug 2020 19:06:40 +0530 Subject: [PATCH 1/2] Fixed broken link to API description --- README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 368f712adb..3b83b89681 100644 --- a/README.md +++ b/README.md @@ -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/): ```bash gem install apiaryio # dependency From 9c91387ca87ba89c74bf371e8fde48831f9eb81a Mon Sep 17 00:00:00 2001 From: Shubham Upreti Date: Mon, 31 Aug 2020 19:19:10 +0530 Subject: [PATCH 2/2] Broken link removed from docs --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 3b83b89681..00653f45b6 100644 --- a/README.md +++ b/README.md @@ -193,7 +193,7 @@ npx aglio --input docs/api/api_blueprint_source.apib --compile --output docs/api ``` -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/): +Local changes to the description can be viewed using e.g. the [apiary gem](https://help.apiary.io/tools/apiary-cli/): ```bash gem install apiaryio # dependency