Skip to content

Commit

Permalink
Fix minor issues in sanitations.md
Browse files Browse the repository at this point in the history
  • Loading branch information
NipunaRanasinghe committed Jun 28, 2024
1 parent 3e5b439 commit 57e9419
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions docs/spec/sanitations.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ _Edition_: Swan Lake
# Sanitation for OpenAPI specification

This document records the sanitation done on top of the official OpenAPI specification from Slack. The OpenAPI specification is obtained from the [APIs Guru website](https://api.apis.guru/v2/specs/slack.com/1.7.0/openapi.json).
The following changes were made so as to prevent api methods demanding a token being passed as a method parameter.
These changes are done in order to improve the overall usability, and to address some known language limitations.

1. Remove the token requirement from the parameter section of each endpoint in which it appeared. Endpoints in which it did not appear are:-
1. Removed the token requirement from the parameter section of each endpoint in which it appeared. Endpoints in which it did not appear are:-

admin.conversations.restrictAccess.addGroup
admin.conversations.restrictAccess.removeGroup
Expand All @@ -31,8 +31,10 @@ The following changes were made so as to prevent api methods demanding a token b

## OpenAPI cli command

The following command was used to generate the Ballerina client from the OpenAPI specification. The command should be executed from the repository '/ballerina' directory.
The following command was used to generate the Ballerina client from the OpenAPI specification. The command should be executed from the repository root directory.

```bash
bal openapi -i ..\docs\spec\openapi.json --mode client --license ..\docs\license.txt
```
bal openapi -i docs/spec/openapi.json --mode client --license docs/license.txt -o ballerina/
```

Note: The license year is hardcoded to 2024, change if necessary.

0 comments on commit 57e9419

Please sign in to comment.