rodrigo/genieacs
1
0 Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Shell script to spell check docs

Browse Source
This commit is contained in:
Zaid Abdulla committed 2021-02-23 13:18:40 -08:00
1 parent 02dfe4b554
commit 5b17d1b2ca
8 files changed
+186 -11
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

docs/api-reference.rst
+5 -5
View File
@@ -1,7 +1,7 @@
API Reference
=============
GenieACS expoeses a rich RESTful API through its NBI component. This document
GenieACS exposes a rich RESTful API through its NBI component. This document
serves as a reference for the available APIs.
This API makes use of MongoDB's query language in some of its endpoints. Refer
@@ -16,7 +16,7 @@ to MongoDB's documentation for details.
.. warning::
A common pitfll is not properly percent-encoding special characters in the
A common pitfall is not properly percent-encoding special characters in the
device ID or query in the URL.
Endpoints
@@ -106,7 +106,7 @@ if the tasks have been queued to be executed at the next inform.
*device_id*: The ID of the device.
*connection_request*: Indicates that a connection request will be triggered to
execute the tasks immediatly. Otherwise, the tasks will be queued and be
execute the tasks immediately. Otherwise, the tasks will be queued and be
processed at the next inform.
The response body is the task object as it is inserted in the database. The
@@ -299,7 +299,7 @@ The following file metadata may be sent as request headers:
- ``fileType``: For firmware images it should be "1 Firmware Upgrade Image".
Other common types are "2 Web Content" and "3 Vendor Configuration File".
- ``oui``: The OUI of the device model that this file belogs to.
- ``oui``: The OUI of the device model that this file belongs to.
- ``productClass``: The product class of the device.
@@ -344,7 +344,7 @@ Find files using a query.
Tasks
-----
Find the different availabe tasks and their object structure.
Find the different available tasks and their object structure.
``getParameterValues``
~~~~~~~~~~~~~~~~~~~~~~
docs/cpe-authentication.rst
+1 -1
View File
@@ -11,7 +11,7 @@ CPE to ACS
By default GenieACS will accept any incoming connection via HTTP/HTTPS and
respond to it.
The following paramters are used to set and get (password is redacted but
The following parameters are used to set and get (password is redacted but
can be set) the username/password used to authenticate against the ACS:
Username: ``Device.ManagementServer.Username`` or ``InternetGatewayDevice.ManagementServer.Username``
docs/environment-variables.rst
+2 -2
View File
@@ -86,7 +86,7 @@ CWMP_ACCESS_LOG_FILE
File to log incoming requests for genieacs-cwmp. If omitted, logs will go to
stdout.
Default: unest
Default: unset
NBI_WORKER_PROCESSES
The number of worker processes to spawn for genieacs-nbi. A value of 0 means
@@ -107,7 +107,7 @@ NBI_INTERFACE
NBI_SSL_CERT
Path to certificate file. If omitted, non-secure HTTP will be used.
Default: unest
Default: unset
NBI_SSL_KEY
Path to certificate key file. If omitted, non-secure HTTP will be used.
docs/ext-sample.js
+1 -1
View File
@@ -1,4 +1,4 @@
// This is an exmaple GenieACS extension to get the current latitude/longitude
// This is an example GenieACS extension to get the current latitude/longitude
// of the International Space Station. Why, you ask? Because why not.
// To install, copy this file to config/ext/iss.js.
docs/installation-guide.rst
+1 -1
View File
@@ -4,7 +4,7 @@ Installation Guide
This guide is for installing GenieACS on a single server on any Linux distro
that uses *systemd* as its init system.
The various GenieACS services are independant of each other and may be
The various GenieACS services are independent of each other and may be
installed on different servers. You may also run multiple instances of each in
a load-balancing/failover setup.