├── __init__.py
├── test
    ├── __init__.py
    ├── testdataDefaults.py
    ├── testdataValidValues.py
    ├── testdataArgument.py
    ├── testdataBodyArgument.py
    ├── testdataQueryArgument.py
    ├── testdataArguments.py
    └── testdataMethod.py
├── dev
    ├── rerunner.sh
    ├── http_cors_server.py
    └── index.html
├── .gitignore
├── processDefaults.py
├── LICENSE
├── README.md
├── processQueryArgument.py
├── processBodyArgument.py
├── processValidValues.py
├── processArguments.py
├── generate_swagger_TrelloAPI.py
├── processMethod.py
└── processModelName.py


/__init__.py:
--------------------------------------------------------------------------------
1 | 


--------------------------------------------------------------------------------
/test/__init__.py:
--------------------------------------------------------------------------------
1 | 


--------------------------------------------------------------------------------
/dev/rerunner.sh:
--------------------------------------------------------------------------------
 1 | #!/bin/sh
 2 | # export the_file="processValidValues.py"
 3 | # export the_file="processDefaults.py"
 4 | # export the_file="processArgument.py"
 5 | export the_file="processArguments.py"
 6 | 
 7 | while true; do
 8 |   change=$(inotifywait -e close_write .)
 9 |   change=${change#./ * }
10 |   if [ "$change" = ${the_file} ]; then ./${the_file}; fi
11 | done
12 | 


--------------------------------------------------------------------------------
/dev/http_cors_server.py:
--------------------------------------------------------------------------------
 1 | #! /usr/bin/env python2
 2 | from SimpleHTTPServer import SimpleHTTPRequestHandler
 3 | import BaseHTTPServer
 4 | 
 5 | class CORSRequestHandler (SimpleHTTPRequestHandler):
 6 |     def end_headers (self):
 7 |         self.send_header('Access-Control-Allow-Origin', '*')
 8 |         SimpleHTTPRequestHandler.end_headers(self)
 9 | 
10 | if __name__ == '__main__':
11 |     BaseHTTPServer.test(CORSRequestHandler, BaseHTTPServer.HTTPServer)
12 | 
13 | 


--------------------------------------------------------------------------------
/test/testdataDefaults.py:
--------------------------------------------------------------------------------
 1 | #!/usr/bin/env python
 2 | # -*- coding: utf-8 -*-
 3 | 
 4 | #  Constants
 5 | swagger = {
 6 |   "name": "petId",
 7 |   "description": "Pet id to delete",
 8 |   "required": True,
 9 | }
10 | 
11 | test_values = []
12 | test_values.append("""
13 | <li><strong>Default:</strong> <code class="docutils literal"><span class="pre">false</span></code></li>
14 | """)
15 | test_values.append("""
16 | <li><strong>Default:</strong> <code class="docutils literal"><span class="pre">name,closed,idOrganization,pinned</span></code></li>
17 | """)
18 | test_values.append("""
19 | <li><strong>Default:</strong> <code class="docutils literal"><span class="pre">name,desc,descData,closed,idOrganization,pinned,url,shortUrl,prefs,labelNames</span></code></li>
20 | """)
21 | 
22 | 


--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
 1 | # Byte-compiled / optimized / DLL files
 2 | __pycache__/
 3 | *.py[cod]
 4 | 
 5 | # C extensions
 6 | *.so
 7 | 
 8 | # backup files
 9 | *~
10 | *.*~
11 | 
12 | # Distribution / packaging
13 | .Python
14 | env/
15 | build/
16 | develop-eggs/
17 | dist/
18 | downloads/
19 | eggs/
20 | .eggs/
21 | lib/
22 | lib64/
23 | parts/
24 | sdist/
25 | var/
26 | *.egg-info/
27 | .installed.cfg
28 | *.egg
29 | 
30 | # PyInstaller
31 | #  Usually these files are written by a python script from a template
32 | #  before PyInstaller builds the exe, so as to inject date/other infos into it.
33 | *.manifest
34 | *.spec
35 | 
36 | # Installer logs
37 | pip-log.txt
38 | pip-delete-this-directory.txt
39 | 
40 | # Unit test / coverage reports
41 | htmlcov/
42 | .tox/
43 | .coverage
44 | .coverage.*
45 | .cache
46 | nosetests.xml
47 | coverage.xml
48 | *,cover
49 | 
50 | # Translations
51 | *.mo
52 | *.pot
53 | 
54 | # Django stuff:
55 | *.log
56 | 
57 | # Sphinx documentation
58 | docs/_build/
59 | 
60 | # PyBuilder
61 | target/
62 | 


--------------------------------------------------------------------------------
/processDefaults.py:
--------------------------------------------------------------------------------
 1 | #!/usr/bin/env python
 2 | from bs4 import BeautifulSoup
 3 | 
 4 | #  Constants
 5 | DEFAULT = "Default:"
 6 | 
 7 | #  Methods
 8 | def processDefaults(soup, swagger):
 9 | 
10 |   default = ''
11 |   for string in soup.code.stripped_strings :
12 |     default = ' and'.join(', '.join(string.split(',')).rsplit(',', 1))
13 | 
14 |   swagger['default'] = default
15 |   if  "true" in default : swagger['default'] = True
16 |   if "false" in default : swagger['default'] = False
17 | 
18 |   return
19 | 
20 | 
21 | #  -   -   -   -   -   -   -   -   -   -   -
22 | #  Main routine (for testing)
23 | def main():
24 |   from test.testdataDefaults import test_values
25 |   from test.testdataDefaults import swagger
26 | 
27 |   idx = 0
28 |   for frag in test_values :
29 |     print("~~~~~~~~~~~~~~~~~~~~~~~~~~~~~")
30 |     soup = BeautifulSoup(frag)
31 | #    if idx == 1 :
32 |     if idx != -1 :
33 |       processDefaults(soup.body.li, swagger)
34 |       print "swagger = {}".format(swagger)
35 |     idx = idx + 1
36 | 
37 |   print(">>~~~~~~~~~~~~~~~~~~~~~~~~~<<")
38 | 
39 | 
40 | if __name__ == "__main__": main()
41 | 
42 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
 1 | The MIT License (MIT)
 2 | 
 3 | Copyright (c) 2015 Warehouseman
 4 | 
 5 | Permission is hereby granted, free of charge, to any person obtaining a copy
 6 | of this software and associated documentation files (the "Software"), to deal
 7 | in the Software without restriction, including without limitation the rights
 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 | 
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 | 
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 | 
23 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # trello-swagger-generator
 2 | Reads Trello's crappy API documentation pages and generates a swagger file.
 3 | 
 4 | 
 5 | ### to generate the swagger
 6 | 
 7 |      pip install beautifulsoup4
 8 |      ./generate_swagger_TrelloAPI.py
 9 | 
10 | ### to view the swagger file
11 | #### run the simple Python http server
12 | 
13 |      dev/http_cors_server.py
14 | 
15 | Open your browser to [localhost:8000](http://localhost:8000)
16 | 
17 | ![Imgur](http://i.imgur.com/cK1V7MU.png)
18 | 
19 | 
20 | #### obtain and run the swagger.io viewer
21 | 
22 |     cd ~/projects
23 |     wget -O swagger.zip https://github.com/swagger-api/swagger-ui/archive/master.zip
24 |     unzip swagger.zip
25 |     mv swagger-ui-master swagger-ui
26 |     mv swagger.zip swagger-ui
27 |     cd swagger-ui
28 |     
29 | edit `dist/index.html` line #32 replacing ...
30 | 
31 |     url = "http://petstore.swagger.io/v2/swagger.json";
32 |  
33 |  ... with ...
34 |  
35 |     url = "http://localhost:8000/TrelloAPI.json";
36 |  
37 | Open a second tab in your browser to the local file address file :
38 | 
39 |     file:///home/yourself/projects/swagger-ui/dist/index.html
40 |  
41 |  
42 | 
43 | ![Imgur](http://i.imgur.com/CEvWdyn.png)
44 | 
45 | 
46 | 
47 | 
48 | 
49 | 
50 | 
51 | 
52 |  
53 | 


--------------------------------------------------------------------------------
/processQueryArgument.py:
--------------------------------------------------------------------------------
 1 | #!/usr/bin/env python
 2 | from bs4 import BeautifulSoup
 3 | from processValidValues import processValidValues
 4 | from processDefaults import processDefaults
 5 | from processModelName import determineModelName
 6 | import json
 7 | 
 8 | #  Constants
 9 | DEFAULT = "Default:"
10 | REQUIRED = "required"
11 | NONE = -1
12 | 
13 | def processQueryArgument(soup, swggr, cursor):
14 | 
15 |   swagger = swggr['paths'][cursor['path']][cursor['method']]
16 | 
17 |   '''
18 |   print "##### "
19 |   print repr(soup.code.span.next_element.next_element.strip())
20 |   print "##### "
21 |   '''
22 | 
23 |   name = soup.code.span.text
24 |   # print 'Name : {}\n\n'.format(name)
25 | 
26 |   required = False
27 |   if REQUIRED in soup.code.span.next_element.next_element.strip() :
28 |     required = True
29 | 
30 | 
31 |   parameter = {
32 |       "name" : name.strip()
33 |     , "required" : required
34 |     , "in" : "query"
35 |     , "type" : "string"
36 |     , "description" : "undefined"
37 |     , "default" : "undefined"
38 |   }
39 |   vvals = soup.find_all(text='Valid Values:')
40 | 
41 |   '''
42 |   print "::::: "
43 |   print ' {}'.format(vvals)
44 |   print "::::: "
45 |   '''
46 |   for vval in vvals :
47 |     processValidValues(vval.parent.parent, parameter)
48 | 
49 |   defaults = soup.find_all(text='Default:')
50 |   for default in defaults :
51 |     processDefaults(default.parent.parent, parameter)
52 | 
53 |   swagger["parameters"].append(parameter)
54 | 
55 |   return
56 | 
57 | 
58 | 
59 | #  -   -   -   -   -   -   -   -   -   -   -
60 | #  Main routine (for testing)
61 | def main():
62 | 
63 |   from test.testdataQueryArgument import test_values
64 |   from test.testdataQueryArgument import swagger
65 |   from test.testdataQueryArgument import cursor
66 | 
67 |   idx = 0
68 |   for frag in test_values :
69 |     print("~~~~~~~~~~~~~~~~~~~~~~~~~~~~~")
70 |     soup = BeautifulSoup(frag)
71 | #    if idx == 0 :
72 |     if idx != -1 :
73 |       processQueryArgument(soup.body, swagger, cursor)
74 |     idx = idx + 1
75 | 
76 |   print json.dumps(swagger)
77 | 
78 | 
79 |   print("\n>>~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~<<\n")
80 | 
81 | 
82 | 
83 | if __name__ == "__main__": main()
84 | 
85 | 


--------------------------------------------------------------------------------
/test/testdataValidValues.py:
--------------------------------------------------------------------------------
 1 | #!/usr/bin/env python
 2 | # -*- coding: utf-8 -*-
 3 | 
 4 | #  Constants
 5 | swagger = {
 6 |   "name": "petId",
 7 |   "in": "path",
 8 |   "description": "Pet id to delete",
 9 |   "required": True,
10 |   "type": "undefined",
11 |   "format": "undefined"
12 | }
13 |   
14 | test_values = []
15 | test_values.append("""
16 | <li><strong>Valid Values:</strong> A valid label color or <code class="docutils literal"><span class="pre">null</span></code></li>
17 | """)
18 | test_values.append("""
19 | <li><strong>Valid Values:</strong> An id</li>
20 | """)
21 | test_values.append("""
22 | <li><strong>Valid Values:</strong> <code class="docutils literal"><span class="pre">all</span></code> or a comma-separated list of:
23 |           <ul>
24 | <li><code class="docutils literal"><span class="pre">scaled</span></code></li>
25 | <li><code class="docutils literal"><span class="pre">url</span></code></li>
26 | </ul>
27 | </li>
28 | """)
29 | test_values.append("""
30 | <li><strong>Valid Values:</strong> <code class="docutils literal"><span class="pre">all</span></code> or a comma-separated list of:<ul>
31 | <li><code class="docutils literal"><span class="pre">closed</span></code></li>
32 | <li><code class="docutils literal"><span class="pre">dateLastActivity</span></code></li>
33 | <li><code class="docutils literal"><span class="pre">dateLastView</span></code></li>
34 | <li><code class="docutils literal"><span class="pre">desc</span></code></li>
35 | <li><code class="docutils literal"><span class="pre">descData</span></code></li>
36 | <li><code class="docutils literal"><span class="pre">idOrganization</span></code></li>
37 | <li><code class="docutils literal"><span class="pre">invitations</span></code></li>
38 | <li><code class="docutils literal"><span class="pre">invited</span></code></li>
39 | <li><code class="docutils literal"><span class="pre">labelNames</span></code></li>
40 | <li><code class="docutils literal"><span class="pre">memberships</span></code></li>
41 | <li><code class="docutils literal"><span class="pre">name</span></code></li>
42 | <li><code class="docutils literal"><span class="pre">pinned</span></code></li>
43 | <li><code class="docutils literal"><span class="pre">powerUps</span></code></li>
44 | <li><code class="docutils literal"><span class="pre">prefs</span></code></li>
45 | <li><code class="docutils literal"><span class="pre">shortLink</span></code></li>
46 | <li><code class="docutils literal"><span class="pre">shortUrl</span></code></li>
47 | <li><code class="docutils literal"><span class="pre">starred</span></code></li>
48 | <li><code class="docutils literal"><span class="pre">subscribed</span></code></li>
49 | <li><code class="docutils literal"><span class="pre">url</span></code></li>
50 | </ul>
51 | </li>
52 | """) 
53 | 
54 | 
55 | 


--------------------------------------------------------------------------------
/processBodyArgument.py:
--------------------------------------------------------------------------------
  1 | #!/usr/bin/env python
  2 | from bs4 import BeautifulSoup
  3 | from processValidValues import processValidValues
  4 | from processDefaults import processDefaults
  5 | from processModelName import determineModelName
  6 | from pprint import pprint
  7 | import json
  8 | import re
  9 | 
 10 | #  Constants
 11 | DEFAULT = "Default:"
 12 | REQUIRED = "required"
 13 | NONE = -1
 14 | 
 15 | def processBodyArgument(soup, swggr, cursor):
 16 | 
 17 |   # if cursor['entity'] == "board" and cursor['method'] != "get" \
 18 |   # and cursor['path'] in ["/boards","/cards","/checklists","/labels","/lists","/organizations","/sessions","/webhooks"] :
 19 |   # # ["/boards/{idBoard}/lists"] :
 20 | 
 21 |   if cursor['path'] in ["xxxxx/members/{idMember}/boardStars/{idBoardStar}/idBoard"] :
 22 |     debugPrint = True
 23 |   else :
 24 |     debugPrint = False
 25 | 
 26 | 
 27 |   name = soup.code.span.text
 28 |   if debugPrint : print 'Name : {}\n\n'.format(name)
 29 | 
 30 |   required = False
 31 |   if REQUIRED in soup.code.span.next_element.next_element.strip() :
 32 |     required = True
 33 | 
 34 |   swagger = swggr['paths'][cursor['path']][cursor['method']]
 35 | 
 36 | 
 37 |   '''
 38 |   print "##### "
 39 |   print repr(soup.code.span.next_element.next_element.strip())
 40 |   print "##### "
 41 |   '''
 42 | 
 43 |   parameter = {
 44 |       "name" : name.strip()
 45 |     , "required" : required
 46 |     , "in" : "query"
 47 |     , "type" : "string"
 48 |     , "description" : "undefined"
 49 |     , "default" : "undefined"
 50 |   }
 51 |   vvals = soup.find_all(text='Valid Values:')
 52 | 
 53 |   '''
 54 |   print "::::: "
 55 |   print ' {}'.format(vvals)
 56 |   print "::::: "
 57 |   '''
 58 |   for vval in vvals :
 59 |     processValidValues(vval.parent.parent, parameter)
 60 | 
 61 |   defaults = soup.find_all(text='Default:')
 62 |   for default in defaults :
 63 |     processDefaults(default.parent.parent, parameter)
 64 | 
 65 |   model = determineModelName(cursor['path'])
 66 | 
 67 |   if model not in swggr['definitions']:
 68 |     swggr['definitions'][model] = {
 69 |       "type" : "object",
 70 |       "properties" : {
 71 |       },
 72 |       "xml":{
 73 |         "name":cursor['entity']
 74 |       }
 75 |     }
 76 | 
 77 |   swggr['definitions'][model]['properties'][parameter['name']] = {
 78 |     'type' : parameter['type'],
 79 |     'description' : parameter['description'],
 80 |   }
 81 | 
 82 |   if debugPrint :
 83 |     print 'Swagger definitions : {}\n\n'.format(model)
 84 |     pprint(swggr['definitions'][model])
 85 | 
 86 | #  swagger["parameters"].append(parameter)
 87 | 
 88 |   return model
 89 | 
 90 | 
 91 | #  -   -   -   -   -   -   -   -   -   -   -
 92 | #  Main routine (for testing)
 93 | def main():
 94 | 
 95 |   from test.testdataBodyArgument import test_values
 96 |   from test.testdataBodyArgument import swagger
 97 |   from test.testdataBodyArgument import cursor
 98 | 
 99 |   idx = 0
100 |   for frag in test_values :
101 |     print("~~~~~~~~~~~~~~~~~~~~~~~~~~~~~")
102 |     soup = BeautifulSoup(frag)
103 | #    if idx == 0 :
104 |     if idx != -1 :
105 |       processBodyArgument(soup.body, swagger, cursor)
106 |     idx = idx + 1
107 | 
108 |   print json.dumps(swagger)
109 | 
110 | 
111 |   print("\n>>~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~<<\n")
112 | 
113 | 
114 | 
115 | if __name__ == "__main__": main()
116 | 
117 | '''
118 |   "List":{
119 |     "type":"object",
120 |     "properties":{
121 |       "name":{
122 |         "type":"string"
123 |       },
124 |       "pos":{
125 |         "type":"string",
126 |         "default":"top"
127 |       }
128 |     },
129 |     "xml":{
130 |       "name":"Pet"
131 |     }
132 |   }
133 | 
134 | '''
135 | 


--------------------------------------------------------------------------------
/dev/index.html:
--------------------------------------------------------------------------------
  1 | <!DOCTYPE html>
  2 | <html>
  3 | <head>
  4 |   <title>Swagger UI</title>
  5 |   <link rel="icon" type="image/png" href="images/favicon-32x32.png" sizes="32x32" />
  6 |   <link rel="icon" type="image/png" href="images/favicon-16x16.png" sizes="16x16" />
  7 |   <link href='css/typography.css' media='screen' rel='stylesheet' type='text/css'/>
  8 |   <link href='css/reset.css' media='screen' rel='stylesheet' type='text/css'/>
  9 |   <link href='css/screen.css' media='screen' rel='stylesheet' type='text/css'/>
 10 |   <link href='css/reset.css' media='print' rel='stylesheet' type='text/css'/>
 11 |   <link href='css/print.css' media='print' rel='stylesheet' type='text/css'/>
 12 |   <script src='lib/jquery-1.8.0.min.js' type='text/javascript'></script>
 13 |   <script src='lib/jquery.slideto.min.js' type='text/javascript'></script>
 14 |   <script src='lib/jquery.wiggle.min.js' type='text/javascript'></script>
 15 |   <script src='lib/jquery.ba-bbq.min.js' type='text/javascript'></script>
 16 |   <script src='lib/handlebars-2.0.0.js' type='text/javascript'></script>
 17 |   <script src='lib/underscore-min.js' type='text/javascript'></script>
 18 |   <script src='lib/backbone-min.js' type='text/javascript'></script>
 19 |   <script src='swagger-ui.js' type='text/javascript'></script>
 20 |   <script src='lib/highlight.7.3.pack.js' type='text/javascript'></script>
 21 |   <script src='lib/marked.js' type='text/javascript'></script>
 22 |   <script src='lib/swagger-oauth.js' type='text/javascript'></script>
 23 | 
 24 |   <script type="text/javascript">
 25 |     $(function () {
 26 |       var url = window.location.search.match(/url=([^&]+)/);
 27 |       if (url && url.length > 1) {
 28 |         url = decodeURIComponent(url[1]);
 29 |       } else {
 30 |         url = "http://localhost:8000/TrelloAPI.json";
 31 |       }
 32 |       window.swaggerUi = new SwaggerUi({
 33 |         url: url,
 34 |         dom_id: "swagger-ui-container",
 35 |         supportedSubmitMethods: ['get', 'post', 'put', 'delete', 'patch'],
 36 |         onComplete: function(swaggerApi, swaggerUi){
 37 |           if(typeof initOAuth == "function") {
 38 |             initOAuth({
 39 |               clientId: "your-client-id",
 40 |               realm: "your-realms",
 41 |               appName: "your-app-name"
 42 |             });
 43 |           }
 44 | 
 45 |           $('pre code').each(function(i, e) {
 46 |             hljs.highlightBlock(e)
 47 |           });
 48 | 
 49 |           addApiKeyAuthorization();
 50 |         },
 51 |         onFailure: function(data) {
 52 |           log("Unable to Load SwaggerUI");
 53 |         },
 54 |         docExpansion: "none",
 55 |         apisSorter: "alpha",
 56 |         showRequestHeaders: false
 57 |       });
 58 | 
 59 |       function addApiKeyAuthorization(){
 60 |         var key = encodeURIComponent($('#input_apiKey')[0].value);
 61 |         if(key && key.trim() != "") {
 62 |             var apiKeyAuth = new SwaggerClient.ApiKeyAuthorization("api_key", key, "query");
 63 |             window.swaggerUi.api.clientAuthorizations.add("api_key", apiKeyAuth);
 64 |             log("added key " + key);
 65 |         }
 66 |       }
 67 | 
 68 |       $('#input_apiKey').change(addApiKeyAuthorization);
 69 | 
 70 |       // if you have an apiKey you would like to pre-populate on the page for demonstration purposes...
 71 |       /*
 72 |         var apiKey = "myApiKeyXXXX123456789";
 73 |         $('#input_apiKey').val(apiKey);
 74 |       */
 75 | 
 76 |       window.swaggerUi.load();
 77 | 
 78 |       function log() {
 79 |         if ('console' in window) {
 80 |           console.log.apply(console, arguments);
 81 |         }
 82 |       }
 83 |   });
 84 |   </script>
 85 | </head>
 86 | 
 87 | <body class="swagger-section">
 88 | <div id='header'>
 89 |   <div class="swagger-ui-wrap">
 90 |     <a id="logo" href="http://swagger.io">swagger</a>
 91 |     <form id='api_selector'>
 92 |       <div class='input'><input placeholder="http://example.com/api" id="input_baseUrl" name="baseUrl" type="text"/></div>
 93 |       <div class='input'><input placeholder="api_key" id="input_apiKey" name="apiKey" type="text"/></div>
 94 |       <div class='input'><a id="explore" href="#">Explore</a></div>
 95 |     </form>
 96 |   </div>
 97 | </div>
 98 | 
 99 | <div id="message-bar" class="swagger-ui-wrap">&nbsp;</div>
100 | <div id="swagger-ui-container" class="swagger-ui-wrap"></div>
101 | </body>
102 | </html>
103 | 


--------------------------------------------------------------------------------
/processValidValues.py:
--------------------------------------------------------------------------------
  1 | #!/usr/bin/env python
  2 | import re
  3 | from bs4 import BeautifulSoup
  4 | 
  5 | #  Constants
  6 | VALID_VALUES = "Valid Values:"
  7 | 
  8 | #  Methods
  9 | def processValidValues(soup, swagger):
 10 | 
 11 |   if (soup.ul == None) : # no attached <ul>
 12 | #    swagger['description'] = "{} : {}".format(VALID_VALUES, ' '.join(soup.stripped_strings).replace(VALID_VALUES, '').strip())
 13 |     swagger['description'] = "{}".format(' '.join(soup.stripped_strings).replace(VALID_VALUES, '').strip())
 14 |     return
 15 | 
 16 |   # collect up the array contents
 17 |   aryVvals = []
 18 |   idx = 0
 19 |   for vval in soup.ul.contents :
 20 |     if type(vval) == type(soup.ul) :
 21 |       aryVvals.append(vval.code.span.string)
 22 |     idx = idx + 1
 23 | 
 24 |   # join the array contents as csv with or between penultimate and final elements
 25 |   vvals = ' or'.join(', '.join(aryVvals).rsplit(',', 1))
 26 | 
 27 |   # get rid of the <ul> altogether
 28 |   soup.ul.extract()
 29 | 
 30 |   # strip down to string data and get rid of the section title
 31 |   main_clause = ' '.join(soup.stripped_strings).replace(VALID_VALUES, '').strip()
 32 | #  swagger['description'] = "{} : {} {}".format(VALID_VALUES, main_clause, vvals)
 33 |   swagger['description'] = "{} {}".format(main_clause, vvals)
 34 |   return
 35 | 
 36 | 
 37 | 
 38 | #  -   -   -   -   -   -   -   -   -   -   -
 39 | #  Main routine (for testing)
 40 | def main():
 41 | 
 42 |   from test.testdataValidValues import test_values
 43 |   from test.testdataValidValues import swagger
 44 | 
 45 |   idx = 0
 46 |   for frag in test_values :
 47 |     print("~~~~~~~~~~~~~~~~~~~~~~~~~~~~~")
 48 |     soup = BeautifulSoup(frag)
 49 | #    if idx == 2 :
 50 |     if idx != -1 :
 51 |       processValidValues(soup.body.li, swagger)
 52 |       print(swagger)
 53 |     idx = idx + 1
 54 | 
 55 |   print(">>~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~<<\n")
 56 | 
 57 | 
 58 |   paths = []
 59 |   paths.append('/boards/{idBoard}/prefs/background')
 60 |   paths.append('/boards/{idBoard}/prefs/calendarFeedEnabled')
 61 |   paths.append('/boards/{idBoard}/prefs/cardAging')
 62 |   paths.append('/boards/{idBoard}/prefs/cardCovers')
 63 |   paths.append('/boards/{idBoard}/prefs/comments')
 64 |   paths.append('/boards/{idBoard}/prefs/invitations')
 65 |   paths.append('/boards/{idBoard}/prefs/permissionLevel')
 66 |   paths.append('/boards/{idBoard}/prefs/selfJoin')
 67 |   paths.append('/boards/{idBoard}/prefs/voting')
 68 |   paths.append('/boards/{idBoard}/calendarKey/generate')
 69 |   paths.append('/boards/{idBoard}/labelNames/blue')
 70 |   paths.append('/boards/{idBoard}/labelNames/green')
 71 |   paths.append('/boards/{idBoard}/labelNames/orange')
 72 |   paths.append('/boards/{idBoard}/labelNames/purple')
 73 |   paths.append('/boards/{idBoard}/labelNames/red')
 74 |   paths.append('/boards/{idBoard}/labelNames/yellow')
 75 |   paths.append('/boards/{idBoard}/emailKey/generate')
 76 |   paths.append('/boards/{idBoard}/myPrefs/emailPosition')
 77 |   paths.append('/boards/{idBoard}/myPrefs/idEmailList')
 78 |   paths.append('/boards/{idBoard}/myPrefs/showListGuide')
 79 |   paths.append('/boards/{idBoard}/myPrefs/showSidebar')
 80 |   paths.append('/boards/{idBoard}/myPrefs/showSidebarActivity')
 81 |   paths.append('/boards/{idBoard}/myPrefs/showSidebarBoardActions')
 82 |   paths.append('/boards/{idBoard}/myPrefs/showSidebarMembers')
 83 | 
 84 |   paths.append('/boards/{idBoard}/checklists')
 85 |   paths.append('/boards/{idBoard}/labels')
 86 |   paths.append('/boards/{idBoard}/lists')
 87 |   paths.append('/boards/{idBoard}/closed')
 88 |   paths.append('/boards/{idBoard}/desc')
 89 |   paths.append('/boards/{idBoard}/idOrganization')
 90 |   paths.append('/boards/{idBoard}/members')
 91 |   paths.append('/boards/{idBoard}/name')
 92 |   paths.append('/boards/{idBoard}/subscribed')
 93 | 
 94 |   paths.append('/boards/{idBoard}')
 95 | 
 96 |   paths.append('/boards')
 97 | 
 98 |   paths.append('/boards/{idBoard}/members/{idMember}')
 99 |   paths.append('/boards/{idBoard}/memberships/{idMembership}')
100 | 
101 | 
102 |   for path in paths :
103 |     idx = 0
104 |     for pattern in patterns :
105 |       mm = pattern.match(path)
106 |       if mm : print(">>~~~~~ {})   {} ~~~~<<".format(idx, path))
107 |       idx = idx+1
108 | 
109 |   print("\n>>~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~<<\n")
110 | 
111 | 
112 | 
113 | if __name__ == "__main__": main()
114 | 
115 | 


--------------------------------------------------------------------------------
/test/testdataArgument.py:
--------------------------------------------------------------------------------
  1 | #!/usr/bin/env python
  2 | # -*- coding: utf-8 -*-
  3 | 
  4 | #  Constants
  5 | swagger = {
  6 |   "paths": {
  7 |     "pth": {
  8 |       "mthd": {
  9 |        "parameters": []
 10 |       }
 11 |     }
 12 |   },
 13 |   "definitions": {
 14 |   }
 15 | }
 16 | 
 17 | cursor = {'entity' : 'ent', 'path' : 'pth', 'method' : 'mthd'}
 18 | 
 19 | test_values = []
 20 | test_values.append("""
 21 | <li><code class="docutils literal"><span class="pre">idCustomSticker</span></code> (required)
 22 |   <ul>
 23 |     <li><strong>Valid Values:</strong> An id</li>
 24 |   </ul>
 25 | </li>
 26 | """)
 27 | test_values.append("""
 28 | 
 29 | <li><code class="docutils literal"><span class="pre">fields</span></code> (optional)
 30 |   <ul>
 31 |     <li><strong>Default:</strong> <code class="docutils literal"><span class="pre">name,closed,idOrganization,pinned</span></code></li>
 32 |     <li><strong>Valid Values:</strong> <code class="docutils literal"><span class="pre">all</span></code> or a comma-separated list of:
 33 |       <ul>
 34 |         <li><code class="docutils literal"><span class="pre">scaled</span></code></li>
 35 |         <li><code class="docutils literal"><span class="pre">url</span></code></li>
 36 |       </ul>
 37 |     </li>
 38 |   </ul>
 39 | </li>
 40 | """)
 41 | test_values.append("""
 42 | <li><code class="docutils literal"><span class="pre">fields</span></code> (optional)
 43 |   <ul>
 44 |     <li><strong>Default:</strong> <code class="docutils literal"><span class="pre">all</span></code></li>
 45 |     <li><strong>Valid Values:</strong> <code class="docutils literal"><span class="pre">all</span></code> or a comma-separated list of:
 46 |       <ul>
 47 |         <li><code class="docutils literal"><span class="pre">color</span></code></li>
 48 |         <li><code class="docutils literal"><span class="pre">idBoard</span></code></li>
 49 |         <li><code class="docutils literal"><span class="pre">name</span></code></li>
 50 |         <li><code class="docutils literal"><span class="pre">uses</span></code></li>
 51 |       </ul>
 52 |     </li>
 53 |   </ul>
 54 | </li>
 55 | """)
 56 | test_values.append("""
 57 | <li>
 58 |   <code class="docutils literal"><span class="pre">entities</span></code>
 59 |   (optional)
 60 | 
 61 |   <ul>
 62 |     <li><strong>Default:</strong> <code class="docutils literal"><span class=
 63 |     "pre">false</span></code></li>
 64 | 
 65 |     <li>
 66 |       <strong>Valid Values:</strong>
 67 | 
 68 |       <ul>
 69 |         <li><code class="docutils literal"><span class=
 70 |         "pre">true</span></code></li>
 71 | 
 72 |         <li><code class="docutils literal"><span class=
 73 |         "pre">false</span></code></li>
 74 |       </ul>
 75 |     </li>
 76 |   </ul>
 77 | </li>
 78 | """)
 79 | test_values.append("""
 80 | <li>
 81 |   <code class="docutils literal"><span class="pre">display</span></code>(optional)
 82 |   <ul>
 83 |     <li><strong>Default:</strong> <code class="docutils literal"><span class="pre">false</span></code></li>
 84 |     <li>
 85 |       <strong>Valid Values:</strong>
 86 |       <ul>
 87 |         <li><code class="docutils literal"><span class="pre">true</span></code></li>
 88 |         <li><code class="docutils literal"><span class="pre">false</span></code></li>
 89 |       </ul>
 90 |     </li>
 91 |   </ul>
 92 | </li>
 93 | """)
 94 | test_values.append("""
 95 | <li>
 96 |   <code class="docutils literal"><span class="pre">format</span></code>
 97 |   (optional)
 98 | 
 99 |   <ul>
100 |     <li><strong>Default:</strong> <code class="docutils literal"><span class=
101 |     "pre">list</span></code></li>
102 | 
103 |     <li>
104 |       <strong>Valid Values:</strong> One of:
105 | 
106 |       <ul>
107 |         <li><code class="docutils literal"><span class=
108 |         "pre">count</span></code></li>
109 | 
110 |         <li><code class="docutils literal"><span class=
111 |         "pre">list</span></code></li>
112 | 
113 |         <li><code class="docutils literal"><span class=
114 |         "pre">minimal</span></code></li>
115 |       </ul>
116 |     </li>
117 |   </ul>
118 | </li>
119 | """)
120 | test_values.append("""
121 | <li><code class="docutils literal"><span class="pre">name</span></code> (required)
122 |   <ul>
123 |     <li><strong>Valid Values:</strong> a string with a length from <code class="docutils literal"><span class="pre">0</span></code> to <code class="docutils literal"><span class="pre">16384</span></code></li>
124 |   </ul>
125 | </li>
126 | """)
127 | 
128 | 
129 | 


--------------------------------------------------------------------------------
/test/testdataBodyArgument.py:
--------------------------------------------------------------------------------
  1 | #!/usr/bin/env python
  2 | # -*- coding: utf-8 -*-
  3 | 
  4 | #  Constants
  5 | swagger = {
  6 |   "paths": {
  7 |     "pth": {
  8 |       "mthd": {
  9 |        "parameters": []
 10 |       }
 11 |     }
 12 |   },
 13 |   "definitions": {
 14 |   }
 15 | }
 16 | 
 17 | cursor = {'entity' : 'ent', 'path' : 'pth', 'method' : 'mthd'}
 18 | 
 19 | test_values = []
 20 | test_values.append("""
 21 | <li><code class="docutils literal"><span class="pre">idCustomSticker</span></code> (required)
 22 |   <ul>
 23 |     <li><strong>Valid Values:</strong> An id</li>
 24 |   </ul>
 25 | </li>
 26 | """)
 27 | test_values.append("""
 28 | 
 29 | <li><code class="docutils literal"><span class="pre">fields</span></code> (optional)
 30 |   <ul>
 31 |     <li><strong>Default:</strong> <code class="docutils literal"><span class="pre">name,closed,idOrganization,pinned</span></code></li>
 32 |     <li><strong>Valid Values:</strong> <code class="docutils literal"><span class="pre">all</span></code> or a comma-separated list of:
 33 |       <ul>
 34 |         <li><code class="docutils literal"><span class="pre">scaled</span></code></li>
 35 |         <li><code class="docutils literal"><span class="pre">url</span></code></li>
 36 |       </ul>
 37 |     </li>
 38 |   </ul>
 39 | </li>
 40 | """)
 41 | test_values.append("""
 42 | <li><code class="docutils literal"><span class="pre">fields</span></code> (optional)
 43 |   <ul>
 44 |     <li><strong>Default:</strong> <code class="docutils literal"><span class="pre">all</span></code></li>
 45 |     <li><strong>Valid Values:</strong> <code class="docutils literal"><span class="pre">all</span></code> or a comma-separated list of:
 46 |       <ul>
 47 |         <li><code class="docutils literal"><span class="pre">color</span></code></li>
 48 |         <li><code class="docutils literal"><span class="pre">idBoard</span></code></li>
 49 |         <li><code class="docutils literal"><span class="pre">name</span></code></li>
 50 |         <li><code class="docutils literal"><span class="pre">uses</span></code></li>
 51 |       </ul>
 52 |     </li>
 53 |   </ul>
 54 | </li>
 55 | """)
 56 | test_values.append("""
 57 | <li>
 58 |   <code class="docutils literal"><span class="pre">entities</span></code>
 59 |   (optional)
 60 | 
 61 |   <ul>
 62 |     <li><strong>Default:</strong> <code class="docutils literal"><span class=
 63 |     "pre">false</span></code></li>
 64 | 
 65 |     <li>
 66 |       <strong>Valid Values:</strong>
 67 | 
 68 |       <ul>
 69 |         <li><code class="docutils literal"><span class=
 70 |         "pre">true</span></code></li>
 71 | 
 72 |         <li><code class="docutils literal"><span class=
 73 |         "pre">false</span></code></li>
 74 |       </ul>
 75 |     </li>
 76 |   </ul>
 77 | </li>
 78 | """)
 79 | test_values.append("""
 80 | <li>
 81 |   <code class="docutils literal"><span class="pre">display</span></code>(optional)
 82 |   <ul>
 83 |     <li><strong>Default:</strong> <code class="docutils literal"><span class="pre">false</span></code></li>
 84 |     <li>
 85 |       <strong>Valid Values:</strong>
 86 |       <ul>
 87 |         <li><code class="docutils literal"><span class="pre">true</span></code></li>
 88 |         <li><code class="docutils literal"><span class="pre">false</span></code></li>
 89 |       </ul>
 90 |     </li>
 91 |   </ul>
 92 | </li>
 93 | """)
 94 | test_values.append("""
 95 | <li>
 96 |   <code class="docutils literal"><span class="pre">format</span></code>
 97 |   (optional)
 98 | 
 99 |   <ul>
100 |     <li><strong>Default:</strong> <code class="docutils literal"><span class=
101 |     "pre">list</span></code></li>
102 | 
103 |     <li>
104 |       <strong>Valid Values:</strong> One of:
105 | 
106 |       <ul>
107 |         <li><code class="docutils literal"><span class=
108 |         "pre">count</span></code></li>
109 | 
110 |         <li><code class="docutils literal"><span class=
111 |         "pre">list</span></code></li>
112 | 
113 |         <li><code class="docutils literal"><span class=
114 |         "pre">minimal</span></code></li>
115 |       </ul>
116 |     </li>
117 |   </ul>
118 | </li>
119 | """)
120 | test_values.append("""
121 | <li><code class="docutils literal"><span class="pre">name</span></code> (required)
122 |   <ul>
123 |     <li><strong>Valid Values:</strong> a string with a length from <code class="docutils literal"><span class="pre">0</span></code> to <code class="docutils literal"><span class="pre">16384</span></code></li>
124 |   </ul>
125 | </li>
126 | """)
127 | 
128 | 
129 | 


--------------------------------------------------------------------------------
/test/testdataQueryArgument.py:
--------------------------------------------------------------------------------
  1 | #!/usr/bin/env python
  2 | # -*- coding: utf-8 -*-
  3 | 
  4 | #  Constants
  5 | swagger = {
  6 |   "paths": {
  7 |     "pth": {
  8 |       "mthd": {
  9 |        "parameters": []
 10 |       }
 11 |     }
 12 |   },
 13 |   "definitions": {
 14 |   }
 15 | }
 16 | 
 17 | cursor = {'entity' : 'ent', 'path' : 'pth', 'method' : 'mthd'}
 18 | 
 19 | test_values = []
 20 | test_values.append("""
 21 | <li><code class="docutils literal"><span class="pre">idCustomSticker</span></code> (required)
 22 |   <ul>
 23 |     <li><strong>Valid Values:</strong> An id</li>
 24 |   </ul>
 25 | </li>
 26 | """)
 27 | test_values.append("""
 28 | 
 29 | <li><code class="docutils literal"><span class="pre">fields</span></code> (optional)
 30 |   <ul>
 31 |     <li><strong>Default:</strong> <code class="docutils literal"><span class="pre">name,closed,idOrganization,pinned</span></code></li>
 32 |     <li><strong>Valid Values:</strong> <code class="docutils literal"><span class="pre">all</span></code> or a comma-separated list of:
 33 |       <ul>
 34 |         <li><code class="docutils literal"><span class="pre">scaled</span></code></li>
 35 |         <li><code class="docutils literal"><span class="pre">url</span></code></li>
 36 |       </ul>
 37 |     </li>
 38 |   </ul>
 39 | </li>
 40 | """)
 41 | test_values.append("""
 42 | <li><code class="docutils literal"><span class="pre">fields</span></code> (optional)
 43 |   <ul>
 44 |     <li><strong>Default:</strong> <code class="docutils literal"><span class="pre">all</span></code></li>
 45 |     <li><strong>Valid Values:</strong> <code class="docutils literal"><span class="pre">all</span></code> or a comma-separated list of:
 46 |       <ul>
 47 |         <li><code class="docutils literal"><span class="pre">color</span></code></li>
 48 |         <li><code class="docutils literal"><span class="pre">idBoard</span></code></li>
 49 |         <li><code class="docutils literal"><span class="pre">name</span></code></li>
 50 |         <li><code class="docutils literal"><span class="pre">uses</span></code></li>
 51 |       </ul>
 52 |     </li>
 53 |   </ul>
 54 | </li>
 55 | """)
 56 | test_values.append("""
 57 | <li>
 58 |   <code class="docutils literal"><span class="pre">entities</span></code>
 59 |   (optional)
 60 | 
 61 |   <ul>
 62 |     <li><strong>Default:</strong> <code class="docutils literal"><span class=
 63 |     "pre">false</span></code></li>
 64 | 
 65 |     <li>
 66 |       <strong>Valid Values:</strong>
 67 | 
 68 |       <ul>
 69 |         <li><code class="docutils literal"><span class=
 70 |         "pre">true</span></code></li>
 71 | 
 72 |         <li><code class="docutils literal"><span class=
 73 |         "pre">false</span></code></li>
 74 |       </ul>
 75 |     </li>
 76 |   </ul>
 77 | </li>
 78 | """)
 79 | test_values.append("""
 80 | <li>
 81 |   <code class="docutils literal"><span class="pre">display</span></code>(optional)
 82 |   <ul>
 83 |     <li><strong>Default:</strong> <code class="docutils literal"><span class="pre">false</span></code></li>
 84 |     <li>
 85 |       <strong>Valid Values:</strong>
 86 |       <ul>
 87 |         <li><code class="docutils literal"><span class="pre">true</span></code></li>
 88 |         <li><code class="docutils literal"><span class="pre">false</span></code></li>
 89 |       </ul>
 90 |     </li>
 91 |   </ul>
 92 | </li>
 93 | """)
 94 | test_values.append("""
 95 | <li>
 96 |   <code class="docutils literal"><span class="pre">format</span></code>
 97 |   (optional)
 98 | 
 99 |   <ul>
100 |     <li><strong>Default:</strong> <code class="docutils literal"><span class=
101 |     "pre">list</span></code></li>
102 | 
103 |     <li>
104 |       <strong>Valid Values:</strong> One of:
105 | 
106 |       <ul>
107 |         <li><code class="docutils literal"><span class=
108 |         "pre">count</span></code></li>
109 | 
110 |         <li><code class="docutils literal"><span class=
111 |         "pre">list</span></code></li>
112 | 
113 |         <li><code class="docutils literal"><span class=
114 |         "pre">minimal</span></code></li>
115 |       </ul>
116 |     </li>
117 |   </ul>
118 | </li>
119 | """)
120 | test_values.append("""
121 | <li><code class="docutils literal"><span class="pre">name</span></code> (required)
122 |   <ul>
123 |     <li><strong>Valid Values:</strong> a string with a length from <code class="docutils literal"><span class="pre">0</span></code> to <code class="docutils literal"><span class="pre">16384</span></code></li>
124 |   </ul>
125 | </li>
126 | """)
127 | 
128 | 
129 | 


--------------------------------------------------------------------------------
/processArguments.py:
--------------------------------------------------------------------------------
  1 | #!/usr/bin/env python
  2 | from bs4 import BeautifulSoup
  3 | from processQueryArgument import processQueryArgument
  4 | from processBodyArgument import processBodyArgument
  5 | import json
  6 | import sys
  7 | import re
  8 | 
  9 | #  Constants
 10 | DEFAULT = "Default:"
 11 | REQUIRED = "required"
 12 | 
 13 | 
 14 | #  Methods
 15 | def processArguments(soup, swggr, path_fields, cursor):
 16 | 
 17 |   '''
 18 |   print ' ..... ..... ..... ..... ..... ..... ..... '
 19 |   print soup.ul.contents
 20 |   print ' ^^^^^ ^^^^^ ^^^^^ ^^^^^ ^^^^^ ^^^^^ ^^^^^ '
 21 |   sys.exit()
 22 |   '''
 23 | 
 24 |   if cursor['path'] in ["/xcards/{card}"] :
 25 |     debugPrint = True
 26 |   else :
 27 |     debugPrint = False
 28 | 
 29 |   if debugPrint :
 30 |     print ' ..... ..... ..... ..... ..... ..... ..... '
 31 |     print path_fields
 32 |     print 'idBoardStar' in path_fields
 33 |     print ' ^^^^^ ^^^^^ ^^^^^ ^^^^^ ^^^^^ ^^^^^ ^^^^^ '
 34 | 
 35 | 
 36 |   swagger = swggr['paths'][cursor['path']][cursor['method']]
 37 | 
 38 |   processed_args = []
 39 | 
 40 |   for field in path_fields :   # process all the fields that form part of the URL
 41 | #    print "------------ new parameter -- {}".format(field)
 42 |     name_arg = field.iterkeys().next()
 43 |     swagger["parameters"].append({
 44 |         "name" : name_arg
 45 |       , "required" : True
 46 |       , "in" : "path"
 47 |       , "type" : "string"
 48 |       , "description" : field.itervalues().next()
 49 |       , "default" : "undefined"
 50 |     })
 51 |     processed_args.append(name_arg)
 52 | 
 53 |   if soup.ul != None :
 54 |     arguments = soup.ul.contents
 55 | 
 56 |     idx = -1
 57 |     modelName = None
 58 |     action = 'added'
 59 |     for argument in arguments :
 60 |       if isinstance(argument, type(soup.li)) :
 61 |         name_arg = argument.code.span.text
 62 |         if name_arg not in processed_args :
 63 |     #      idx = idx + 1
 64 |     #      print "#{} -- {}".format(idx, argument)
 65 |           if cursor['method'] in ["put", "post"] :
 66 |             # process all the fields that are sent in the body
 67 |             modelName = processBodyArgument(argument, swggr, cursor)
 68 |             if cursor['method'] == "put" :
 69 |               action = 'updated'
 70 |           else :
 71 |             # process all the fields that follow the "?" in the URL
 72 |             processQueryArgument(argument, swggr, cursor)
 73 | 
 74 |     if modelName :
 75 |       modelTitle = re.sub(
 76 |           "([a-z])([A-Z])","\g<1> \g<2>",
 77 |           modelName
 78 |         ).replace('_', ' ').title()
 79 |       swagger["parameters"].append({
 80 |           "name" : "body"
 81 |         , "required" : True
 82 |         , "in" : "body"
 83 |         , "description" : 'Attributes of "' + modelTitle + '" to be ' + action + '.'
 84 |         , "schema" : { "$ref" : '#/definitions/' + modelName }
 85 |       })
 86 | 
 87 | #  add the authorization key field
 88 |   swagger["parameters"].append({
 89 |       "name" : "key"
 90 |     , "required" : True
 91 |     , "in" : "query"
 92 |     , "type" : "string"
 93 |     , "description" : '<a href="https://trello.com/1/appKey/generate"  target="_blank">Generate your application key</a>'
 94 |     , "default" : "undefined"
 95 |   })
 96 | 
 97 | #  add the 3rd party token field field
 98 |   swagger["parameters"].append({
 99 |       "name" : "token"
100 |     , "required" : True
101 |     , "in" : "query"
102 |     , "type" : "string"
103 |     , "description" : '<a href="https://trello.com/docs/gettingstarted/index.html#getting-a-token-from-a-user"  target="_blank">Getting a token from a user</a>'
104 |     , "default" : "undefined"
105 |   })
106 | 
107 |   return
108 | 
109 | #  -   -   -   -   -   -   -   -   -   -   -
110 | #  Main routine (for testing)
111 | def main():
112 | 
113 |   from test.testdataArguments import test_values
114 |   from test.testdataArguments import swagger
115 |   from test.testdataArguments import cursor
116 |   from test.testdataArguments import pathFields
117 | 
118 |   idx = 0
119 |   for frag in test_values :
120 |     print("~~~~~~~~~~~~~~~~~~~~~~~~~~~~~")
121 |     soup = BeautifulSoup(frag)
122 | #    if idx == 1 :
123 |     if idx != -1 :
124 |       processArguments(soup.body.contents[0], swagger, pathFields, cursor)
125 |     idx = idx + 1
126 | 
127 |   print(">>~~~~~~~~~~~ ? ~~~~~~~~~~~<<")
128 |   print "JSON {}".format(json.dumps(swagger))
129 |   print("<<~~~~~~~~~~~~~~~~~~~~~~~~~>>")
130 | 
131 | 
132 | 
133 | if __name__ == "__main__": main()
134 | 
135 | 


--------------------------------------------------------------------------------
/generate_swagger_TrelloAPI.py:
--------------------------------------------------------------------------------
  1 | #!/usr/bin/env python
  2 | from bs4 import BeautifulSoup
  3 | from processMethod import processMethod
  4 | import urllib2
  5 | import json
  6 | import sys
  7 | 
  8 | #  Constants
  9 | TRELLO_JSON_FILE="TrelloAPI.json"
 10 | API_DOC = "https://trello.com/docs/api"
 11 | 
 12 | # Methods
 13 | def processTrelloEntity(soup, swagger, numEntity):
 14 |   entity = swagger['tags'][numEntity]['name']
 15 |   '''
 16 | #  print "Entity {} ".format(entity)
 17 | #  if "board" in entity :
 18 |   if "action" in entity :
 19 | #  if "label" in entity :
 20 | #  if "member" in entity :
 21 |     print "Doing {}".format(entity)
 22 |   else:
 23 |     return
 24 |   '''
 25 |   index = soup.html.body.find(class_='section', id=entity)
 26 |   for div in index.find_all("div", recursive=False) :
 27 | #    print "Entity {}  --  {}".format(entity, div['id'])
 28 |     processMethod(div, swagger, entity)
 29 | 
 30 |   return
 31 | 
 32 | def processTrelloAPIIndex(soup, swagger):
 33 | 
 34 |   for link in soup.find_all(class_='toctree-l1') :
 35 |     swagger['tags'].append(
 36 |     {
 37 |         "name": link.a.string
 38 |       , "description": "{}/{}".format(API_DOC, link.a['href'])
 39 |     })
 40 | 
 41 |   return
 42 | 
 43 | def processTrelloToC(swagger):
 44 | 
 45 |   idx = 0
 46 |   for tag in swagger['tags'] :
 47 |     if idx != 101 :
 48 | #      print "{}".format(tag['description'])
 49 |       processTrelloEntity(
 50 |           BeautifulSoup(urllib2.urlopen(tag['description']).read())
 51 |         , swagger
 52 |         , idx
 53 |       )
 54 |     idx = idx + 1
 55 | 
 56 |   return
 57 | 
 58 | 
 59 | #  -   -   -   -   -   -   -   -   -   -   -
 60 | #  Main routine (for testing)
 61 | def main():
 62 | 
 63 |   swagger = {
 64 |     "swagger": "2.0",
 65 |     "info": {
 66 |       "version": "1.0",
 67 |       "title": "Trello API",
 68 |       "description": "This document describes the REST API of Trello as "
 69 |          + "published by Trello.com."
 70 |          + "\n - <a href='https://trello.com/docs/index.html' target='_blank'>"
 71 |          + "Official Documentation</a>"
 72 |          + "\n - <a href='" + API_DOC + "' target='_blank'>"
 73 |          + "The HTML pages that were scraped in order to "
 74 |          + "generate this specification.</a>",
 75 |       "termsOfService": "https://trello.com/legal",
 76 |       "contact": {
 77 |         "name": "Trello",
 78 |         "url": "https://trello.com/home"
 79 |       },
 80 |       "license": {
 81 |         "name": "Trello : Terms of Service",
 82 |         "url": "https://trello.com/legal"
 83 |       }
 84 |     },
 85 |     "host": "trello.com",
 86 |     "tags": [
 87 |     ],
 88 |     "securityDefinitions": {
 89 |       "trello_auth": {
 90 |         "type": "oauth2",
 91 |         "authorizationUrl": "https:\/\/trello.com\/1\/appKey\/generate",
 92 |         "flow": "implicit",
 93 |         "scopes": {
 94 |           "write:boards": "modify any of the boards in your account",
 95 |           "read:boards": "read any of the boards in your account"
 96 |         }
 97 |       },
 98 |       "api_key": {
 99 |         "type": "apiKey",
100 |         "name": "api_key",
101 |         "in": "header"
102 |       }
103 |     },
104 |     "definitions": {
105 |     },
106 |     "paths": {
107 |     },
108 |     "basePath": "/1",
109 |     "schemes": [
110 |       "https"
111 |     ],
112 | 
113 |   }
114 | 
115 |   soup = BeautifulSoup(urllib2.urlopen(API_DOC).read())
116 |   processTrelloAPIIndex(soup, swagger)
117 |   processTrelloToC(swagger)
118 | 
119 |   print(">> - - - - - - - - - - ! - - - - - - - - - - -<<")
120 |   print "JSON {} written to {}".format(json.dumps(swagger['info']['title']), TRELLO_JSON_FILE)
121 |   print("<< - - - - - - - - - - - - - - - - - - - - - ->>")
122 | 
123 |   # now write output to a file
124 |   TrelloAPI_json = open(TRELLO_JSON_FILE, "w")
125 | 
126 |   # magic happens here to make it pretty-printed
127 |   prettySpec = json.dumps(swagger, indent=2, sort_keys=False)
128 | 
129 |   # replace all "false" with false and all "true" with true
130 |   finalSpec = prettySpec.replace("\"false\"", "false").replace("\"true\"", "true")
131 | 
132 |   TrelloAPI_json.write(prettySpec)
133 |   TrelloAPI_json.close()
134 | 
135 | if __name__ == "__main__": main()
136 | 
137 |       # "List":{
138 |       #   "type":"object",
139 |       #   "properties":{
140 |       #     "name":{
141 |       #       "type":"string"
142 |       #     },
143 |       #     "pos":{
144 |       #       "type":"string",
145 |       #       "default":"top"
146 |       #     }
147 |       #   },
148 |       #   "xml":{
149 |       #     "name":"Order"
150 |       #   }
151 |       # }
152 | 


--------------------------------------------------------------------------------
/processMethod.py:
--------------------------------------------------------------------------------
  1 | #!/usr/bin/env python
  2 | # -*- coding: utf-8 -*-
  3 | from bs4 import BeautifulSoup
  4 | from processArguments import processArguments
  5 | import json
  6 | import sys
  7 | import re
  8 | 
  9 | #  Constants
 10 | REQUIRED_PERMISSIONS="Required permissions:"
 11 | NOTES = "Notes:"
 12 | 
 13 | debugPrint = False
 14 | 
 15 | #  Methods
 16 | def prepareNote(soup) :
 17 |   notes_line = soup.next_element
 18 |   aryNotes = []
 19 |   phrase = ''
 20 |   while notes_line != None :
 21 |     if NOTES not in notes_line  :
 22 |       if isinstance(notes_line, type(soup)) :
 23 |         phrase = ''.join(['\'' + ' '.join(notes_line.stripped_strings).strip() + '\''])
 24 |         aryNotes.append(phrase)
 25 |       else :
 26 |         phrase = notes_line.strip()
 27 |         aryNotes.append(phrase)
 28 | 
 29 |     notes_line = notes_line.next_sibling
 30 | 
 31 |   return ' '.join(aryNotes)
 32 | 
 33 | def fixFieldName(theField) :  # get first full word and if _id is a suffix make it a prefix
 34 |   split_field = theField.split()
 35 | 
 36 |   field = split_field[0]
 37 |   if "_id" in field :
 38 |     field = field.replace('_id', '')
 39 |     field = 'id{}'.format(field.title())
 40 | 
 41 |   if len(split_field) > 1 and "id" in split_field[1] :
 42 |     field = 'id{}'.format(field.title())
 43 | 
 44 |   return field
 45 | 
 46 | def preparePath(path, basePath) :  # detect/prepare and flag the contained path parmeters
 47 | 
 48 |   namePath = path.replace('[', '{').replace(']', '}').strip()
 49 |   namePath = namePath.replace(basePath, '')
 50 |   fields = []
 51 |   for span in re.finditer('\[(.*?)\]', path):
 52 |     aField = path[span.start()+1:span.end()-1]
 53 |     nameField = fixFieldName(aField)
 54 |     namePath = namePath.replace(aField, nameField)
 55 | #    print '{} - ({} vs {})'.format(namePath, aField, nameField)
 56 |     fields.append({nameField : aField})
 57 | 
 58 |   return {"namePath" : namePath, "fields" : fields }
 59 | 
 60 | 
 61 | 
 62 | http2crud = {'get' : 'get', 'post' : 'add', 'put' : 'update', 'delete' : 'delete'}
 63 | def makeOperationId(method, defPath) :  # get first full word and if _id is a suffix make it a prefix
 64 |   bits = defPath["namePath"].split('/')
 65 |   parms = []
 66 |   nouns = []
 67 |   for bit in bits :
 68 |     if '{' in bit :
 69 |       parm = bit.strip().replace('{', '').replace('}', '')
 70 |       parms.append('{}{}'.format(parm[:1].title(), parm[1:]))
 71 |     else :
 72 |       noun = bit.strip()
 73 |       nouns.append('{}{}'.format(noun[:1].title(), noun[1:]))
 74 | 
 75 |     parmClause = 'By'.join(parms)
 76 |     if len(parmClause) > 0 :
 77 |       parmClause = 'By{}'.format(parmClause)
 78 |     operationId = '{}{}{}'.format(http2crud[method], ''.join(nouns), parmClause)
 79 | 
 80 |   if debugPrint : print 'Operation Id : {}\n\n'.format(operationId)
 81 |   return operationId
 82 | 
 83 | 
 84 | def processMethod(soup, swagger, entity):
 85 | 
 86 |   '''
 87 |   print "# {}".format(soup)
 88 |   sys.exit()
 89 |   '''
 90 |   defPath = preparePath(soup.h2.span.text, swagger["basePath"])
 91 |   namePath = defPath["namePath"]
 92 |   nameMethod = soup.h2.next_element.lower().strip()
 93 | 
 94 | 
 95 |   cursor = {'entity' : entity, 'path' : namePath, 'method' : nameMethod}
 96 | 
 97 |   if cursor['entity'] == "cardxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
 98 |     and cursor['method'] == "delete":
 99 |       debugPrint = True
100 |   else:
101 |       debugPrint = False
102 | 
103 | 
104 |   print "Method : {}, Path : {}".format(nameMethod, namePath)
105 | #  if debugPrint : print "Method : {}, Path : {}".format(nameMethod, namePath)
106 | 
107 |   if   namePath not in swagger['paths'] :
108 |                                 swagger['paths'][namePath] = {}
109 |   if nameMethod not in swagger['paths'][namePath] :
110 |                     swagger['paths'][namePath][nameMethod] = {
111 |                         "responses" : {
112 |                           "200" : {
113 |                             "description" : "Success"
114 |                           },
115 |                           "400" : {
116 |                             "description" : "Server rejection"
117 |                           }
118 |                         },
119 |                         "tags" : [entity]
120 |                       }
121 | 
122 | 
123 |   swagger['paths'][namePath][nameMethod]['operationId'] = makeOperationId(nameMethod, defPath)
124 |   swagger['paths'][namePath][nameMethod]['summary'] = '{}()'.format(swagger['paths'][namePath][nameMethod]['operationId'])
125 | 
126 |   soup.h2.extract()
127 | 
128 |   if NOTES in soup.ul.li.next_element :
129 |     swagger['paths'][namePath][nameMethod]['description'] = prepareNote(soup.ul.li)
130 | #    print swagger['paths'][namePath][nameMethod]['description']
131 |     soup.ul.li.extract()
132 | 
133 |   if REQUIRED_PERMISSIONS in soup.ul.li.next_element :
134 |     permission = ' and'.join(''.join(soup.ul.li.stripped_strings).replace(REQUIRED_PERMISSIONS, '').rsplit(',', 1))
135 |     auth = ["read:boards"]
136 |     if "get" not in nameMethod : auth.append("write:boards")
137 |     swagger['paths'][namePath][nameMethod]['security'] = [ { "trello_auth": auth } ]
138 | #    print swagger['paths'][namePath][nameMethod]['security']
139 |     soup.ul.li.extract()
140 | 
141 |   arguments = soup.ul.li
142 | 
143 |   '''
144 |   print ' ---- '
145 |   print arguments
146 |   print ' ---- '
147 |   '''
148 | 
149 |   swagger['paths'][namePath][nameMethod]['parameters'] = []
150 |   processArguments(arguments, swagger, defPath["fields"], cursor)
151 | 
152 |   return
153 | 
154 | 
155 | 
156 | #  -   -   -   -   -   -   -   -   -   -   -
157 | #  Main routine (for testing)
158 | def main():
159 | 
160 |   from test.testdataMethod import test_values
161 |   from test.testdataMethod import swagger
162 |   from test.testdataMethod import sampleAPI
163 | 
164 |   idx = 0
165 |   for frag in test_values :
166 |     print(" - - - - - - - - - - - - - - ")
167 |     soup = BeautifulSoup(frag)
168 | #    if idx == 0 :
169 |     if idx != -1 :
170 |       processMethod(soup.body.contents[0], swagger, "OneOfTheTrelloEntities")
171 |     idx = idx + 1
172 | 
173 |   print(">>  - - - - - - - - - - ?  - - - - - - - - - - -<<")
174 |   print "JSON {}".format(json.dumps(swagger))
175 |   print("<< - - - - - - - - - - - - - - - - - - - - - - ->>")
176 | 
177 |   TrelloAPI = json.loads(sampleAPI)
178 |   TrelloAPI['paths'] = swagger['paths']
179 | 
180 |   # now write output to a file
181 |   TrelloAPI_json = open("TrelloAPI_test.json", "w")
182 |   TrelloAPI_json.write(json.dumps(TrelloAPI, indent=2, sort_keys=False))
183 |   TrelloAPI_json.close()
184 | 
185 | if __name__ == "__main__": main()
186 | 
187 | 


--------------------------------------------------------------------------------
/test/testdataArguments.py:
--------------------------------------------------------------------------------
  1 | #!/usr/bin/env python
  2 | # -*- coding: utf-8 -*-
  3 | 
  4 | #  Constants
  5 | swagger = {
  6 |   "paths": {
  7 |     "pth": {
  8 |       "mthd": {
  9 |        "parameters": []
 10 |       }
 11 |     }
 12 |   }
 13 | }
 14 | 
 15 | cursor = {'entity' : 'ent', 'path' : 'pth', 'method' : 'mthd'}
 16 | 
 17 | pathFields = [{'idOrg': 'idOrg or name'}, {'field': 'field'}]
 18 | 
 19 | test_values = []
 20 | test_values.append("""
 21 |   <ul class="simple">
 22 |     <li><strong>Required permissions:</strong> read</li>
 23 | 
 24 |     <li>
 25 |       <strong>Arguments</strong>
 26 | 
 27 |       <ul>
 28 |         <li>
 29 |           <code class="docutils literal"><span class="pre">display</span></code>
 30 |           (optional)
 31 | 
 32 |           <ul>
 33 |             <li><strong>Default:</strong> <code class="docutils literal"><span class=
 34 |             "pre">false</span></code></li>
 35 | 
 36 |             <li>
 37 |               <strong>Valid Values:</strong>
 38 | 
 39 |               <ul>
 40 |                 <li><code class="docutils literal"><span class=
 41 |                 "pre">true</span></code></li>
 42 | 
 43 |                 <li><code class="docutils literal"><span class=
 44 |                 "pre">false</span></code></li>
 45 |               </ul>
 46 |             </li>
 47 |           </ul>
 48 |         </li>
 49 | 
 50 |         <li>
 51 |           <code class="docutils literal"><span class="pre">entities</span></code>
 52 |           (optional)
 53 | 
 54 |           <ul>
 55 |             <li><strong>Default:</strong> <code class="docutils literal"><span class=
 56 |             "pre">false</span></code></li>
 57 | 
 58 |             <li>
 59 |               <strong>Valid Values:</strong>
 60 | 
 61 |               <ul>
 62 |                 <li><code class="docutils literal"><span class=
 63 |                 "pre">true</span></code></li>
 64 | 
 65 |                 <li><code class="docutils literal"><span class=
 66 |                 "pre">false</span></code></li>
 67 |               </ul>
 68 |             </li>
 69 |           </ul>
 70 |         </li>
 71 | 
 72 |         <li>
 73 |           <code class="docutils literal"><span class="pre">fields</span></code>
 74 |           (optional)
 75 | 
 76 |           <ul>
 77 |             <li><strong>Default:</strong> <code class="docutils literal"><span class=
 78 |             "pre">all</span></code></li>
 79 | 
 80 |             <li>
 81 |               <strong>Valid Values:</strong> <code class="docutils literal"><span class=
 82 |               "pre">all</span></code> or a comma-separated list of:
 83 | 
 84 |               <ul>
 85 |                 <li><code class="docutils literal"><span class=
 86 |                 "pre">data</span></code></li>
 87 | 
 88 |                 <li><code class="docutils literal"><span class=
 89 |                 "pre">date</span></code></li>
 90 | 
 91 |                 <li><code class="docutils literal"><span class=
 92 |                 "pre">idMemberCreator</span></code></li>
 93 | 
 94 |                 <li><code class="docutils literal"><span class=
 95 |                 "pre">type</span></code></li>
 96 |               </ul>
 97 |             </li>
 98 |           </ul>
 99 |         </li>
100 | 
101 |         <li>
102 |           <code class="docutils literal"><span class="pre">member</span></code>
103 |           (optional)
104 | 
105 |           <ul>
106 |             <li><strong>Default:</strong> <code class="docutils literal"><span class=
107 |             "pre">true</span></code></li>
108 | 
109 |             <li>
110 |               <strong>Valid Values:</strong>
111 | 
112 |               <ul>
113 |                 <li><code class="docutils literal"><span class=
114 |                 "pre">true</span></code></li>
115 | 
116 |                 <li><code class="docutils literal"><span class=
117 |                 "pre">false</span></code></li>
118 |               </ul>
119 |             </li>
120 |           </ul>
121 |         </li>
122 | 
123 |         <li>
124 |           <code class="docutils literal"><span class="pre">member_fields</span></code>
125 |           (optional)
126 | 
127 |           <ul>
128 |             <li><strong>Default:</strong> <code class="docutils literal"><span class=
129 |             "pre">avatarHash,fullName,initials,username</span></code></li>
130 | 
131 |             <li>
132 |               <strong>Valid Values:</strong> <code class="docutils literal"><span class=
133 |               "pre">all</span></code> or a comma-separated list of:
134 | 
135 |               <ul>
136 |                 <li><code class="docutils literal"><span class=
137 |                 "pre">avatarHash</span></code></li>
138 | 
139 |                 <li><code class="docutils literal"><span class=
140 |                 "pre">bio</span></code></li>
141 | 
142 |                 <li><code class="docutils literal"><span class=
143 |                 "pre">bioData</span></code></li>
144 | 
145 |                 <li><code class="docutils literal"><span class=
146 |                 "pre">confirmed</span></code></li>
147 | 
148 |                 <li><code class="docutils literal"><span class=
149 |                 "pre">fullName</span></code></li>
150 | 
151 |                 <li><code class="docutils literal"><span class=
152 |                 "pre">idPremOrgsAdmin</span></code></li>
153 | 
154 |                 <li><code class="docutils literal"><span class=
155 |                 "pre">initials</span></code></li>
156 | 
157 |                 <li><code class="docutils literal"><span class=
158 |                 "pre">memberType</span></code></li>
159 | 
160 |                 <li><code class="docutils literal"><span class=
161 |                 "pre">products</span></code></li>
162 | 
163 |                 <li><code class="docutils literal"><span class=
164 |                 "pre">status</span></code></li>
165 | 
166 |                 <li><code class="docutils literal"><span class=
167 |                 "pre">url</span></code></li>
168 | 
169 |                 <li><code class="docutils literal"><span class=
170 |                 "pre">username</span></code></li>
171 |               </ul>
172 |             </li>
173 |           </ul>
174 |         </li>
175 | 
176 |         <li>
177 |           <code class="docutils literal"><span class="pre">memberCreator</span></code>
178 |           (optional)
179 | 
180 |           <ul>
181 |             <li><strong>Default:</strong> <code class="docutils literal"><span class=
182 |             "pre">true</span></code></li>
183 | 
184 |             <li>
185 |               <strong>Valid Values:</strong>
186 | 
187 |               <ul>
188 |                 <li><code class="docutils literal"><span class=
189 |                 "pre">true</span></code></li>
190 | 
191 |                 <li><code class="docutils literal"><span class=
192 |                 "pre">false</span></code></li>
193 |               </ul>
194 |             </li>
195 |           </ul>
196 |         </li>
197 | 
198 |         <li>
199 |           <code class="docutils literal"><span class=
200 |           "pre">memberCreator_fields</span></code> (optional)
201 | 
202 |           <ul>
203 |             <li><strong>Default:</strong> <code class="docutils literal"><span class=
204 |             "pre">avatarHash,fullName,initials,username</span></code></li>
205 | 
206 |             <li>
207 |               <strong>Valid Values:</strong> <code class="docutils literal"><span class=
208 |               "pre">all</span></code> or a comma-separated list of:
209 | 
210 |               <ul>
211 |                 <li><code class="docutils literal"><span class=
212 |                 "pre">avatarHash</span></code></li>
213 | 
214 |                 <li><code class="docutils literal"><span class=
215 |                 "pre">bio</span></code></li>
216 | 
217 |                 <li><code class="docutils literal"><span class=
218 |                 "pre">bioData</span></code></li>
219 | 
220 |                 <li><code class="docutils literal"><span class=
221 |                 "pre">confirmed</span></code></li>
222 | 
223 |                 <li><code class="docutils literal"><span class=
224 |                 "pre">fullName</span></code></li>
225 | 
226 |                 <li><code class="docutils literal"><span class=
227 |                 "pre">idPremOrgsAdmin</span></code></li>
228 | 
229 |                 <li><code class="docutils literal"><span class=
230 |                 "pre">initials</span></code></li>
231 | 
232 |                 <li><code class="docutils literal"><span class=
233 |                 "pre">memberType</span></code></li>
234 | 
235 |                 <li><code class="docutils literal"><span class=
236 |                 "pre">products</span></code></li>
237 | 
238 |                 <li><code class="docutils literal"><span class=
239 |                 "pre">status</span></code></li>
240 | 
241 |                 <li><code class="docutils literal"><span class=
242 |                 "pre">url</span></code></li>
243 | 
244 |                 <li><code class="docutils literal"><span class=
245 |                 "pre">username</span></code></li>
246 |               </ul>
247 |             </li>
248 |           </ul>
249 |         </li>
250 |       </ul>
251 |     </li>
252 |   </ul>
253 | """)
254 | 
255 | '''
256 | test_values.append("""
257 | <li><strong>Arguments</strong>
258 |   <ul>
259 |     <li><code class="docutils literal"><span class="pre">idCustomSticker</span></code> (required)
260 |       <ul>
261 |         <li><strong>Valid Values:</strong> An id</li>
262 |       </ul>
263 |     </li>
264 |   </ul>
265 | </li>
266 | """)
267 | test_values.append("""
268 | <li><strong>Arguments</strong>
269 |   <ul>
270 |     <li><code class="docutils literal"><span class="pre">name</span></code> (required)
271 |       <ul>
272 |         <li><strong>Valid Values:</strong> a string with a length from <code class="docutils literal"><span class="pre">0</span></code> to <code class="docutils literal"><span class="pre">16384</span></code></li>
273 |       </ul>
274 |     </li>
275 |     <li><code class="docutils literal"><span class="pre">color</span></code> (required)
276 |       <ul>
277 |         <li><strong>Default:</strong> <code class="docutils literal"><span class="pre">name,closed,idOrganization,pinned</span></code></li>
278 |         <li><strong>Valid Values:</strong> A valid label color or <code class="docutils literal"><span class="pre">null</span></code></li>
279 |       </ul>
280 |     </li>
281 |     <li><code class="docutils literal"><span class="pre">idBoard</span></code> (optional)
282 |       <ul>
283 |         <li><strong>Default:</strong> <code class="docutils literal"><span class="pre">all</span></code></li>
284 |         <li><strong>Valid Values:</strong> An id</li>
285 |       </ul>
286 |     </li>
287 |   </ul>
288 | </li>
289 | """)
290 | 
291 | '''
292 | 


--------------------------------------------------------------------------------
/processModelName.py:
--------------------------------------------------------------------------------
  1 | #!/usr/bin/env python
  2 | import re
  3 | 
  4 | PATH_PATTERNS = []
  5 | PATH_EXTRACTOR = []
  6 | #  0
  7 | PATH_PATTERNS.append(re.compile('/[a-zA-Z]+/{[a-zA-Z]+}/[a-zA-Z]+/{[a-zA-Z]+}/[a-zA-Z]+/{[a-zA-Z]+}/[a-zA-Z]+$'))
  8 | PATH_EXTRACTOR.append(lambda path: "{}_{}_{}_{}".format(
  9 |   path.split('/')[1],
 10 |   path.split('/')[3],
 11 |   path.split('/')[5],
 12 |   path.split('/')[7]))
 13 | 
 14 | #  1
 15 | PATH_PATTERNS.append(re.compile('^/[a-zA-Z]+/{[a-zA-Z]+}/[a-zA-Z]+/{[a-zA-Z]+}/[a-zA-Z]+/{[a-zA-Z]+}$'))
 16 | PATH_EXTRACTOR.append(lambda path: "{}_{}_{}_{}".format(
 17 |   path.split('/')[1],
 18 |   path.split('/')[3],
 19 |   path.split('/')[4].replace("{", "").replace("}", ""),
 20 |   path.split('/')[5]))
 21 | 
 22 | #  2
 23 | PATH_PATTERNS.append(re.compile('^/[a-zA-Z]+/{[a-zA-Z]+}/[a-zA-Z]+/{[a-zA-Z]+}/[a-zA-Z]+$'))
 24 | PATH_EXTRACTOR.append(lambda path: "{}_{}_{}".format(
 25 |   path.split('/')[1],
 26 |   path.split('/')[3],
 27 |   path.split('/')[5]))
 28 | 
 29 | #  3
 30 | PATH_PATTERNS.append(re.compile('/[a-zA-Z]+/{[a-zA-Z]+}/[a-zA-Z]+/[a-zA-Z]+/[a-zA-Z]+$'))
 31 | PATH_EXTRACTOR.append(lambda path: "{}_{}".format(
 32 |   path.split('/')[3],
 33 |   path.split('/')[4]))
 34 | 
 35 | #  4
 36 | PATH_PATTERNS.append(re.compile('/[a-zA-Z]+/{[a-zA-Z]+}/[a-zA-Z]+/{[a-zA-Z]+}$'))
 37 | PATH_EXTRACTOR.append(lambda path: "{}_{}".format(
 38 |   path.split('/')[1],
 39 |   path.split('/')[3]))
 40 | 
 41 | #  5
 42 | PATH_PATTERNS.append(re.compile('/[a-zA-Z]+/{[a-zA-Z]+}/[a-zA-Z]+/[a-zA-Z]+$'))
 43 | PATH_EXTRACTOR.append(lambda path: "{}_{}".format(
 44 |   path.split('/')[3],
 45 |   path.split('/')[4]))
 46 | 
 47 | #  6
 48 | PATH_PATTERNS.append(re.compile('/[a-zA-Z]+/{[a-zA-Z]+}/[a-zA-Z]+$'))
 49 | PATH_EXTRACTOR.append(lambda path: "{}_{}".format(
 50 |   path.split('/')[1],
 51 |   path.split('/')[3]))
 52 | 
 53 | 
 54 | #  7
 55 | PATH_PATTERNS.append(re.compile('^/[a-zA-Z]+/[a-zA-Z]+/[a-zA-Z]+$'))
 56 | PATH_EXTRACTOR.append(lambda path: path.split('/')[1])
 57 | 
 58 | #  8
 59 | PATH_PATTERNS.append(re.compile('^/[a-zA-Z]+/{[a-zA-Z]+}$'))
 60 | PATH_EXTRACTOR.append(lambda path: path.split('/')[1])
 61 | 
 62 | #  9
 63 | PATH_PATTERNS.append(re.compile('^/[a-zA-Z]+/$'))
 64 | PATH_EXTRACTOR.append(lambda path: path.split('/')[1])
 65 | 
 66 | # 10
 67 | PATH_PATTERNS.append(re.compile('^/[a-zA-Z]+$'))
 68 | PATH_EXTRACTOR.append(lambda path: path.split('/')[1])
 69 | 
 70 | debugPrint = False
 71 | 
 72 | #  Methods
 73 | def determineModelName(path):
 74 | 
 75 |   modelName = ''
 76 |   idx = 0
 77 |   for pattern in PATH_PATTERNS :
 78 |     if pattern.match(path) :
 79 |       modelName = PATH_EXTRACTOR[idx](path)
 80 |       if idx == -999 :
 81 |         print "<####  {} -- {} || {} ####>".format(idx, modelName, path)
 82 | 
 83 |     idx = idx+1
 84 | 
 85 |   return modelName
 86 | 
 87 | #  -   -   -   -   -   -   -   -   -   -   -
 88 | #  Main routine (for testing)
 89 | def main():
 90 | 
 91 |   paths = []
 92 |   paths.append('/boards/{idBoard}/prefs/background')
 93 |   paths.append('/boards/{idBoard}/prefs/calendarFeedEnabled')
 94 |   paths.append('/boards/{idBoard}/prefs/cardAging')
 95 |   paths.append('/boards/{idBoard}/prefs/cardCovers')
 96 |   paths.append('/boards/{idBoard}/prefs/comments')
 97 |   paths.append('/boards/{idBoard}/prefs/invitations')
 98 |   paths.append('/boards/{idBoard}/prefs/permissionLevel')
 99 |   paths.append('/boards/{idBoard}/prefs/selfJoin')
100 |   paths.append('/boards/{idBoard}/prefs/voting')
101 |   paths.append('/boards/{idBoard}/calendarKey/generate')
102 |   paths.append('/boards/{idBoard}/labelNames/blue')
103 |   paths.append('/boards/{idBoard}/labelNames/green')
104 |   paths.append('/boards/{idBoard}/labelNames/orange')
105 |   paths.append('/boards/{idBoard}/labelNames/purple')
106 |   paths.append('/boards/{idBoard}/labelNames/red')
107 |   paths.append('/boards/{idBoard}/labelNames/yellow')
108 |   paths.append('/boards/{idBoard}/emailKey/generate')
109 |   paths.append('/boards/{idBoard}/myPrefs/emailPosition')
110 |   paths.append('/boards/{idBoard}/myPrefs/idEmailList')
111 |   paths.append('/boards/{idBoard}/myPrefs/showListGuide')
112 |   paths.append('/boards/{idBoard}/myPrefs/showSidebar')
113 |   paths.append('/boards/{idBoard}/myPrefs/showSidebarActivity')
114 |   paths.append('/boards/{idBoard}/myPrefs/showSidebarBoardActions')
115 |   paths.append('/boards/{idBoard}/myPrefs/showSidebarMembers')
116 | 
117 |   paths.append('/boards/{idBoard}/checklists')
118 |   paths.append('/boards/{idBoard}/labels')
119 |   paths.append('/boards/{idBoard}/lists')
120 |   paths.append('/boards/{idBoard}/closed')
121 |   paths.append('/boards/{idBoard}/desc')
122 |   paths.append('/boards/{idBoard}/idOrganization')
123 |   paths.append('/boards/{idBoard}/members')
124 |   paths.append('/boards/{idBoard}/name')
125 |   paths.append('/boards/{idBoard}/subscribed')
126 |   paths.append('/boards/{idBoard}/markAsViewed')
127 |   paths.append('/boards/{idBoard}/powerUps')
128 | 
129 |   paths.append('/boards/{idBoard}')
130 | 
131 |   paths.append('/boards')
132 | 
133 |   paths.append('/boards/{idBoard}/members/{idMember}')
134 |   paths.append('/boards/{idBoard}/memberships/{idMembership}')
135 |   paths.append('/boards/{idBoard}/members/{idMember}')
136 |   paths.append('/boards/{idBoard}/powerUps/{powerUp}')
137 | 
138 |   paths.append('/actions/{idAction}')
139 |   paths.append('/actions/{idAction}/text')
140 |   paths.append('/actions/{idAction}')
141 |   paths.append('/cards/{card}')
142 |   paths.append('/cards/{card}/actions/{idAction}/comments')
143 |   paths.append('/cards/{card}/checklist/{idChecklist}/checkItem/{idCheckItem}/name')
144 |   paths.append('/cards/{card}/checklist/{idChecklist}/checkItem/{idCheckItem}/pos')
145 |   paths.append('/cards/{card}/checklist/{idChecklist}/checkItem/{idCheckItem}/state')
146 |   paths.append('/cards/{card}/checklist/{idChecklistCurrent}/checkItem/{idCheckItem}')
147 |   paths.append('/cards/{card}/closed')
148 |   paths.append('/cards/{card}/desc')
149 |   paths.append('/cards/{card}/due')
150 |   paths.append('/cards/{card}/idAttachmentCover')
151 |   paths.append('/cards/{card}/idBoard')
152 |   paths.append('/cards/{card}/idList')
153 |   paths.append('/cards/{card}/idMembers')
154 |   paths.append('/cards/{card}/labels')
155 |   paths.append('/cards/{card}/name')
156 |   paths.append('/cards/{card}/pos')
157 |   paths.append('/cards/{card}/stickers/{idSticker}')
158 |   paths.append('/cards/{card}/subscribed')
159 |   paths.append('/cards')
160 |   paths.append('/cards/{card}/actions/comments')
161 |   paths.append('/cards/{card}/attachments')
162 |   paths.append('/cards/{card}/checklist/{idChecklist}/checkItem')
163 |   paths.append('/cards/{card}/checklist/{idChecklist}/checkItem/{idCheckItem}/convertToCard')
164 |   paths.append('/cards/{card}/checklists')
165 |   paths.append('/cards/{card}/idLabels')
166 |   paths.append('/cards/{card}/idMembers')
167 |   paths.append('/cards/{card}/labels')
168 |   paths.append('/cards/{card}/markAssociatedNotificationsRead')
169 |   paths.append('/cards/{card}/membersVoted')
170 |   paths.append('/cards/{card}/stickers')
171 |   paths.append('/cards/{card}')
172 |   paths.append('/cards/{card}/actions/{idAction}/comments')
173 |   paths.append('/cards/{card}/attachments/{idAttachment}')
174 |   paths.append('/cards/{card}/checklist/{idChecklist}/checkItem/{idCheckItem}')
175 |   paths.append('/cards/{card}/checklists/{idChecklist}')
176 |   paths.append('/cards/{card}/idLabels/{idLabel}')
177 |   paths.append('/cards/{card}/idMembers/{idMember}')
178 |   paths.append('/cards/{card}/labels/{color}')
179 |   paths.append('/cards/{card}/membersVoted/{idMember}')
180 |   paths.append('/cards/{card}/stickers/{idSticker}')
181 |   paths.append('/checklists/{idChecklist}')
182 |   paths.append('/checklists/{idChecklist}/idCard')
183 |   paths.append('/checklists/{idChecklist}/name')
184 |   paths.append('/checklists/{idChecklist}/pos')
185 |   paths.append('/checklists')
186 |   paths.append('/checklists/{idChecklist}/checkItems')
187 |   paths.append('/checklists/{idChecklist}')
188 |   paths.append('/checklists/{idChecklist}/checkItems/{idCheckItem}')
189 |   paths.append('/labels/{idLabel}')
190 |   paths.append('/labels/{idLabel}/color')
191 |   paths.append('/labels/{idLabel}/name')
192 |   paths.append('/labels')
193 |   paths.append('/labels/{idLabel}')
194 |   paths.append('/lists/{idList}')
195 |   paths.append('/lists/{idList}/closed')
196 |   paths.append('/lists/{idList}/idBoard')
197 |   paths.append('/lists/{idList}/name')
198 |   paths.append('/lists/{idList}/pos')
199 |   paths.append('/lists/{idList}/subscribed')
200 |   paths.append('/lists')
201 |   paths.append('/lists/{idList}/archiveAllCards')
202 |   paths.append('/lists/{idList}/cards')
203 |   paths.append('/lists/{idList}/moveAllCards')
204 |   paths.append('/members/{idMember}')
205 |   paths.append('/members/{idMember}/avatarSource')
206 |   paths.append('/members/{idMember}/bio')
207 |   paths.append('/members/{idMember}/boardBackgrounds/{idBoardBackground}')
208 |   paths.append('/members/{idMember}/boardStars/{idBoardStar}')
209 |   paths.append('/members/{idMember}/boardStars/{idBoardStar}/idBoard')
210 |   paths.append('/members/{idMember}/boardStars/{idBoardStar}/pos')
211 |   paths.append('/members/{idMember}/customBoardBackgrounds/{idBoardBackground}')
212 |   paths.append('/members/{idMember}/fullName')
213 |   paths.append('/members/{idMember}/initials')
214 |   paths.append('/members/{idMember}/prefs/colorBlind')
215 |   paths.append('/members/{idMember}/prefs/locale')
216 |   paths.append('/members/{idMember}/prefs/minutesBetweenSummaries')
217 |   paths.append('/members/{idMember}/savedSearches/{idSavedSearch}')
218 |   paths.append('/members/{idMember}/savedSearches/{idSavedSearch}/name')
219 |   paths.append('/members/{idMember}/savedSearches/{idSavedSearch}/pos')
220 |   paths.append('/members/{idMember}/savedSearches/{idSavedSearch}/query')
221 |   paths.append('/members/{idMember}/username')
222 |   paths.append('/members/{idMember}/avatar')
223 |   paths.append('/members/{idMember}/boardBackgrounds')
224 |   paths.append('/members/{idMember}/boardStars')
225 |   paths.append('/members/{idMember}/customBoardBackgrounds')
226 |   paths.append('/members/{idMember}/customEmoji')
227 |   paths.append('/members/{idMember}/customStickers')
228 |   paths.append('/members/{idMember}/oneTimeMessagesDismissed')
229 |   paths.append('/members/{idMember}/savedSearches')
230 |   paths.append('/members/{idMember}/boardBackgrounds/{idBoardBackground}')
231 |   paths.append('/members/{idMember}/boardStars/{idBoardStar}')
232 |   paths.append('/members/{idMember}/customBoardBackgrounds/{idBoardBackground}')
233 |   paths.append('/members/{idMember}/customStickers/{idCustomSticker}')
234 |   paths.append('/members/{idMember}/savedSearches/{idSavedSearch}')
235 |   paths.append('/notifications/{idNotification}')
236 |   paths.append('/notifications/{idNotification}/unread')
237 |   paths.append('/notifications/all/read')
238 |   paths.append('/organizations/{idOrg}')
239 |   paths.append('/organizations/{idOrg}/desc')
240 |   paths.append('/organizations/{idOrg}/displayName')
241 |   paths.append('/organizations/{idOrg}/members')
242 |   paths.append('/organizations/{idOrg}/members/{idMember}')
243 |   paths.append('/organizations/{idOrg}/members/{idMember}/deactivated')
244 |   paths.append('/organizations/{idOrg}/memberships/{idMembership}')
245 |   paths.append('/organizations/{idOrg}/name')
246 |   paths.append('/organizations/{idOrg}/prefs/associatedDomain')
247 |   paths.append('/organizations/{idOrg}/prefs/boardVisibilityRestrict/org')
248 |   paths.append('/organizations/{idOrg}/prefs/boardVisibilityRestrict/private')
249 |   paths.append('/organizations/{idOrg}/prefs/boardVisibilityRestrict/public')
250 |   paths.append('/organizations/{idOrg}/prefs/externalMembersDisabled')
251 |   paths.append('/organizations/{idOrg}/prefs/googleAppsVersion')
252 |   paths.append('/organizations/{idOrg}/prefs/orgInviteRestrict')
253 |   paths.append('/organizations/{idOrg}/prefs/permissionLevel')
254 |   paths.append('/organizations/{idOrg}/website')
255 |   paths.append('/organizations')
256 |   paths.append('/organizations/{idOrg}/logo')
257 |   paths.append('/organizations/{idOrg}')
258 |   paths.append('/organizations/{idOrg}/logo')
259 |   paths.append('/organizations/{idOrg}/members/{idMember}')
260 |   paths.append('/organizations/{idOrg}/members/{idMember}/all')
261 |   paths.append('/organizations/{idOrg}/prefs/associatedDomain')
262 |   paths.append('/organizations/{idOrg}/prefs/orgInviteRestrict')
263 |   paths.append('/sessions/{idSession}')
264 |   paths.append('/sessions/{idSession}/status')
265 |   paths.append('/sessions')
266 |   paths.append('/tokens/{token}/webhooks')
267 |   paths.append('/tokens/{token}/webhooks')
268 |   paths.append('/tokens/{token}')
269 |   paths.append('/tokens/{token}/webhooks/{idWebhook}')
270 |   paths.append('/webhooks/{idWebhook}')
271 |   paths.append('/webhooks/')
272 |   paths.append('/webhooks/{idWebhook}/active')
273 |   paths.append('/webhooks/{idWebhook}/callbackURL')
274 |   paths.append('/webhooks/{idWebhook}/description')
275 |   paths.append('/webhooks/{idWebhook}/idModel')
276 |   paths.append('/webhooks')
277 |   paths.append('/webhooks/{idWebhook}')
278 | 
279 |   pat = re.compile('^/[a-zA-Z]+/[a-zA-Z]+/[a-zA-Z]+$')
280 | 
281 |   # cnt = 1
282 |   # for pattern in PATH_PATTERNS :
283 |   #   idx = 0
284 |   #   for path in paths :
285 |   #     mm = pattern.match(path)
286 |   #     if mm :
287 |   #       print(">>~~~~~ {} -- {}   {} ~~~~<<".format(cnt, idx, path))
288 |   #       # if cnt == 8 : print(">> ,\"{}\" <<".format(path.split('/')[1]))
289 |   #       # if cnt == 8 : print(">> ,\"{}\" <<".format(pat.match(path).group(0)))
290 |   #     idx = idx+1
291 |   #   cnt = cnt+1
292 | 
293 |   cnt = 1
294 |   tot = 0
295 |   for path in paths :
296 |     idx = 0
297 |     for pattern in PATH_PATTERNS :
298 |       mm = pattern.match(path)
299 |       if mm :
300 |         tot = tot+1
301 |         print(">>~~~~~ {}/{} -- {}   {} ~~~~<<".format(cnt, tot, idx, path))
302 |       idx = idx+1
303 |     cnt = cnt+1
304 | 
305 |   print("\n>>~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~<<\n")
306 | 
307 | 
308 | 
309 | if __name__ == "__main__": main()
310 | 
311 | 


--------------------------------------------------------------------------------
/test/testdataMethod.py:
--------------------------------------------------------------------------------
   1 | #!/usr/bin/env python
   2 | # -*- coding: utf-8 -*-
   3 | 
   4 | #  Constants
   5 | swagger = {
   6 |       "paths": {}
   7 | }
   8 | 
   9 | test_values = []
  10 | test_values.append("""
  11 | <div class="section" id="get-1-members-idmember-or-username">
  12 |   <h2>GET <span class="target" id="members-idmember-or-username">/1/members/[idMember or username]</span><a class="headerlink" href="https://trello.com/docs/api/member/index.html#get-1-members-idmember-or-username" title="Permalink to this headline">¶</a></h2>
  13 |   <ul class="simple">
  14 |     <li><strong>Notes:</strong> If you specify <code class="docutils literal"><span class="pre">me</span></code> as the username, this call will respond as if you had supplied the username associated with the supplied token</li>
  15 |     <li><strong>Required permissions:</strong> read</li>
  16 |     
  17 |     <li><strong>Arguments</strong>
  18 |       <ul>
  19 |         <li><code class="docutils literal"><span class="pre">name</span></code> (required)
  20 |           <ul>
  21 |             <li><strong>Valid Values:</strong> a string with a length from <code class="docutils literal"><span class="pre">0</span></code> to <code class="docutils literal"><span class="pre">16384</span></code></li>
  22 |           </ul>
  23 |         </li>
  24 |         <li><code class="docutils literal"><span class="pre">color</span></code> (required)
  25 |           <ul>
  26 |             <li><strong>Default:</strong> <code class="docutils literal"><span class="pre">name,closed,idOrganization,pinned</span></code></li>
  27 |             <li><strong>Valid Values:</strong> A valid label color or <code class="docutils literal"><span class="pre">null</span></code></li>
  28 |           </ul>
  29 |         </li>
  30 |         <li><code class="docutils literal"><span class="pre">idBoard</span></code> (optional)
  31 |           <ul>
  32 |             <li><strong>Default:</strong> <code class="docutils literal"><span class="pre">all</span></code></li>
  33 |             <li><strong>Valid Values:</strong> An id</li>
  34 |           </ul>
  35 |         </li>
  36 |       </ul>
  37 |     </li>
  38 | 
  39 | 
  40 |     <li><strong>Examples</strong></li>
  41 |   </ul>
  42 |   <div class="highlight-URL">
  43 |     <div class="highlight">
  44 |       <pre>https://api.trello.com/1/members/bobtester?fields=username,fullName,url&amp;boards=all&amp;board_fields=name&amp;organizations=all&amp;organization_fields=displayName&amp;key=[application_key]&amp;token=[optional_auth_token]</pre>
  45 |     </div>
  46 |   </div>
  47 |   <div class="highlight-JavaScript">
  48 |     <div class="highlight">
  49 |       <pre>
  50 |         <span class="p">{</span>
  51 |         <span class="s2">"id"</span>
  52 |         <span class="o">:</span> <span class="s2">"4ee7df1be582acdec80000ae"</span><span class="p">,</span>
  53 |         <span class="s2">"username"</span><span class="o">:</span> <span class="s2">"bobtester"</span><span class="p">,</span>
  54 |         <span class="s2">"fullName"</span><span class="o">:</span> <span class="s2">"Bob Tester"</span><span class="p">,</span>
  55 |         <span class="s2">"url"</span><span class="o">:</span> <span class="s2">"https://trello.com/bobtester"</span><span class="p">,</span>
  56 |         <span class="s2">"organizations"</span><span class="o">:</span> <span class="p">[],</span>
  57 |         <span class="s2">"boards"</span><span class="o">:</span> <span class="p">[{</span>
  58 |             <span class="s2">"name"</span><span class="o">:</span> <span class="s2">"Example Board"</span><span class="p">,</span>
  59 |             <span class="s2">"id"</span><span class="o">:</span> <span class="s2">"4eea4ffc91e31d1746000046"</span>
  60 |         <span class="p">},</span> <span class="p">{</span>
  61 |             <span class="s2">"name"</span><span class="o">:</span> <span class="s2">"Public Board"</span><span class="p">,</span>
  62 |             <span class="s2">"id"</span><span class="o">:</span> <span class="s2">"4ee7e707e582acdec800051a"</span>
  63 |         <span class="p">}]</span> <span class="p">}</span>
  64 |       </pre>
  65 |     </div>
  66 |   </div>
  67 | </div>
  68 | """)
  69 | test_values.append("""
  70 | <div class="section" id="get-1-members-idmember-or-username">
  71 |   <h2>GET <span class="target" id="members-idmember-or-username">/1/members/[idMember or username]</span><a class="headerlink" href="https://trello.com/docs/api/member/index.html#get-1-members-idmember-or-username" title="Permalink to this headline">¶</a></h2>
  72 |   <ul class="simple">
  73 |     <li><strong>Notes:</strong> If you specify <code class="docutils literal"><span class="pre">me</span></code> as the username, this call will respond as if you had supplied the username associated with the supplied token</li>
  74 |     <li><strong>Required permissions:</strong> read</li>
  75 |     <li><strong>Arguments</strong>
  76 |       <ul>
  77 |         <li><code class="docutils literal"><span class="pre">XXXXXXX</span></code> (required)
  78 |           <ul>
  79 |             <li><strong>Default:</strong> <code class="docutils literal"><span class="pre">name,closed,idOrganization,pinned</span></code></li>
  80 |             <li><strong>Valid Values:</strong> <code class="docutils literal"><span class="pre">all</span></code> or a comma-separated list of:
  81 |               <ul>
  82 |                 <li><code class="docutils literal"><span class="pre">addAttachmentToCard</span></code></li>
  83 |                 <li><code class="docutils literal"><span class="pre">addChecklistToCard</span></code></li>
  84 |               </ul>
  85 |             </li>
  86 |           </ul>
  87 |         </li>
  88 |         <li><code class="docutils literal"><span class="pre">actions</span></code> (optional)
  89 |           <ul>
  90 |             <li><strong>Valid Values:</strong> <code class="docutils literal"><span class="pre">all</span></code> or a comma-separated list of:
  91 |               <ul>
  92 |                 <li><code class="docutils literal"><span class="pre">addAttachmentToCard</span></code></li>
  93 |                 <li><code class="docutils literal"><span class="pre">addChecklistToCard</span></code></li>
  94 |               </ul>
  95 |             </li>
  96 |           </ul>
  97 |         </li>
  98 |       </ul>
  99 |     </li>
 100 |     <li><strong>Examples</strong></li>
 101 |   </ul>
 102 |   <div class="highlight-URL">
 103 |     <div class="highlight">
 104 |       <pre>https://api.trello.com/1/members/bobtester?fields=username,fullName,url&amp;boards=all&amp;board_fields=name&amp;organizations=all&amp;organization_fields=displayName&amp;key=[application_key]&amp;token=[optional_auth_token]</pre>
 105 |     </div>
 106 |   </div>
 107 |   <div class="highlight-JavaScript">
 108 |     <div class="highlight">
 109 |       <pre>
 110 |         <span class="p">{</span>
 111 |         <span class="s2">"id"</span>
 112 |         <span class="o">:</span> <span class="s2">"4ee7df1be582acdec80000ae"</span><span class="p">,</span>
 113 |         <span class="s2">"username"</span><span class="o">:</span> <span class="s2">"bobtester"</span><span class="p">,</span>
 114 |         <span class="s2">"fullName"</span><span class="o">:</span> <span class="s2">"Bob Tester"</span><span class="p">,</span>
 115 |         <span class="s2">"url"</span><span class="o">:</span> <span class="s2">"https://trello.com/bobtester"</span><span class="p">,</span>
 116 |         <span class="s2">"organizations"</span><span class="o">:</span> <span class="p">[],</span>
 117 |         <span class="s2">"boards"</span><span class="o">:</span> <span class="p">[{</span>
 118 |             <span class="s2">"name"</span><span class="o">:</span> <span class="s2">"Example Board"</span><span class="p">,</span>
 119 |             <span class="s2">"id"</span><span class="o">:</span> <span class="s2">"4eea4ffc91e31d1746000046"</span>
 120 |         <span class="p">},</span> <span class="p">{</span>
 121 |             <span class="s2">"name"</span><span class="o">:</span> <span class="s2">"Public Board"</span><span class="p">,</span>
 122 |             <span class="s2">"id"</span><span class="o">:</span> <span class="s2">"4ee7e707e582acdec800051a"</span>
 123 |         <span class="p">}]</span> <span class="p">}</span>
 124 |       </pre>
 125 |     </div>
 126 |   </div>
 127 | </div>
 128 | """)
 129 | test_values.append("""
 130 | <div class="section" id="get-1-members-idmember-or-username">
 131 | <h2>GET <span class="target" id="members-idmember-or-username">/1/members/[idMember or username]</span><a class="headerlink" href="https://trello.com/docs/api/member/index.html#get-1-members-idmember-or-username" title="Permalink to this headline">¶</a></h2>
 132 | <ul class="simple">
 133 | <li><strong>Notes:</strong> If you specify <code class="docutils literal"><span class="pre">me</span></code> as the username, this call will respond as if you had supplied the username associated with the supplied token</li>
 134 | <li><strong>Required permissions:</strong> read</li>
 135 | <li><strong>Arguments</strong><ul>
 136 | <li><code class="docutils literal"><span class="pre">actions</span></code> (optional)<ul>
 137 | <li><strong>Valid Values:</strong> <code class="docutils literal"><span class="pre">all</span></code> or a comma-separated list of:<ul>
 138 | <li><code class="docutils literal"><span class="pre">addAttachmentToCard</span></code></li>
 139 | <li><code class="docutils literal"><span class="pre">addChecklistToCard</span></code></li>
 140 | <li><code class="docutils literal"><span class="pre">addMemberToBoard</span></code></li>
 141 | <li><code class="docutils literal"><span class="pre">addMemberToCard</span></code></li>
 142 | <li><code class="docutils literal"><span class="pre">addMemberToOrganization</span></code></li>
 143 | <li><code class="docutils literal"><span class="pre">addToOrganizationBoard</span></code></li>
 144 | <li><code class="docutils literal"><span class="pre">commentCard</span></code></li>
 145 | <li><code class="docutils literal"><span class="pre">convertToCardFromCheckItem</span></code></li>
 146 | <li><code class="docutils literal"><span class="pre">copyBoard</span></code></li>
 147 | <li><code class="docutils literal"><span class="pre">copyCard</span></code></li>
 148 | <li><code class="docutils literal"><span class="pre">copyCommentCard</span></code></li>
 149 | <li><code class="docutils literal"><span class="pre">createBoard</span></code></li>
 150 | <li><code class="docutils literal"><span class="pre">createCard</span></code></li>
 151 | <li><code class="docutils literal"><span class="pre">createList</span></code></li>
 152 | <li><code class="docutils literal"><span class="pre">createOrganization</span></code></li>
 153 | <li><code class="docutils literal"><span class="pre">deleteAttachmentFromCard</span></code></li>
 154 | <li><code class="docutils literal"><span class="pre">deleteBoardInvitation</span></code></li>
 155 | <li><code class="docutils literal"><span class="pre">deleteCard</span></code></li>
 156 | <li><code class="docutils literal"><span class="pre">deleteOrganizationInvitation</span></code></li>
 157 | <li><code class="docutils literal"><span class="pre">disablePowerUp</span></code></li>
 158 | <li><code class="docutils literal"><span class="pre">emailCard</span></code></li>
 159 | <li><code class="docutils literal"><span class="pre">enablePowerUp</span></code></li>
 160 | <li><code class="docutils literal"><span class="pre">makeAdminOfBoard</span></code></li>
 161 | <li><code class="docutils literal"><span class="pre">makeNormalMemberOfBoard</span></code></li>
 162 | <li><code class="docutils literal"><span class="pre">makeNormalMemberOfOrganization</span></code></li>
 163 | <li><code class="docutils literal"><span class="pre">makeObserverOfBoard</span></code></li>
 164 | <li><code class="docutils literal"><span class="pre">memberJoinedTrello</span></code></li>
 165 | <li><code class="docutils literal"><span class="pre">moveCardFromBoard</span></code></li>
 166 | <li><code class="docutils literal"><span class="pre">moveCardToBoard</span></code></li>
 167 | <li><code class="docutils literal"><span class="pre">moveListFromBoard</span></code></li>
 168 | <li><code class="docutils literal"><span class="pre">moveListToBoard</span></code></li>
 169 | <li><code class="docutils literal"><span class="pre">removeChecklistFromCard</span></code></li>
 170 | <li><code class="docutils literal"><span class="pre">removeFromOrganizationBoard</span></code></li>
 171 | <li><code class="docutils literal"><span class="pre">removeMemberFromCard</span></code></li>
 172 | <li><code class="docutils literal"><span class="pre">unconfirmedBoardInvitation</span></code></li>
 173 | <li><code class="docutils literal"><span class="pre">unconfirmedOrganizationInvitation</span></code></li>
 174 | <li><code class="docutils literal"><span class="pre">updateBoard</span></code></li>
 175 | <li><code class="docutils literal"><span class="pre">updateCard</span></code></li>
 176 | <li><code class="docutils literal"><span class="pre">updateCard:closed</span></code></li>
 177 | <li><code class="docutils literal"><span class="pre">updateCard:desc</span></code></li>
 178 | <li><code class="docutils literal"><span class="pre">updateCard:idList</span></code></li>
 179 | <li><code class="docutils literal"><span class="pre">updateCard:name</span></code></li>
 180 | <li><code class="docutils literal"><span class="pre">updateCheckItemStateOnCard</span></code></li>
 181 | <li><code class="docutils literal"><span class="pre">updateChecklist</span></code></li>
 182 | <li><code class="docutils literal"><span class="pre">updateList</span></code></li>
 183 | <li><code class="docutils literal"><span class="pre">updateList:closed</span></code></li>
 184 | <li><code class="docutils literal"><span class="pre">updateList:name</span></code></li>
 185 | <li><code class="docutils literal"><span class="pre">updateMember</span></code></li>
 186 | <li><code class="docutils literal"><span class="pre">updateOrganization</span></code></li>
 187 | </ul>
 188 | </li>
 189 | </ul>
 190 | </li>
 191 | <li><code class="docutils literal"><span class="pre">actions_entities</span></code> (optional)<ul>
 192 | <li><strong>Default:</strong> <code class="docutils literal"><span class="pre">false</span></code></li>
 193 | <li><strong>Valid Values:</strong><ul>
 194 | <li><code class="docutils literal"><span class="pre">true</span></code></li>
 195 | <li><code class="docutils literal"><span class="pre">false</span></code></li>
 196 | </ul>
 197 | </li>
 198 | </ul>
 199 | </li>
 200 | <li><code class="docutils literal"><span class="pre">actions_display</span></code> (optional)<ul>
 201 | <li><strong>Default:</strong> <code class="docutils literal"><span class="pre">false</span></code></li>
 202 | <li><strong>Valid Values:</strong><ul>
 203 | <li><code class="docutils literal"><span class="pre">true</span></code></li>
 204 | <li><code class="docutils literal"><span class="pre">false</span></code></li>
 205 | </ul>
 206 | </li>
 207 | </ul>
 208 | </li>
 209 | <li><code class="docutils literal"><span class="pre">actions_limit</span></code> (optional)<ul>
 210 | <li><strong>Default:</strong> <code class="docutils literal"><span class="pre">50</span></code></li>
 211 | <li><strong>Valid Values:</strong> a number from <code class="docutils literal"><span class="pre">0</span></code> to <code class="docutils literal"><span class="pre">1000</span></code></li>
 212 | </ul>
 213 | </li>
 214 | <li><code class="docutils literal"><span class="pre">action_fields</span></code> (optional)<ul>
 215 | <li><strong>Default:</strong> <code class="docutils literal"><span class="pre">all</span></code></li>
 216 | <li><strong>Valid Values:</strong> <code class="docutils literal"><span class="pre">all</span></code> or a comma-separated list of:<ul>
 217 | <li><code class="docutils literal"><span class="pre">data</span></code></li>
 218 | <li><code class="docutils literal"><span class="pre">date</span></code></li>
 219 | <li><code class="docutils literal"><span class="pre">idMemberCreator</span></code></li>
 220 | <li><code class="docutils literal"><span class="pre">type</span></code></li>
 221 | </ul>
 222 | </li>
 223 | </ul>
 224 | </li>
 225 | <li><code class="docutils literal"><span class="pre">action_since</span></code> (optional)<ul>
 226 | <li><strong>Valid Values:</strong> A date, <code class="docutils literal"><span class="pre">null</span></code> or <code class="docutils literal"><span class="pre">lastView</span></code></li>
 227 | </ul>
 228 | </li>
 229 | <li><code class="docutils literal"><span class="pre">action_before</span></code> (optional)<ul>
 230 | <li><strong>Valid Values:</strong> A date, or <code class="docutils literal"><span class="pre">null</span></code></li>
 231 | </ul>
 232 | </li>
 233 | <li><code class="docutils literal"><span class="pre">cards</span></code> (optional)<ul>
 234 | <li><strong>Default:</strong> <code class="docutils literal"><span class="pre">none</span></code></li>
 235 | <li><strong>Valid Values:</strong> One of:<ul>
 236 | <li><code class="docutils literal"><span class="pre">all</span></code></li>
 237 | <li><code class="docutils literal"><span class="pre">closed</span></code></li>
 238 | <li><code class="docutils literal"><span class="pre">none</span></code></li>
 239 | <li><code class="docutils literal"><span class="pre">open</span></code></li>
 240 | <li><code class="docutils literal"><span class="pre">visible</span></code></li>
 241 | </ul>
 242 | </li>
 243 | </ul>
 244 | </li>
 245 | <li><code class="docutils literal"><span class="pre">card_fields</span></code> (optional)<ul>
 246 | <li><strong>Default:</strong> <code class="docutils literal"><span class="pre">all</span></code></li>
 247 | <li><strong>Valid Values:</strong> <code class="docutils literal"><span class="pre">all</span></code> or a comma-separated list of:<ul>
 248 | <li><code class="docutils literal"><span class="pre">badges</span></code></li>
 249 | <li><code class="docutils literal"><span class="pre">checkItemStates</span></code></li>
 250 | <li><code class="docutils literal"><span class="pre">closed</span></code></li>
 251 | <li><code class="docutils literal"><span class="pre">dateLastActivity</span></code></li>
 252 | <li><code class="docutils literal"><span class="pre">desc</span></code></li>
 253 | <li><code class="docutils literal"><span class="pre">descData</span></code></li>
 254 | <li><code class="docutils literal"><span class="pre">due</span></code></li>
 255 | <li><code class="docutils literal"><span class="pre">email</span></code></li>
 256 | <li><code class="docutils literal"><span class="pre">idAttachmentCover</span></code></li>
 257 | <li><code class="docutils literal"><span class="pre">idBoard</span></code></li>
 258 | <li><code class="docutils literal"><span class="pre">idChecklists</span></code></li>
 259 | <li><code class="docutils literal"><span class="pre">idLabels</span></code></li>
 260 | <li><code class="docutils literal"><span class="pre">idList</span></code></li>
 261 | <li><code class="docutils literal"><span class="pre">idMembers</span></code></li>
 262 | <li><code class="docutils literal"><span class="pre">idMembersVoted</span></code></li>
 263 | <li><code class="docutils literal"><span class="pre">idShort</span></code></li>
 264 | <li><code class="docutils literal"><span class="pre">labels</span></code></li>
 265 | <li><code class="docutils literal"><span class="pre">manualCoverAttachment</span></code></li>
 266 | <li><code class="docutils literal"><span class="pre">name</span></code></li>
 267 | <li><code class="docutils literal"><span class="pre">pos</span></code></li>
 268 | <li><code class="docutils literal"><span class="pre">shortLink</span></code></li>
 269 | <li><code class="docutils literal"><span class="pre">shortUrl</span></code></li>
 270 | <li><code class="docutils literal"><span class="pre">subscribed</span></code></li>
 271 | <li><code class="docutils literal"><span class="pre">url</span></code></li>
 272 | </ul>
 273 | </li>
 274 | </ul>
 275 | </li>
 276 | <li><code class="docutils literal"><span class="pre">card_members</span></code> (optional)<ul>
 277 | <li><strong>Default:</strong> <code class="docutils literal"><span class="pre">false</span></code></li>
 278 | <li><strong>Valid Values:</strong><ul>
 279 | <li><code class="docutils literal"><span class="pre">true</span></code></li>
 280 | <li><code class="docutils literal"><span class="pre">false</span></code></li>
 281 | </ul>
 282 | </li>
 283 | </ul>
 284 | </li>
 285 | <li><code class="docutils literal"><span class="pre">card_member_fields</span></code> (optional)<ul>
 286 | <li><strong>Default:</strong> <code class="docutils literal"><span class="pre">avatarHash,fullName,initials,username</span></code></li>
 287 | <li><strong>Valid Values:</strong> <code class="docutils literal"><span class="pre">all</span></code> or a comma-separated list of:<ul>
 288 | <li><code class="docutils literal"><span class="pre">avatarHash</span></code></li>
 289 | <li><code class="docutils literal"><span class="pre">bio</span></code></li>
 290 | <li><code class="docutils literal"><span class="pre">bioData</span></code></li>
 291 | <li><code class="docutils literal"><span class="pre">confirmed</span></code></li>
 292 | <li><code class="docutils literal"><span class="pre">fullName</span></code></li>
 293 | <li><code class="docutils literal"><span class="pre">idPremOrgsAdmin</span></code></li>
 294 | <li><code class="docutils literal"><span class="pre">initials</span></code></li>
 295 | <li><code class="docutils literal"><span class="pre">memberType</span></code></li>
 296 | <li><code class="docutils literal"><span class="pre">products</span></code></li>
 297 | <li><code class="docutils literal"><span class="pre">status</span></code></li>
 298 | <li><code class="docutils literal"><span class="pre">url</span></code></li>
 299 | <li><code class="docutils literal"><span class="pre">username</span></code></li>
 300 | </ul>
 301 | </li>
 302 | </ul>
 303 | </li>
 304 | <li><code class="docutils literal"><span class="pre">card_attachments</span></code> (optional)<ul>
 305 | <li><strong>Default:</strong> <code class="docutils literal"><span class="pre">false</span></code></li>
 306 | <li><strong>Valid Values:</strong> A boolean value or &amp;quot;cover&amp;quot; for only card cover attachments</li>
 307 | </ul>
 308 | </li>
 309 | <li><code class="docutils literal"><span class="pre">card_attachment_fields</span></code> (optional)<ul>
 310 | <li><strong>Default:</strong> <code class="docutils literal"><span class="pre">url,previews</span></code></li>
 311 | <li><strong>Valid Values:</strong> <code class="docutils literal"><span class="pre">all</span></code> or a comma-separated list of:<ul>
 312 | <li><code class="docutils literal"><span class="pre">bytes</span></code></li>
 313 | <li><code class="docutils literal"><span class="pre">date</span></code></li>
 314 | <li><code class="docutils literal"><span class="pre">edgeColor</span></code></li>
 315 | <li><code class="docutils literal"><span class="pre">idMember</span></code></li>
 316 | <li><code class="docutils literal"><span class="pre">isUpload</span></code></li>
 317 | <li><code class="docutils literal"><span class="pre">mimeType</span></code></li>
 318 | <li><code class="docutils literal"><span class="pre">name</span></code></li>
 319 | <li><code class="docutils literal"><span class="pre">previews</span></code></li>
 320 | <li><code class="docutils literal"><span class="pre">url</span></code></li>
 321 | </ul>
 322 | </li>
 323 | </ul>
 324 | </li>
 325 | <li><code class="docutils literal"><span class="pre">card_stickers</span></code> (optional)<ul>
 326 | <li><strong>Default:</strong> <code class="docutils literal"><span class="pre">false</span></code></li>
 327 | <li><strong>Valid Values:</strong><ul>
 328 | <li><code class="docutils literal"><span class="pre">true</span></code></li>
 329 | <li><code class="docutils literal"><span class="pre">false</span></code></li>
 330 | </ul>
 331 | </li>
 332 | </ul>
 333 | </li>
 334 | <li><code class="docutils literal"><span class="pre">boards</span></code> (optional)<ul>
 335 | <li><strong>Valid Values:</strong> <code class="docutils literal"><span class="pre">all</span></code> or a comma-separated list of:<ul>
 336 | <li><code class="docutils literal"><span class="pre">closed</span></code></li>
 337 | <li><code class="docutils literal"><span class="pre">members</span></code></li>
 338 | <li><code class="docutils literal"><span class="pre">open</span></code></li>
 339 | <li><code class="docutils literal"><span class="pre">organization</span></code></li>
 340 | <li><code class="docutils literal"><span class="pre">pinned</span></code></li>
 341 | <li><code class="docutils literal"><span class="pre">public</span></code></li>
 342 | <li><code class="docutils literal"><span class="pre">starred</span></code></li>
 343 | <li><code class="docutils literal"><span class="pre">unpinned</span></code></li>
 344 | </ul>
 345 | </li>
 346 | </ul>
 347 | </li>
 348 | <li><code class="docutils literal"><span class="pre">board_fields</span></code> (optional)<ul>
 349 | <li><strong>Default:</strong> <code class="docutils literal"><span class="pre">name,closed,idOrganization,pinned</span></code></li>
 350 | <li><strong>Valid Values:</strong> <code class="docutils literal"><span class="pre">all</span></code> or a comma-separated list of:<ul>
 351 | <li><code class="docutils literal"><span class="pre">closed</span></code></li>
 352 | <li><code class="docutils literal"><span class="pre">dateLastActivity</span></code></li>
 353 | <li><code class="docutils literal"><span class="pre">dateLastView</span></code></li>
 354 | <li><code class="docutils literal"><span class="pre">desc</span></code></li>
 355 | <li><code class="docutils literal"><span class="pre">descData</span></code></li>
 356 | <li><code class="docutils literal"><span class="pre">idOrganization</span></code></li>
 357 | <li><code class="docutils literal"><span class="pre">invitations</span></code></li>
 358 | <li><code class="docutils literal"><span class="pre">invited</span></code></li>
 359 | <li><code class="docutils literal"><span class="pre">labelNames</span></code></li>
 360 | <li><code class="docutils literal"><span class="pre">memberships</span></code></li>
 361 | <li><code class="docutils literal"><span class="pre">name</span></code></li>
 362 | <li><code class="docutils literal"><span class="pre">pinned</span></code></li>
 363 | <li><code class="docutils literal"><span class="pre">powerUps</span></code></li>
 364 | <li><code class="docutils literal"><span class="pre">prefs</span></code></li>
 365 | <li><code class="docutils literal"><span class="pre">shortLink</span></code></li>
 366 | <li><code class="docutils literal"><span class="pre">shortUrl</span></code></li>
 367 | <li><code class="docutils literal"><span class="pre">starred</span></code></li>
 368 | <li><code class="docutils literal"><span class="pre">subscribed</span></code></li>
 369 | <li><code class="docutils literal"><span class="pre">url</span></code></li>
 370 | </ul>
 371 | </li>
 372 | </ul>
 373 | </li>
 374 | <li><code class="docutils literal"><span class="pre">board_actions</span></code> (optional)<ul>
 375 | <li><strong>Valid Values:</strong> <code class="docutils literal"><span class="pre">all</span></code> or a comma-separated list of:<ul>
 376 | <li><code class="docutils literal"><span class="pre">addAttachmentToCard</span></code></li>
 377 | <li><code class="docutils literal"><span class="pre">addChecklistToCard</span></code></li>
 378 | <li><code class="docutils literal"><span class="pre">addMemberToBoard</span></code></li>
 379 | <li><code class="docutils literal"><span class="pre">addMemberToCard</span></code></li>
 380 | <li><code class="docutils literal"><span class="pre">addMemberToOrganization</span></code></li>
 381 | <li><code class="docutils literal"><span class="pre">addToOrganizationBoard</span></code></li>
 382 | <li><code class="docutils literal"><span class="pre">commentCard</span></code></li>
 383 | <li><code class="docutils literal"><span class="pre">convertToCardFromCheckItem</span></code></li>
 384 | <li><code class="docutils literal"><span class="pre">copyBoard</span></code></li>
 385 | <li><code class="docutils literal"><span class="pre">copyCard</span></code></li>
 386 | <li><code class="docutils literal"><span class="pre">copyCommentCard</span></code></li>
 387 | <li><code class="docutils literal"><span class="pre">createBoard</span></code></li>
 388 | <li><code class="docutils literal"><span class="pre">createCard</span></code></li>
 389 | <li><code class="docutils literal"><span class="pre">createList</span></code></li>
 390 | <li><code class="docutils literal"><span class="pre">createOrganization</span></code></li>
 391 | <li><code class="docutils literal"><span class="pre">deleteAttachmentFromCard</span></code></li>
 392 | <li><code class="docutils literal"><span class="pre">deleteBoardInvitation</span></code></li>
 393 | <li><code class="docutils literal"><span class="pre">deleteCard</span></code></li>
 394 | <li><code class="docutils literal"><span class="pre">deleteOrganizationInvitation</span></code></li>
 395 | <li><code class="docutils literal"><span class="pre">disablePowerUp</span></code></li>
 396 | <li><code class="docutils literal"><span class="pre">emailCard</span></code></li>
 397 | <li><code class="docutils literal"><span class="pre">enablePowerUp</span></code></li>
 398 | <li><code class="docutils literal"><span class="pre">makeAdminOfBoard</span></code></li>
 399 | <li><code class="docutils literal"><span class="pre">makeNormalMemberOfBoard</span></code></li>
 400 | <li><code class="docutils literal"><span class="pre">makeNormalMemberOfOrganization</span></code></li>
 401 | <li><code class="docutils literal"><span class="pre">makeObserverOfBoard</span></code></li>
 402 | <li><code class="docutils literal"><span class="pre">memberJoinedTrello</span></code></li>
 403 | <li><code class="docutils literal"><span class="pre">moveCardFromBoard</span></code></li>
 404 | <li><code class="docutils literal"><span class="pre">moveCardToBoard</span></code></li>
 405 | <li><code class="docutils literal"><span class="pre">moveListFromBoard</span></code></li>
 406 | <li><code class="docutils literal"><span class="pre">moveListToBoard</span></code></li>
 407 | <li><code class="docutils literal"><span class="pre">removeChecklistFromCard</span></code></li>
 408 | <li><code class="docutils literal"><span class="pre">removeFromOrganizationBoard</span></code></li>
 409 | <li><code class="docutils literal"><span class="pre">removeMemberFromCard</span></code></li>
 410 | <li><code class="docutils literal"><span class="pre">unconfirmedBoardInvitation</span></code></li>
 411 | <li><code class="docutils literal"><span class="pre">unconfirmedOrganizationInvitation</span></code></li>
 412 | <li><code class="docutils literal"><span class="pre">updateBoard</span></code></li>
 413 | <li><code class="docutils literal"><span class="pre">updateCard</span></code></li>
 414 | <li><code class="docutils literal"><span class="pre">updateCard:closed</span></code></li>
 415 | <li><code class="docutils literal"><span class="pre">updateCard:desc</span></code></li>
 416 | <li><code class="docutils literal"><span class="pre">updateCard:idList</span></code></li>
 417 | <li><code class="docutils literal"><span class="pre">updateCard:name</span></code></li>
 418 | <li><code class="docutils literal"><span class="pre">updateCheckItemStateOnCard</span></code></li>
 419 | <li><code class="docutils literal"><span class="pre">updateChecklist</span></code></li>
 420 | <li><code class="docutils literal"><span class="pre">updateList</span></code></li>
 421 | <li><code class="docutils literal"><span class="pre">updateList:closed</span></code></li>
 422 | <li><code class="docutils literal"><span class="pre">updateList:name</span></code></li>
 423 | <li><code class="docutils literal"><span class="pre">updateMember</span></code></li>
 424 | <li><code class="docutils literal"><span class="pre">updateOrganization</span></code></li>
 425 | </ul>
 426 | </li>
 427 | </ul>
 428 | </li>
 429 | <li><code class="docutils literal"><span class="pre">board_actions_entities</span></code> (optional)<ul>
 430 | <li><strong>Default:</strong> <code class="docutils literal"><span class="pre">false</span></code></li>
 431 | <li><strong>Valid Values:</strong><ul>
 432 | <li><code class="docutils literal"><span class="pre">true</span></code></li>
 433 | <li><code class="docutils literal"><span class="pre">false</span></code></li>
 434 | </ul>
 435 | </li>
 436 | </ul>
 437 | </li>
 438 | <li><code class="docutils literal"><span class="pre">board_actions_display</span></code> (optional)<ul>
 439 | <li><strong>Default:</strong> <code class="docutils literal"><span class="pre">false</span></code></li>
 440 | <li><strong>Valid Values:</strong><ul>
 441 | <li><code class="docutils literal"><span class="pre">true</span></code></li>
 442 | <li><code class="docutils literal"><span class="pre">false</span></code></li>
 443 | </ul>
 444 | </li>
 445 | </ul>
 446 | </li>
 447 | <li><code class="docutils literal"><span class="pre">board_actions_format</span></code> (optional)<ul>
 448 | <li><strong>Default:</strong> <code class="docutils literal"><span class="pre">list</span></code></li>
 449 | <li><strong>Valid Values:</strong> One of:<ul>
 450 | <li><code class="docutils literal"><span class="pre">count</span></code></li>
 451 | <li><code class="docutils literal"><span class="pre">list</span></code></li>
 452 | <li><code class="docutils literal"><span class="pre">minimal</span></code></li>
 453 | </ul>
 454 | </li>
 455 | </ul>
 456 | </li>
 457 | <li><code class="docutils literal"><span class="pre">board_actions_since</span></code> (optional)<ul>
 458 | <li><strong>Valid Values:</strong> A date, <code class="docutils literal"><span class="pre">null</span></code> or <code class="docutils literal"><span class="pre">lastView</span></code></li>
 459 | </ul>
 460 | </li>
 461 | <li><code class="docutils literal"><span class="pre">board_actions_limit</span></code> (optional)<ul>
 462 | <li><strong>Default:</strong> <code class="docutils literal"><span class="pre">50</span></code></li>
 463 | <li><strong>Valid Values:</strong> a number from <code class="docutils literal"><span class="pre">0</span></code> to <code class="docutils literal"><span class="pre">1000</span></code></li>
 464 | </ul>
 465 | </li>
 466 | <li><code class="docutils literal"><span class="pre">board_action_fields</span></code> (optional)<ul>
 467 | <li><strong>Default:</strong> <code class="docutils literal"><span class="pre">all</span></code></li>
 468 | <li><strong>Valid Values:</strong> <code class="docutils literal"><span class="pre">all</span></code> or a comma-separated list of:<ul>
 469 | <li><code class="docutils literal"><span class="pre">data</span></code></li>
 470 | <li><code class="docutils literal"><span class="pre">date</span></code></li>
 471 | <li><code class="docutils literal"><span class="pre">idMemberCreator</span></code></li>
 472 | <li><code class="docutils literal"><span class="pre">type</span></code></li>
 473 | </ul>
 474 | </li>
 475 | </ul>
 476 | </li>
 477 | <li><code class="docutils literal"><span class="pre">board_lists</span></code> (optional)<ul>
 478 | <li><strong>Default:</strong> <code class="docutils literal"><span class="pre">none</span></code></li>
 479 | <li><strong>Valid Values:</strong> One of:<ul>
 480 | <li><code class="docutils literal"><span class="pre">all</span></code></li>
 481 | <li><code class="docutils literal"><span class="pre">closed</span></code></li>
 482 | <li><code class="docutils literal"><span class="pre">none</span></code></li>
 483 | <li><code class="docutils literal"><span class="pre">open</span></code></li>
 484 | </ul>
 485 | </li>
 486 | </ul>
 487 | </li>
 488 | <li><code class="docutils literal"><span class="pre">board_memberships</span></code> (optional)<ul>
 489 | <li><strong>Default:</strong> <code class="docutils literal"><span class="pre">none</span></code></li>
 490 | <li><strong>Valid Values:</strong> <code class="docutils literal"><span class="pre">all</span></code> or a comma-separated list of:<ul>
 491 | <li><code class="docutils literal"><span class="pre">active</span></code></li>
 492 | <li><code class="docutils literal"><span class="pre">admin</span></code></li>
 493 | <li><code class="docutils literal"><span class="pre">deactivated</span></code></li>
 494 | <li><code class="docutils literal"><span class="pre">me</span></code></li>
 495 | <li><code class="docutils literal"><span class="pre">normal</span></code></li>
 496 | </ul>
 497 | </li>
 498 | </ul>
 499 | </li>
 500 | <li><code class="docutils literal"><span class="pre">board_organization</span></code> (optional)<ul>
 501 | <li><strong>Default:</strong> <code class="docutils literal"><span class="pre">false</span></code></li>
 502 | <li><strong>Valid Values:</strong><ul>
 503 | <li><code class="docutils literal"><span class="pre">true</span></code></li>
 504 | <li><code class="docutils literal"><span class="pre">false</span></code></li>
 505 | </ul>
 506 | </li>
 507 | </ul>
 508 | </li>
 509 | <li><code class="docutils literal"><span class="pre">board_organization_fields</span></code> (optional)<ul>
 510 | <li><strong>Default:</strong> <code class="docutils literal"><span class="pre">name,displayName</span></code></li>
 511 | <li><strong>Valid Values:</strong> <code class="docutils literal"><span class="pre">all</span></code> or a comma-separated list of:<ul>
 512 | <li><code class="docutils literal"><span class="pre">billableMemberCount</span></code></li>
 513 | <li><code class="docutils literal"><span class="pre">desc</span></code></li>
 514 | <li><code class="docutils literal"><span class="pre">descData</span></code></li>
 515 | <li><code class="docutils literal"><span class="pre">displayName</span></code></li>
 516 | <li><code class="docutils literal"><span class="pre">idBoards</span></code></li>
 517 | <li><code class="docutils literal"><span class="pre">invitations</span></code></li>
 518 | <li><code class="docutils literal"><span class="pre">invited</span></code></li>
 519 | <li><code class="docutils literal"><span class="pre">logoHash</span></code></li>
 520 | <li><code class="docutils literal"><span class="pre">memberships</span></code></li>
 521 | <li><code class="docutils literal"><span class="pre">name</span></code></li>
 522 | <li><code class="docutils literal"><span class="pre">powerUps</span></code></li>
 523 | <li><code class="docutils literal"><span class="pre">prefs</span></code></li>
 524 | <li><code class="docutils literal"><span class="pre">premiumFeatures</span></code></li>
 525 | <li><code class="docutils literal"><span class="pre">products</span></code></li>
 526 | <li><code class="docutils literal"><span class="pre">url</span></code></li>
 527 | <li><code class="docutils literal"><span class="pre">website</span></code></li>
 528 | </ul>
 529 | </li>
 530 | </ul>
 531 | </li>
 532 | <li><code class="docutils literal"><span class="pre">boardsInvited</span></code> (optional)<ul>
 533 | <li><strong>Valid Values:</strong> <code class="docutils literal"><span class="pre">all</span></code> or a comma-separated list of:<ul>
 534 | <li><code class="docutils literal"><span class="pre">closed</span></code></li>
 535 | <li><code class="docutils literal"><span class="pre">members</span></code></li>
 536 | <li><code class="docutils literal"><span class="pre">open</span></code></li>
 537 | <li><code class="docutils literal"><span class="pre">organization</span></code></li>
 538 | <li><code class="docutils literal"><span class="pre">pinned</span></code></li>
 539 | <li><code class="docutils literal"><span class="pre">public</span></code></li>
 540 | <li><code class="docutils literal"><span class="pre">starred</span></code></li>
 541 | <li><code class="docutils literal"><span class="pre">unpinned</span></code></li>
 542 | </ul>
 543 | </li>
 544 | </ul>
 545 | </li>
 546 | <li><code class="docutils literal"><span class="pre">boardsInvited_fields</span></code> (optional)<ul>
 547 | <li><strong>Default:</strong> <code class="docutils literal"><span class="pre">name,closed,idOrganization,pinned</span></code></li>
 548 | <li><strong>Valid Values:</strong> <code class="docutils literal"><span class="pre">all</span></code> or a comma-separated list of:<ul>
 549 | <li><code class="docutils literal"><span class="pre">closed</span></code></li>
 550 | <li><code class="docutils literal"><span class="pre">dateLastActivity</span></code></li>
 551 | <li><code class="docutils literal"><span class="pre">dateLastView</span></code></li>
 552 | <li><code class="docutils literal"><span class="pre">desc</span></code></li>
 553 | <li><code class="docutils literal"><span class="pre">descData</span></code></li>
 554 | <li><code class="docutils literal"><span class="pre">idOrganization</span></code></li>
 555 | <li><code class="docutils literal"><span class="pre">invitations</span></code></li>
 556 | <li><code class="docutils literal"><span class="pre">invited</span></code></li>
 557 | <li><code class="docutils literal"><span class="pre">labelNames</span></code></li>
 558 | <li><code class="docutils literal"><span class="pre">memberships</span></code></li>
 559 | <li><code class="docutils literal"><span class="pre">name</span></code></li>
 560 | <li><code class="docutils literal"><span class="pre">pinned</span></code></li>
 561 | <li><code class="docutils literal"><span class="pre">powerUps</span></code></li>
 562 | <li><code class="docutils literal"><span class="pre">prefs</span></code></li>
 563 | <li><code class="docutils literal"><span class="pre">shortLink</span></code></li>
 564 | <li><code class="docutils literal"><span class="pre">shortUrl</span></code></li>
 565 | <li><code class="docutils literal"><span class="pre">starred</span></code></li>
 566 | <li><code class="docutils literal"><span class="pre">subscribed</span></code></li>
 567 | <li><code class="docutils literal"><span class="pre">url</span></code></li>
 568 | </ul>
 569 | </li>
 570 | </ul>
 571 | </li>
 572 | <li><code class="docutils literal"><span class="pre">boardStars</span></code> (optional)<ul>
 573 | <li><strong>Default:</strong> <code class="docutils literal"><span class="pre">false</span></code></li>
 574 | <li><strong>Valid Values:</strong><ul>
 575 | <li><code class="docutils literal"><span class="pre">true</span></code></li>
 576 | <li><code class="docutils literal"><span class="pre">false</span></code></li>
 577 | </ul>
 578 | </li>
 579 | </ul>
 580 | </li>
 581 | <li><code class="docutils literal"><span class="pre">savedSearches</span></code> (optional)<ul>
 582 | <li><strong>Default:</strong> <code class="docutils literal"><span class="pre">false</span></code></li>
 583 | <li><strong>Valid Values:</strong><ul>
 584 | <li><code class="docutils literal"><span class="pre">true</span></code></li>
 585 | <li><code class="docutils literal"><span class="pre">false</span></code></li>
 586 | </ul>
 587 | </li>
 588 | </ul>
 589 | </li>
 590 | <li><code class="docutils literal"><span class="pre">organizations</span></code> (optional)<ul>
 591 | <li><strong>Default:</strong> <code class="docutils literal"><span class="pre">none</span></code></li>
 592 | <li><strong>Valid Values:</strong> One of:<ul>
 593 | <li><code class="docutils literal"><span class="pre">all</span></code></li>
 594 | <li><code class="docutils literal"><span class="pre">members</span></code></li>
 595 | <li><code class="docutils literal"><span class="pre">none</span></code></li>
 596 | <li><code class="docutils literal"><span class="pre">public</span></code></li>
 597 | </ul>
 598 | </li>
 599 | </ul>
 600 | </li>
 601 | <li><code class="docutils literal"><span class="pre">organization_fields</span></code> (optional)<ul>
 602 | <li><strong>Default:</strong> <code class="docutils literal"><span class="pre">all</span></code></li>
 603 | <li><strong>Valid Values:</strong> <code class="docutils literal"><span class="pre">all</span></code> or a comma-separated list of:<ul>
 604 | <li><code class="docutils literal"><span class="pre">billableMemberCount</span></code></li>
 605 | <li><code class="docutils literal"><span class="pre">desc</span></code></li>
 606 | <li><code class="docutils literal"><span class="pre">descData</span></code></li>
 607 | <li><code class="docutils literal"><span class="pre">displayName</span></code></li>
 608 | <li><code class="docutils literal"><span class="pre">idBoards</span></code></li>
 609 | <li><code class="docutils literal"><span class="pre">invitations</span></code></li>
 610 | <li><code class="docutils literal"><span class="pre">invited</span></code></li>
 611 | <li><code class="docutils literal"><span class="pre">logoHash</span></code></li>
 612 | <li><code class="docutils literal"><span class="pre">memberships</span></code></li>
 613 | <li><code class="docutils literal"><span class="pre">name</span></code></li>
 614 | <li><code class="docutils literal"><span class="pre">powerUps</span></code></li>
 615 | <li><code class="docutils literal"><span class="pre">prefs</span></code></li>
 616 | <li><code class="docutils literal"><span class="pre">premiumFeatures</span></code></li>
 617 | <li><code class="docutils literal"><span class="pre">products</span></code></li>
 618 | <li><code class="docutils literal"><span class="pre">url</span></code></li>
 619 | <li><code class="docutils literal"><span class="pre">website</span></code></li>
 620 | </ul>
 621 | </li>
 622 | </ul>
 623 | </li>
 624 | <li><code class="docutils literal"><span class="pre">organization_paid_account</span></code> (optional)<ul>
 625 | <li><strong>Default:</strong> <code class="docutils literal"><span class="pre">false</span></code></li>
 626 | <li><strong>Valid Values:</strong><ul>
 627 | <li><code class="docutils literal"><span class="pre">true</span></code></li>
 628 | <li><code class="docutils literal"><span class="pre">false</span></code></li>
 629 | </ul>
 630 | </li>
 631 | </ul>
 632 | </li>
 633 | <li><code class="docutils literal"><span class="pre">organizationsInvited</span></code> (optional)<ul>
 634 | <li><strong>Default:</strong> <code class="docutils literal"><span class="pre">none</span></code></li>
 635 | <li><strong>Valid Values:</strong> One of:<ul>
 636 | <li><code class="docutils literal"><span class="pre">all</span></code></li>
 637 | <li><code class="docutils literal"><span class="pre">members</span></code></li>
 638 | <li><code class="docutils literal"><span class="pre">none</span></code></li>
 639 | <li><code class="docutils literal"><span class="pre">public</span></code></li>
 640 | </ul>
 641 | </li>
 642 | </ul>
 643 | </li>
 644 | <li><code class="docutils literal"><span class="pre">organizationsInvited_fields</span></code> (optional)<ul>
 645 | <li><strong>Default:</strong> <code class="docutils literal"><span class="pre">all</span></code></li>
 646 | <li><strong>Valid Values:</strong> <code class="docutils literal"><span class="pre">all</span></code> or a comma-separated list of:<ul>
 647 | <li><code class="docutils literal"><span class="pre">billableMemberCount</span></code></li>
 648 | <li><code class="docutils literal"><span class="pre">desc</span></code></li>
 649 | <li><code class="docutils literal"><span class="pre">descData</span></code></li>
 650 | <li><code class="docutils literal"><span class="pre">displayName</span></code></li>
 651 | <li><code class="docutils literal"><span class="pre">idBoards</span></code></li>
 652 | <li><code class="docutils literal"><span class="pre">invitations</span></code></li>
 653 | <li><code class="docutils literal"><span class="pre">invited</span></code></li>
 654 | <li><code class="docutils literal"><span class="pre">logoHash</span></code></li>
 655 | <li><code class="docutils literal"><span class="pre">memberships</span></code></li>
 656 | <li><code class="docutils literal"><span class="pre">name</span></code></li>
 657 | <li><code class="docutils literal"><span class="pre">powerUps</span></code></li>
 658 | <li><code class="docutils literal"><span class="pre">prefs</span></code></li>
 659 | <li><code class="docutils literal"><span class="pre">premiumFeatures</span></code></li>
 660 | <li><code class="docutils literal"><span class="pre">products</span></code></li>
 661 | <li><code class="docutils literal"><span class="pre">url</span></code></li>
 662 | <li><code class="docutils literal"><span class="pre">website</span></code></li>
 663 | </ul>
 664 | </li>
 665 | </ul>
 666 | </li>
 667 | <li><code class="docutils literal"><span class="pre">notifications</span></code> (optional)<ul>
 668 | <li><strong>Valid Values:</strong> <code class="docutils literal"><span class="pre">all</span></code> or a comma-separated list of:<ul>
 669 | <li><code class="docutils literal"><span class="pre">addAdminToBoard</span></code></li>
 670 | <li><code class="docutils literal"><span class="pre">addAdminToOrganization</span></code></li>
 671 | <li><code class="docutils literal"><span class="pre">addedAttachmentToCard</span></code></li>
 672 | <li><code class="docutils literal"><span class="pre">addedMemberToCard</span></code></li>
 673 | <li><code class="docutils literal"><span class="pre">addedToBoard</span></code></li>
 674 | <li><code class="docutils literal"><span class="pre">addedToCard</span></code></li>
 675 | <li><code class="docutils literal"><span class="pre">addedToOrganization</span></code></li>
 676 | <li><code class="docutils literal"><span class="pre">cardDueSoon</span></code></li>
 677 | <li><code class="docutils literal"><span class="pre">changeCard</span></code></li>
 678 | <li><code class="docutils literal"><span class="pre">closeBoard</span></code></li>
 679 | <li><code class="docutils literal"><span class="pre">commentCard</span></code></li>
 680 | <li><code class="docutils literal"><span class="pre">createdCard</span></code></li>
 681 | <li><code class="docutils literal"><span class="pre">declinedInvitationToBoard</span></code></li>
 682 | <li><code class="docutils literal"><span class="pre">declinedInvitationToOrganization</span></code></li>
 683 | <li><code class="docutils literal"><span class="pre">invitedToBoard</span></code></li>
 684 | <li><code class="docutils literal"><span class="pre">invitedToOrganization</span></code></li>
 685 | <li><code class="docutils literal"><span class="pre">makeAdminOfBoard</span></code></li>
 686 | <li><code class="docutils literal"><span class="pre">makeAdminOfOrganization</span></code></li>
 687 | <li><code class="docutils literal"><span class="pre">memberJoinedTrello</span></code></li>
 688 | <li><code class="docutils literal"><span class="pre">mentionedOnCard</span></code></li>
 689 | <li><code class="docutils literal"><span class="pre">removedFromBoard</span></code></li>
 690 | <li><code class="docutils literal"><span class="pre">removedFromCard</span></code></li>
 691 | <li><code class="docutils literal"><span class="pre">removedFromOrganization</span></code></li>
 692 | <li><code class="docutils literal"><span class="pre">removedMemberFromCard</span></code></li>
 693 | <li><code class="docutils literal"><span class="pre">unconfirmedInvitedToBoard</span></code></li>
 694 | <li><code class="docutils literal"><span class="pre">unconfirmedInvitedToOrganization</span></code></li>
 695 | <li><code class="docutils literal"><span class="pre">updateCheckItemStateOnCard</span></code></li>
 696 | </ul>
 697 | </li>
 698 | </ul>
 699 | </li>
 700 | <li><code class="docutils literal"><span class="pre">notifications_entities</span></code> (optional)<ul>
 701 | <li><strong>Default:</strong> <code class="docutils literal"><span class="pre">false</span></code></li>
 702 | <li><strong>Valid Values:</strong><ul>
 703 | <li><code class="docutils literal"><span class="pre">true</span></code></li>
 704 | <li><code class="docutils literal"><span class="pre">false</span></code></li>
 705 | </ul>
 706 | </li>
 707 | </ul>
 708 | </li>
 709 | <li><code class="docutils literal"><span class="pre">notifications_display</span></code> (optional)<ul>
 710 | <li><strong>Default:</strong> <code class="docutils literal"><span class="pre">false</span></code></li>
 711 | <li><strong>Valid Values:</strong><ul>
 712 | <li><code class="docutils literal"><span class="pre">true</span></code></li>
 713 | <li><code class="docutils literal"><span class="pre">false</span></code></li>
 714 | </ul>
 715 | </li>
 716 | </ul>
 717 | </li>
 718 | <li><code class="docutils literal"><span class="pre">notifications_limit</span></code> (optional)<ul>
 719 | <li><strong>Default:</strong> <code class="docutils literal"><span class="pre">50</span></code></li>
 720 | <li><strong>Valid Values:</strong> a number from <code class="docutils literal"><span class="pre">1</span></code> to <code class="docutils literal"><span class="pre">1000</span></code></li>
 721 | </ul>
 722 | </li>
 723 | <li><code class="docutils literal"><span class="pre">notification_fields</span></code> (optional)<ul>
 724 | <li><strong>Default:</strong> <code class="docutils literal"><span class="pre">all</span></code></li>
 725 | <li><strong>Valid Values:</strong> <code class="docutils literal"><span class="pre">all</span></code> or a comma-separated list of:<ul>
 726 | <li><code class="docutils literal"><span class="pre">data</span></code></li>
 727 | <li><code class="docutils literal"><span class="pre">date</span></code></li>
 728 | <li><code class="docutils literal"><span class="pre">idMemberCreator</span></code></li>
 729 | <li><code class="docutils literal"><span class="pre">type</span></code></li>
 730 | <li><code class="docutils literal"><span class="pre">unread</span></code></li>
 731 | </ul>
 732 | </li>
 733 | </ul>
 734 | </li>
 735 | <li><code class="docutils literal"><span class="pre">notification_memberCreator</span></code> (optional)<ul>
 736 | <li><strong>Default:</strong> <code class="docutils literal"><span class="pre">true</span></code></li>
 737 | <li><strong>Valid Values:</strong><ul>
 738 | <li><code class="docutils literal"><span class="pre">true</span></code></li>
 739 | <li><code class="docutils literal"><span class="pre">false</span></code></li>
 740 | </ul>
 741 | </li>
 742 | </ul>
 743 | </li>
 744 | <li><code class="docutils literal"><span class="pre">notification_memberCreator_fields</span></code> (optional)<ul>
 745 | <li><strong>Default:</strong> <code class="docutils literal"><span class="pre">avatarHash,fullName,initials,username</span></code></li>
 746 | <li><strong>Valid Values:</strong> <code class="docutils literal"><span class="pre">all</span></code> or a comma-separated list of:<ul>
 747 | <li><code class="docutils literal"><span class="pre">avatarHash</span></code></li>
 748 | <li><code class="docutils literal"><span class="pre">bio</span></code></li>
 749 | <li><code class="docutils literal"><span class="pre">bioData</span></code></li>
 750 | <li><code class="docutils literal"><span class="pre">confirmed</span></code></li>
 751 | <li><code class="docutils literal"><span class="pre">fullName</span></code></li>
 752 | <li><code class="docutils literal"><span class="pre">idPremOrgsAdmin</span></code></li>
 753 | <li><code class="docutils literal"><span class="pre">initials</span></code></li>
 754 | <li><code class="docutils literal"><span class="pre">memberType</span></code></li>
 755 | <li><code class="docutils literal"><span class="pre">products</span></code></li>
 756 | <li><code class="docutils literal"><span class="pre">status</span></code></li>
 757 | <li><code class="docutils literal"><span class="pre">url</span></code></li>
 758 | <li><code class="docutils literal"><span class="pre">username</span></code></li>
 759 | </ul>
 760 | </li>
 761 | </ul>
 762 | </li>
 763 | <li><code class="docutils literal"><span class="pre">notification_before</span></code> (optional)<ul>
 764 | <li><strong>Valid Values:</strong> An id, or <code class="docutils literal"><span class="pre">null</span></code></li>
 765 | </ul>
 766 | </li>
 767 | <li><code class="docutils literal"><span class="pre">notification_since</span></code> (optional)<ul>
 768 | <li><strong>Valid Values:</strong> An id, or <code class="docutils literal"><span class="pre">null</span></code></li>
 769 | </ul>
 770 | </li>
 771 | <li><code class="docutils literal"><span class="pre">tokens</span></code> (optional)<ul>
 772 | <li><strong>Default:</strong> <code class="docutils literal"><span class="pre">none</span></code></li>
 773 | <li><strong>Valid Values:</strong> One of:<ul>
 774 | <li><code class="docutils literal"><span class="pre">all</span></code></li>
 775 | <li><code class="docutils literal"><span class="pre">none</span></code></li>
 776 | </ul>
 777 | </li>
 778 | </ul>
 779 | </li>
 780 | <li><code class="docutils literal"><span class="pre">paid_account</span></code> (optional)<ul>
 781 | <li><strong>Default:</strong> <code class="docutils literal"><span class="pre">false</span></code></li>
 782 | <li><strong>Valid Values:</strong><ul>
 783 | <li><code class="docutils literal"><span class="pre">true</span></code></li>
 784 | <li><code class="docutils literal"><span class="pre">false</span></code></li>
 785 | </ul>
 786 | </li>
 787 | </ul>
 788 | </li>
 789 | <li><code class="docutils literal"><span class="pre">boardBackgrounds</span></code> (optional)<ul>
 790 | <li><strong>Default:</strong> <code class="docutils literal"><span class="pre">none</span></code></li>
 791 | <li><strong>Valid Values:</strong> One of:<ul>
 792 | <li><code class="docutils literal"><span class="pre">all</span></code></li>
 793 | <li><code class="docutils literal"><span class="pre">custom</span></code></li>
 794 | <li><code class="docutils literal"><span class="pre">default</span></code></li>
 795 | <li><code class="docutils literal"><span class="pre">none</span></code></li>
 796 | <li><code class="docutils literal"><span class="pre">premium</span></code></li>
 797 | </ul>
 798 | </li>
 799 | </ul>
 800 | </li>
 801 | <li><code class="docutils literal"><span class="pre">customBoardBackgrounds</span></code> (optional)<ul>
 802 | <li><strong>Default:</strong> <code class="docutils literal"><span class="pre">none</span></code></li>
 803 | <li><strong>Valid Values:</strong> One of:<ul>
 804 | <li><code class="docutils literal"><span class="pre">all</span></code></li>
 805 | <li><code class="docutils literal"><span class="pre">none</span></code></li>
 806 | </ul>
 807 | </li>
 808 | </ul>
 809 | </li>
 810 | <li><code class="docutils literal"><span class="pre">customStickers</span></code> (optional)<ul>
 811 | <li><strong>Default:</strong> <code class="docutils literal"><span class="pre">none</span></code></li>
 812 | <li><strong>Valid Values:</strong> One of:<ul>
 813 | <li><code class="docutils literal"><span class="pre">all</span></code></li>
 814 | <li><code class="docutils literal"><span class="pre">none</span></code></li>
 815 | </ul>
 816 | </li>
 817 | </ul>
 818 | </li>
 819 | <li><code class="docutils literal"><span class="pre">customEmoji</span></code> (optional)<ul>
 820 | <li><strong>Default:</strong> <code class="docutils literal"><span class="pre">none</span></code></li>
 821 | <li><strong>Valid Values:</strong> One of:<ul>
 822 | <li><code class="docutils literal"><span class="pre">all</span></code></li>
 823 | <li><code class="docutils literal"><span class="pre">none</span></code></li>
 824 | </ul>
 825 | </li>
 826 | </ul>
 827 | </li>
 828 | <li><code class="docutils literal"><span class="pre">fields</span></code> (optional)<ul>
 829 | <li><strong>Default:</strong> <code class="docutils literal"><span class="pre">all</span></code></li>
 830 | <li><strong>Valid Values:</strong> <code class="docutils literal"><span class="pre">all</span></code> or a comma-separated list of:<ul>
 831 | <li><code class="docutils literal"><span class="pre">avatarHash</span></code></li>
 832 | <li><code class="docutils literal"><span class="pre">avatarSource</span></code></li>
 833 | <li><code class="docutils literal"><span class="pre">bio</span></code></li>
 834 | <li><code class="docutils literal"><span class="pre">bioData</span></code></li>
 835 | <li><code class="docutils literal"><span class="pre">confirmed</span></code></li>
 836 | <li><code class="docutils literal"><span class="pre">email</span></code></li>
 837 | <li><code class="docutils literal"><span class="pre">fullName</span></code></li>
 838 | <li><code class="docutils literal"><span class="pre">gravatarHash</span></code></li>
 839 | <li><code class="docutils literal"><span class="pre">idBoards</span></code></li>
 840 | <li><code class="docutils literal"><span class="pre">idBoardsPinned</span></code></li>
 841 | <li><code class="docutils literal"><span class="pre">idOrganizations</span></code></li>
 842 | <li><code class="docutils literal"><span class="pre">idPremOrgsAdmin</span></code></li>
 843 | <li><code class="docutils literal"><span class="pre">initials</span></code></li>
 844 | <li><code class="docutils literal"><span class="pre">loginTypes</span></code></li>
 845 | <li><code class="docutils literal"><span class="pre">memberType</span></code></li>
 846 | <li><code class="docutils literal"><span class="pre">oneTimeMessagesDismissed</span></code></li>
 847 | <li><code class="docutils literal"><span class="pre">prefs</span></code></li>
 848 | <li><code class="docutils literal"><span class="pre">premiumFeatures</span></code></li>
 849 | <li><code class="docutils literal"><span class="pre">products</span></code></li>
 850 | <li><code class="docutils literal"><span class="pre">status</span></code></li>
 851 | <li><code class="docutils literal"><span class="pre">status</span></code></li>
 852 | <li><code class="docutils literal"><span class="pre">trophies</span></code></li>
 853 | <li><code class="docutils literal"><span class="pre">uploadedAvatarHash</span></code></li>
 854 | <li><code class="docutils literal"><span class="pre">url</span></code></li>
 855 | <li><code class="docutils literal"><span class="pre">username</span></code></li>
 856 | </ul>
 857 | </li>
 858 | </ul>
 859 | </li>
 860 | </ul>
 861 | </li>
 862 | <li><strong>Examples</strong></li>
 863 | </ul>
 864 | <div class="highlight-URL"><div class="highlight"><pre>https://api.trello.com/1/members/bobtester?fields=username,fullName,url&amp;boards=all&amp;board_fields=name&amp;organizations=all&amp;organization_fields=displayName&amp;key=[application_key]&amp;token=[optional_auth_token]
 865 | </pre></div>
 866 | </div>
 867 | <div class="highlight-JavaScript"><div class="highlight"><pre><span class="p">{</span>
 868 |   <span class="s2">"id"</span><span class="o">:</span> <span class="s2">"4ee7df1be582acdec80000ae"</span><span class="p">,</span>
 869 |   <span class="s2">"username"</span><span class="o">:</span> <span class="s2">"bobtester"</span><span class="p">,</span>
 870 |   <span class="s2">"fullName"</span><span class="o">:</span> <span class="s2">"Bob Tester"</span><span class="p">,</span>
 871 |   <span class="s2">"url"</span><span class="o">:</span> <span class="s2">"https://trello.com/bobtester"</span><span class="p">,</span>
 872 |   <span class="s2">"organizations"</span><span class="o">:</span> <span class="p">[],</span>
 873 |   <span class="s2">"boards"</span><span class="o">:</span> <span class="p">[{</span>
 874 |       <span class="s2">"name"</span><span class="o">:</span> <span class="s2">"Example Board"</span><span class="p">,</span>
 875 |       <span class="s2">"id"</span><span class="o">:</span> <span class="s2">"4eea4ffc91e31d1746000046"</span>
 876 |   <span class="p">},</span> <span class="p">{</span>
 877 |       <span class="s2">"name"</span><span class="o">:</span> <span class="s2">"Public Board"</span><span class="p">,</span>
 878 |       <span class="s2">"id"</span><span class="o">:</span> <span class="s2">"4ee7e707e582acdec800051a"</span>
 879 |   <span class="p">}]</span>
 880 | <span class="p">}</span>
 881 | </pre></div>
 882 | </div>
 883 | </div>
 884 | """)
 885 | 
 886 | sampleAPI = """
 887 | {
 888 |   "swagger": "2.0",
 889 |   "info": {
 890 |     "description": "This is a sample server Petstore server.  You can find out more about Swagger at <a href='http:\/\/swagger.io'>http:\/\/swagger.io<\/a> or on irc.freenode.net, #swagger.  For this sample, you can use the api key 'special-key' to test the authorization filters",
 891 |     "version": "1.0.0",
 892 |     "title": "Swagger Petstore",
 893 |     "termsOfService": "http:\/\/helloreverb.com\/terms\/",
 894 |     "contact": {
 895 |       "email": "apiteam@swagger.io"
 896 |     },
 897 |     "license": {
 898 |       "name": "Apache 2.0",
 899 |       "url": "http:\/\/www.apache.org\/licenses\/LICENSE-2.0.html"
 900 |     }
 901 |   },
 902 |   "host": "petstore.swagger.io",
 903 |   "basePath": "\/v2",
 904 |   "tags": [
 905 |     {
 906 |       "name": "pet",
 907 |       "description": "Everything about your Pets",
 908 |       "externalDocs": {
 909 |         "description": "Find out more",
 910 |         "url": "http:\/\/swagger.io"
 911 |       }
 912 |     },
 913 |     {
 914 |       "name": "OneOfTheTrelloEntities",
 915 |       "description": "Access to Petstore orders"
 916 |     },
 917 |     {
 918 |       "name": "user",
 919 |       "description": "Operations about user",
 920 |       "externalDocs": {
 921 |         "description": "Find out more about our store",
 922 |         "url": "http:\/\/swagger.io"
 923 |       }
 924 |     }
 925 |   ],
 926 |   "schemes": [
 927 |     "http"
 928 |   ],
 929 |   "securityDefinitions": {
 930 |     "petstore_auth": {
 931 |       "type": "oauth2",
 932 |       "authorizationUrl": "http:\/\/petstore.swagger.io\/api\/oauth\/dialog",
 933 |       "flow": "implicit",
 934 |       "scopes": {
 935 |         "write:pets": "modify pets in your account",
 936 |         "read:pets": "read your pets"
 937 |       }
 938 |     },
 939 |     "api_key": {
 940 |       "type": "apiKey",
 941 |       "name": "api_key",
 942 |       "in": "header"
 943 |     }
 944 |   },
 945 |   "definitions": {
 946 |     "Order": {
 947 |       "type": "object",
 948 |       "properties": {
 949 |         "id": {
 950 |           "type": "integer",
 951 |           "format": "int64"
 952 |         },
 953 |         "petId": {
 954 |           "type": "integer",
 955 |           "format": "int64"
 956 |         },
 957 |         "quantity": {
 958 |           "type": "integer",
 959 |           "format": "int32"
 960 |         },
 961 |         "shipDate": {
 962 |           "type": "string",
 963 |           "format": "date-time"
 964 |         },
 965 |         "status": {
 966 |           "type": "string",
 967 |           "description": "Order Status",
 968 |           "enum": [
 969 |             "placed",
 970 |             "approved",
 971 |             "delivered"
 972 |           ]
 973 |         },
 974 |         "complete": {
 975 |           "type": "boolean",
 976 |           "default": false
 977 |         }
 978 |       },
 979 |       "xml": {
 980 |         "name": "Order"
 981 |       }
 982 |     },
 983 |     "Category": {
 984 |       "type": "object",
 985 |       "properties": {
 986 |         "id": {
 987 |           "type": "integer",
 988 |           "format": "int64"
 989 |         },
 990 |         "name": {
 991 |           "type": "string"
 992 |         }
 993 |       },
 994 |       "xml": {
 995 |         "name": "Category"
 996 |       }
 997 |     },
 998 |     "User": {
 999 |       "type": "object",
1000 |       "properties": {
1001 |         "id": {
1002 |           "type": "integer",
1003 |           "format": "int64"
1004 |         },
1005 |         "username": {
1006 |           "type": "string"
1007 |         },
1008 |         "firstName": {
1009 |           "type": "string"
1010 |         },
1011 |         "lastName": {
1012 |           "type": "string"
1013 |         },
1014 |         "email": {
1015 |           "type": "string"
1016 |         },
1017 |         "password": {
1018 |           "type": "string"
1019 |         },
1020 |         "phone": {
1021 |           "type": "string"
1022 |         },
1023 |         "userStatus": {
1024 |           "type": "integer",
1025 |           "format": "int32",
1026 |           "description": "User Status"
1027 |         }
1028 |       },
1029 |       "xml": {
1030 |         "name": "User"
1031 |       }
1032 |     },
1033 |     "Tag": {
1034 |       "type": "object",
1035 |       "properties": {
1036 |         "id": {
1037 |           "type": "integer",
1038 |           "format": "int64"
1039 |         },
1040 |         "name": {
1041 |           "type": "string"
1042 |         }
1043 |       },
1044 |       "xml": {
1045 |         "name": "Tag"
1046 |       }
1047 |     },
1048 |     "Pet": {
1049 |       "type": "object",
1050 |       "required": [
1051 |         "name",
1052 |         "photoUrls"
1053 |       ],
1054 |       "properties": {
1055 |         "id": {
1056 |           "type": "integer",
1057 |           "format": "int64"
1058 |         },
1059 |         "category": {
1060 |           "$ref": "#\/definitions\/Category"
1061 |         },
1062 |         "name": {
1063 |           "type": "string",
1064 |           "example": "doggie"
1065 |         },
1066 |         "photoUrls": {
1067 |           "type": "array",
1068 |           "xml": {
1069 |             "name": "photoUrl",
1070 |             "wrapped": true
1071 |           },
1072 |           "items": {
1073 |             "type": "string"
1074 |           }
1075 |         },
1076 |         "tags": {
1077 |           "type": "array",
1078 |           "xml": {
1079 |             "name": "tag",
1080 |             "wrapped": true
1081 |           },
1082 |           "items": {
1083 |             "$ref": "#\/definitions\/Tag"
1084 |           }
1085 |         },
1086 |         "status": {
1087 |           "type": "string",
1088 |           "description": "pet status in the store",
1089 |           "enum": [
1090 |             "available",
1091 |             "pending",
1092 |             "sold"
1093 |           ]
1094 |         }
1095 |       },
1096 |       "xml": {
1097 |         "name": "Pet"
1098 |       }
1099 |     },
1100 |     "ApiResponse": {
1101 |       "type": "object",
1102 |       "properties": {
1103 |         "code": {
1104 |           "type": "integer",
1105 |           "format": "int32"
1106 |         },
1107 |         "type": {
1108 |           "type": "string"
1109 |         },
1110 |         "message": {
1111 |           "type": "string"
1112 |         }
1113 |       }
1114 |     }
1115 |   },
1116 |   "externalDocs": {
1117 |     "description": "Find out more about Swagger",
1118 |     "url": "http:\/\/swagger.io"
1119 |   }
1120 | }
1121 | """
1122 | 
1123 | 


--------------------------------------------------------------------------------