Skip to content
Snippets Groups Projects
Commit 2b24ae7f authored by Robert Habermann's avatar Robert Habermann
Browse files

fix typo in docs

parent b4e460b5
No related branches found
No related tags found
No related merge requests found
......@@ -11,7 +11,7 @@ Overview
:target: https://pyotrs.readthedocs.org/en/latest/index.html
:alt: Docs Build Status
PyOTRS is a Python wrapper for accessing `OTRS <https://www.otrs.com/>`_ (Version 5!) using the
PyOTRS is a Python wrapper for accessing `OTRS <https://www.otrs.com/>`_ (Version 5) using the
REST API.
Features
......@@ -72,7 +72,7 @@ Get Ticket with TicketID 1 from OTRS over the REST API::
from pyotrs import Client
client = Client("https://otrs.example.com", "GenericTicketConnectorREST", "root@localhost", "x")
client.session_restore_or_set_up_new()
client.session_create()
client.ticket_get_by_id(1)
......@@ -109,11 +109,11 @@ True
- get Articles and Attachments
>>> client.ticket_get_by_id(1, articles=1, attachments=1) # include Articles and Attachments
>>> client.ticket_get_by_id(1, articles=1, attachments=1)
>>> my_ticket = client.result_list_ticket_get[0]
>>> my_ticket.list_articles
[<ArticleID: 3>, <ArticleID: 3>
[<ArticleID: 3>, <ArticleID: 4>
>>> my_ticket.list_dynamic_field
[<DynamicField: ProcessManagementActivityID: None>, <DynamicField: ProcessManagementProcessID: None>]
......@@ -141,10 +141,10 @@ Usage
Get a Ticket::
PyOTRS get -b https://sys.denm.de/ -w GenericTicketConnectorREST -u robbie -p 8fajCQdDyN -t 1
PyOTRS get -b https://otrs.example.com/ -w GenericTicketConnectorREST -u root@localhost -p password -t 1
Starting PyOTRS CLI
No config file found at: /home/robbie/.pyotrs
Connecting to https://sys.denm.de/ as robbie..
No config file found at: /home/user/.pyotrs
Connecting to https://otrs.example.com/ as user..
Ticket: Welcome to OTRS!
Queue: Raw
State: closed successful
......@@ -168,7 +168,7 @@ Get usage information::
$: PyOTRS get -h
Starting PyOTRS CLI
No config file found at: /home/robbie/.pyotrs
No config file found at: /home/user/.pyotrs
Usage: PyOTRS get [OPTIONS]
PyOTRS get command
......@@ -217,7 +217,7 @@ There are four ways to provide config values::
Both the config file and the environment use the same variable names::
PYOTRS_BASEURL=http://otrs.example.com:30080
PYOTRS_BASEURL=http://otrs.example.com
PYOTRS_WEBSERVICENAME=GenericTicketConnectorREST
PYOTRS_USERNAME=root@localhost
PYOTRS_PASSWORD=otrs_password
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment