diff --git a/README.md b/README.md index 738d59304..acc8b6af4 100644 --- a/README.md +++ b/README.md @@ -34,7 +34,7 @@ Browsable HTML docs http://readthedocs.org/docs/cgrates/ PDF, Epub, Manpage http://readthedocs.org/projects/cgrates/downloads/ -API reference [godoc](https://godoc.org/github.com/cgrates/cgrates/apier) +API reference [godoc](https://pkg.go.dev/github.com/cgrates/cgrates/apier@master) Also check [irc.freenode.net #cgrates](irc://irc.freenode.net:6667/cgrates) ([Webchat](http://webchat.freenode.net?randomnick=1&channels=%23cgrates)) and [Google group](https://groups.google.com/forum/#!forum/cgrates) for a more real-time support. diff --git a/docs/apicalls.rst b/docs/apicalls.rst index a53e75a08..c49369443 100644 --- a/docs/apicalls.rst +++ b/docs/apicalls.rst @@ -3,5 +3,5 @@ API Calls API calls are documented in the following GoDoc_ -.. _GoDoc : https://godoc.org/github.com/cgrates/cgrates/apier +.. _GoDoc : https://pkg.go.dev/github.com/cgrates/cgrates/apier@master diff --git a/docs/attributes.rst b/docs/attributes.rst index fa74492d2..f6e976a93 100644 --- a/docs/attributes.rst +++ b/docs/attributes.rst @@ -3,7 +3,7 @@ AttributeS ========== -**AttributeS** is a standalone subsystem within **CGRateS** and it is the equivalent of a key-value store. It is accessed via `CGRateS RPC APIs `_. +**AttributeS** is a standalone subsystem within **CGRateS** and it is the equivalent of a key-value store. It is accessed via `CGRateS RPC APIs `_. As most of the other subsystems, it is performance oriented, stored inside *DataDB* but cached inside the *cgr-engine* process. Caching can be done dynamically/on-demand or at start-time/precached and it is configurable within *cache* section in the :ref:`JSON configuration `. diff --git a/docs/cdre.rst b/docs/cdre.rst index df99c6363..4b5ed2ea1 100644 --- a/docs/cdre.rst +++ b/docs/cdre.rst @@ -10,7 +10,7 @@ CDRe ==== -**CDRe** is an extension of :ref:`CDRs`, responsible for exporting the *CDR* events processed by :ref:`CDRs`. It is accessed via `CGRateS RPC APIs `_ and configured within *cdre* section inside :ref:`JSON configuration `. +**CDRe** is an extension of :ref:`CDRs`, responsible for exporting the *CDR* events processed by :ref:`CDRs`. It is accessed via `CGRateS RPC APIs `_ and configured within *cdre* section inside :ref:`JSON configuration `. Export types @@ -32,7 +32,7 @@ You can control the templates which are to be executed via the filters which are Offline exports ^^^^^^^^^^^^^^^ -Are exports which are triggered via `CGRateS RPC APIs `_ and they have as data source the CDRs stored within *StorDB*. +Are exports which are triggered via `CGRateS RPC APIs `_ and they have as data source the CDRs stored within *StorDB*. diff --git a/docs/cdrs.rst b/docs/cdrs.rst index 17e9ca9dc..b4b182f6e 100644 --- a/docs/cdrs.rst +++ b/docs/cdrs.rst @@ -4,7 +4,7 @@ CDRs ==== -**CDRs** is a standalone subsystem within **CGRateS** responsible to process *CDR* events. It is accessed via `CGRateS RPC APIs `_ or separate *HTTP handlers* configured within *http* section inside :ref:`JSON configuration `. +**CDRs** is a standalone subsystem within **CGRateS** responsible to process *CDR* events. It is accessed via `CGRateS RPC APIs `_ or separate *HTTP handlers* configured within *http* section inside :ref:`JSON configuration `. Due to multiple interfaces exposed, the **CDRs** is designed to function as centralized server for *CDRs* received from various sources. Examples of such sources are: *\*real-time events* from interfaces like *Diameter*, *Radius*, *Asterisk*, *FreeSWITCH*, *Kamailio*, *OpenSIPS* diff --git a/docs/chargers.rst b/docs/chargers.rst index a7ac4d667..ff403f1ac 100644 --- a/docs/chargers.rst +++ b/docs/chargers.rst @@ -5,7 +5,7 @@ ChargerS **ChargerS** is a **CGRateS** subsystem designed to produce billing runs via *DerivedCharging* mechanism. -It works as standalone component of **CGRateS**, accessible via `CGRateS RPC `_ via a rich set of *APIs*. As input **ChargerS** is capable of receiving generic events (hashmaps) with dynamic types for fields. +It works as standalone component of **CGRateS**, accessible via `CGRateS RPC `_ via a rich set of *APIs*. As input **ChargerS** is capable of receiving generic events (hashmaps) with dynamic types for fields. **ChargerS** is an **important** part of the charging process within **CGRateS** since with no *ChargingProfile* matching, there will be no billing run performed. diff --git a/docs/overview.rst b/docs/overview.rst index f391c77d1..242f69007 100644 --- a/docs/overview.rst +++ b/docs/overview.rst @@ -4,7 +4,7 @@ .. _Kafka: https://kafka.apache.org/ .. _redis: https://redis.io/ .. _mongodb: https://www.mongodb.com/ -.. _api docs: https://godoc.org/github.com/cgrates/cgrates/apier +.. _api docs: https://pkg.go.dev/github.com/cgrates/cgrates/apier@master .. _SQS: https://aws.amazon.com/de/sqs/ .. _AMQP: https://www.amqp.org/ .. _Asterisk: https://www.asterisk.org/ @@ -187,7 +187,7 @@ Links - CGRateS home page ``_ - Documentation ``_ -- API docs ``_ +- API docs ``_ - Source code ``_ - Travis CI ``_ - Google group ``_ diff --git a/docs/rals.rst b/docs/rals.rst index aa2dba51d..476acf25b 100644 --- a/docs/rals.rst +++ b/docs/rals.rst @@ -4,7 +4,7 @@ RALs ==== -**RALs** is a standalone subsystem within **CGRateS** designed to handle two major tasks: :ref:`Rating` and :ref:`Accounting`. It is accessed via `CGRateS RPC APIs `_. +**RALs** is a standalone subsystem within **CGRateS** designed to handle two major tasks: :ref:`Rating` and :ref:`Accounting`. It is accessed via `CGRateS RPC APIs `_. diff --git a/docs/resources.rst b/docs/resources.rst index 6287eff3d..75000faf2 100644 --- a/docs/resources.rst +++ b/docs/resources.rst @@ -6,7 +6,7 @@ ResourceS **ResourceS** is a standalone subsystem part of the **CGRateS** infrastructure, designed to allocate virtual resources for the generic *Events* (hashmaps) it receives. -Both receiving of *Events* as well as operational commands on the virtual resources is performed via a complete set of `CGRateS RPC APIs `_. +Both receiving of *Events* as well as operational commands on the virtual resources is performed via a complete set of `CGRateS RPC APIs `_. Due it's real-time nature, **ResourceS** are designed towards high throughput being able to process thousands of *Events* per second. This is doable since each *Resource* is a very light object, held in memory and eventually backed up in *DataDB*. @@ -46,7 +46,7 @@ nested_fields ResourceProfile ^^^^^^^^^^^^^^^ -The **ResourceProfile** is the configuration of a *Resource*. This will be performed over `CGRateS RPC APIs `_ or *.csv* files. A profile is comprised out of the following parameters: +The **ResourceProfile** is the configuration of a *Resource*. This will be performed over `CGRateS RPC APIs `_ or *.csv* files. A profile is comprised out of the following parameters: Tenant The tenant on the platform (one can see the tenant as partition ID). diff --git a/docs/routes.rst b/docs/routes.rst index 5f3b12ef2..38c245d5d 100644 --- a/docs/routes.rst +++ b/docs/routes.rst @@ -10,7 +10,7 @@ RouteS ========= -**RouteS** is a standalone subsystem within **CGRateS** responsible to compute a list of routes which can be used for a specific event received to process. It is accessed via `CGRateS RPC APIs `_. +**RouteS** is a standalone subsystem within **CGRateS** responsible to compute a list of routes which can be used for a specific event received to process. It is accessed via `CGRateS RPC APIs `_. As most of the other subsystems, it is performance oriented, stored inside *DataDB* but cached inside the *cgr-engine* process. Caching can be done dynamically/on-demand or at start-time/precached and it is configurable within *cache* section in the :ref:`JSON configuration `. diff --git a/docs/sessions.rst b/docs/sessions.rst index 5b054cd2f..b3ccb8709 100644 --- a/docs/sessions.rst +++ b/docs/sessions.rst @@ -4,7 +4,7 @@ SessionS ======== -**SessionS** is a standalone subsystem within **CGRateS** responsible to manage virtual sessions based on events received. It is accessed via `CGRateS RPC APIs `_. +**SessionS** is a standalone subsystem within **CGRateS** responsible to manage virtual sessions based on events received. It is accessed via `CGRateS RPC APIs `_. Parameters diff --git a/docs/stats.rst b/docs/stats.rst index 291085c2b..3e06dcb4b 100644 --- a/docs/stats.rst +++ b/docs/stats.rst @@ -6,7 +6,7 @@ StatS **StatS** is a standalone subsystem part of the **CGRateS** infrastructure, designed to aggregate and calculate statistical metrics for the generic *Events* (hashmaps) it receives. -Both receiving of *Events* as well as *Metrics* displaying is performed via a complete set of `CGRateS RPC APIs `_. +Both receiving of *Events* as well as *Metrics* displaying is performed via a complete set of `CGRateS RPC APIs `_. Due it's real-time nature, **StatS** are designed towards high throughput being able to process thousands of *Events* per second. This is doable since each *StatQueue* is a very light object, held in memory and eventually backed up in *DataDB*. diff --git a/docs/thresholds.rst b/docs/thresholds.rst index b7b222423..9add710e5 100644 --- a/docs/thresholds.rst +++ b/docs/thresholds.rst @@ -4,7 +4,7 @@ ThresholdS ========== -**ThresholdS** is a standalone subsystem within **CGRateS** responsible to execute a list of *Actions* for a specific event received to process. It is accessed via `CGRateS RPC APIs `_. +**ThresholdS** is a standalone subsystem within **CGRateS** responsible to execute a list of *Actions* for a specific event received to process. It is accessed via `CGRateS RPC APIs `_. As most of the other subsystems, it is performance oriented, stored inside *DataDB* but cached inside the *cgr-engine* process. Caching can be done dynamically/on-demand or at start-time/precached and it is configurable within *cache* section in the :ref:`JSON configuration `.