[ILX-58820] Updated API RateLimit Description (#47)

* [ILX-58820] Updated API RateLimit Description

* [ILX-58820] Addressed Feedback

* Update ruby.yml

* Update ruby.yml

* Update ruby.yml

* Update ruby.yml

* Update ruby.yml

* Update ruby.yml

* Update ruby.yml

* Update ruby.yml

* Update Gemfile.lock

* Update ruby.yml

* Update Gemfile.lock

* Update ruby.yml

* Update ruby.yml

* Update Gemfile

* Update ruby.yml

* Update ruby.yml

* Update config.yml

* Update config.yml

* Update config.yml

* Update config.yml

* Update Gemfile

* Update Gemfile

* Update Gemfile.lock

* Update Gemfile

---------

Co-authored-by: Anthony Grafft <127154023+AnthonyGrafftIntelex@users.noreply.github.com>

Author: Arpit-Ribadiya

.circleci/config.yml

@@ -3,7 +3,7 @@ jobs:
     build:
         working_directory: ~/project
         docker:
-            - image: starefossen/ruby-node:2-8
+            - image: cimg/ruby:2.7.8-node
               auth:
                   username: intelexdocker
                   password: $DOCKERHUB_PASSWORD
@@ -12,19 +12,19 @@ jobs:
             - run:
                 name: Install and configure dependencies
                 command: |
-                    gem install bundler -v 2.3.26
+                    gem install bundler -v 2.4.22
                     bundle install --jobs 4 --retry 3
             - run:
                 name: Build static html
                 command: bundle exec middleman build --clean
             - persist_to_workspace:
-                root: /root/project
+                root: ~/project
                 paths:
                     - build
     deploy:
         working_directory: ~/project
         docker:
-            - image: starefossen/ruby-node:2-8
+            - image: cimg/ruby:2.7.8-node
               auth:
                   username: intelexdocker
                   password: $DOCKERHUB_PASSWORD
@@ -34,7 +34,7 @@ jobs:
                 fingerprints:
                     - "72:81:e7:4d:d2:d4:0d:7f:59:6b:e1:74:57:3d:36:12"
             - attach_workspace:
-                at: /root/project
+                at: ~/project
             - run:
                 name: Install and configure dependencies
                 command: |

.github/workflows/ruby.yml

@@ -7,18 +7,19 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v1
-    - name: Set up Ruby 2.6
-      uses: actions/setup-ruby@v1
+    - name: Set up Ruby 2.7
+      uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 2.6.x
+          ruby-version: '2.7'
+          bundler-cache: true
     - name: Build and test with Rake
       run: |
-        gem install bundler
+        gem install bundler -v 2.4.22
         bundle install --jobs 4 --retry 3
         bundle exec middleman build --clean
     - name: GitHub Pages Deploy
-      uses: JamesIves/github-pages-deploy-action@master
-      env:
+      uses: JamesIves/github-pages-deploy-action@v4
+      with:
         BRANCH: "gh-pages"
         FOLDER: "build"
         ACCESS_TOKEN: ${{ secrets.ACCESS_TOKEN }}

Gemfile

@@ -6,4 +6,4 @@ gem 'middleman-syntax', '~> 3.0.0'
 gem 'middleman-autoprefixer', '~> 2.7.0'
 gem "middleman-sprockets", "~> 4.1.0"
 gem 'rouge', '~> 2.0.5'
-gem 'redcarpet', '~> 3.4.0'
+gem 'redcarpet', '~> 3.4.0'

Gemfile.lock

@@ -120,7 +120,6 @@ DEPENDENCIES
   middleman-syntax (~> 3.0.0)
   redcarpet (~> 3.4.0)
   rouge (~> 2.0.5)
-  wdm (~> 0.1.1)
 
 BUNDLED WITH
-   1.14.6
+   2.4.22

source/includes/_api-reference.md

@@ -139,17 +139,19 @@ Response Code | Meaning
 When we make backwards-incompatible changes to the API, we release new versions. The current version is **v2** and can be determined with our API base path **/api/v2/**. Read our [Intelex platform release notes](https://community.intelex.com/library/knowledgebase/release-notes) to see our API changelog.
 
 ## API Rate Limiting / Quotas
-To ensure Intelex Platform is reliable and has the expected performance for all users, we limit the number of API calls an API user (or application) can make within a given time period. If the limit is exceeded, the API user may be throttled and subsequent requests within the same period will fail (status code 429).
+To ensure Intelex Platform is reliable and has the expected performance for all users, we limit the number of API calls an API user (or application) can make within a given time period. If the limit is exceeded, the API user may be throttled and subsequent requests will be rejected, returning HTTP response code 429 Too Many Requests. In such cases it is the responsibility of the client application to implement appropriate retry logic for requests that are rejected due to rate limiting.
 
 ### Limit
-The Intelex Platform API Rate limit is **2 requests per second**.
+The Intelex Platform API Rate limit is **6 requests per second**.
 
 ### Quota headers
 Quota details may be passed back to the API user/application via response headers.
 
 Header | Description | Sample value
 ---------- | ------- | -------
-X-RateLimit-Limit	| The request limit per specified unit of time.	| 100
-X-RateLimit-Remaining	| The remaining number of requests that API consumers can send in the current time window. | 75
-X-RateLimit-Reset	| The UTC epoch timestamp indicating the time of the next quota reset. Sent only when quota remains. | 1521214822
-X-RateLimit-Next | The UTC epoch timestamp indicating the time of the next quota reset. Sent only when quota is full.	 |1521215291
+Retry-After	| Time in seconds to wait before retrying the request after rate limit is exceeded. | 600
+
+### Best Practices
+
+* Use HTTP clients that support automatic retries with an exponential back-off strategy when receiving 429 (Too Many Requests) responses.
+* Avoid spikes of traffic by spreading out API calls over time wherever possible.