Skip to content

Commit ec9923b

Browse files
authored
Merge pull request #19 from vitwit/dev
Fix grammar mistakes & todo
2 parents 548d0be + f94c8c2 commit ec9923b

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -45,9 +45,9 @@ const mySDK = new MySDK({
4545

4646
### Mandatory Headers & Optional Headers
4747

48-
This is a tricky part in the SDK generation. As we are automating the SDK generation, we need to understand, what are all the headers we need for our APIs. For example, AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY are the required configuration credentials to use AWS SDKs. In the same way, if your SDK needs any credentials that need to be sent for every API request, you need to mention them as mandatory headers in headers configuration.
48+
This is a tricky part of the SDK generation. As we are automating the SDK generation, we need to understand, what are all the headers we need for our APIs. For example, `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY` are the required configuration credentials to use AWS SDKs. In the same way, if your SDK needs any credentials that need to be sent for every API request, you need to mention them as mandatory headers in headers configuration.
4949

50-
Optional Headers, as name suggest, they are optional or required only for certain APIs. SDK will send those headers only after they are set. For example, if API requires, Authorization token for some APIs and not for all other APIs, it can be set as optional header. There are two functions to set & clear these Optional Headers. Optional headers are useful when we need to deal with login/logout kind of scenarios. Few methods from SDK's can be used optionally and when user logged into the system, SDK should send authorization tokens from then. For this kind of cases, you can make use of OptionalHeaders and `set` & `clear` functions.
50+
Optional Headers, as the name suggests, they are optional or required only for certain APIs. SDK will send those headers only after they are set. For example, if API requires, Authorization token for some APIs and not for all other APIs, it can be set as an optional header. There are two functions to set & clear these Optional Headers. Optional headers are useful when we need to deal with login/logout kind of scenarios. Few methods from SDK's can be used optionally and when a user logged into the system, SDK should send authorization tokens from then. For this kind of cases, you can make use of OptionalHeaders and `set` & `clear` functions.
5151

5252
```js
5353
//to set the headers
@@ -149,5 +149,7 @@ will take current data structure and provide the previous version for one who op
149149

150150
### TODO
151151

152-
[ ] Standardize SDK Usage Guide generation
153-
[ ] Testscripts
152+
- [x] Generate documentation for SDK usage
153+
- [x] Code documentation for SDK functions
154+
- [ ] Standardize SDK Usage Guide generation
155+
- [ ] Testscripts

0 commit comments

Comments
 (0)