Summary

[WIP] API Explorer template front-end

Review Request #7905 — Created Jan. 24, 2016 and discarded Sept. 24, 2017, 7:31 a.m.

Information

Owner

adilally

Repository

Review Board

Branch

master

Bugs

Depends On

~~7904~~

Reviewers

Groups

reviewboard

People

Description

An API Explorer allows developers to make requests to the Web API from their browsers without having to download XML or JSON files. The API Explorer will display the response as syntax highlighted JSON in order to be understandable and facilitate development and understanding of the Web API.

In the future, users will be able to make POST, PUT and DELETE requests from a provided form and view documentation related to the resource.

This patch focuses on displaying the Web API response as syntax highlighted JSON, creating a form for POST, PUT and DELETE requests and displaying the appropriate documentation for the resource.

Testing Done

Tested /api/users/<user_name> and /api/users/ which returned the correct information in the proper format, which displayed correctly in a web browser.

Issues

Description	From	Last Updated
Use 1 space for indentation.	brennie	Jan. 31, 2016, 3:08 p.m.
We do block tags aligned to the left. We show nesting with additional spaces inside the template tag itself. {% …	brennie	Jan. 31, 2016, 3:08 p.m.
One space for indentation.	brennie	Jan. 31, 2016, 3:04 p.m.
See other comment about blocktags. Likewise for the rest of them here.	brennie	Jan. 31, 2016, 3:08 p.m.
We don't want to include CSS like this. We'll want to make use of static bundles. Have a look at …	brennie	April 3, 2016, 4:36 p.m.
Blank line contains whitespace.	brennie	Feb. 9, 2016, 3:13 p.m.
Blank line contains whitespace.	brennie	Feb. 9, 2016, 3:15 p.m.
This file needs to be reformatted.	brennie	Feb. 9, 2016, 3:15 p.m.
Col: 9 E123 closing bracket does not match indentation of opening bracket's line	reviewbot	March 13, 2016, 6:04 p.m.
Col: 9 E123 closing bracket does not match indentation of opening bracket's line	reviewbot	March 20, 2016, 6:26 p.m.

Tool: Pyflakes
Ignored Files:
    reviewboard/templates/webapi/nested.html
    reviewboard/templates/webapi/apiexplorer.html



Tool: PEP8 Style Checker
Ignored Files:
    reviewboard/templates/webapi/nested.html
    reviewboard/templates/webapi/apiexplorer.html

Summary:: [WPI] Added API Explorer front-end
[WPI] Added HTML encoder Template

Summary:: [WPI] Added HTML encoder Template
[WPI] Added HTML encoder Template.

Change Summary:

-Added support for arrays to be displayed properly
-Added template tag that helps determine type of value
-Added basic styling and light syntax highlighting
-Added basic support for opening and closing braces

Description:

~		-Added initial template that displays the api request payload, unformatted.
	~	An API Explorer allows developers to make requests to the Web API from their browsers without having to download XML or JSON files. The API Explorer will display the response as syntax highlighted JSON in order to be understandable and facilitate development and understanding of the Web API.
	+
	+	In the future, users will be able to make POST, PUT and DELETE requests from a provided form and view documentation related to the resource.
	+
	+	This patch focuses on displaying the Web API response as syntax highlighted JSON, creating a form for POST, PUT and DELETE requests and displaying the appropriate documentation for the resource.

Testing Done:

Tested /api/users/<user_name> and /api/users/ which returned the correct information in the proper format, which displayed correctly in a web browser.

Diff:

Revision 2 (+51)

Show changes

	reviewboard/templates/webapi/apiexplorer.html
	reviewboard/templates/webapi/nested.html

Tool: Pyflakes
Ignored Files:
    reviewboard/templates/webapi/nested.html
    reviewboard/templates/webapi/apiexplorer.html



Tool: PEP8 Style Checker
Ignored Files:
    reviewboard/templates/webapi/nested.html
    reviewboard/templates/webapi/apiexplorer.html

Summary:: [WPI] Added HTML encoder Template.
[WIP] Added HTML encoder Template.

Summary:: [WIP] Added HTML encoder Template.
[WIP] API Explorer front-end

Summary:: [WIP] API Explorer front-end
[WIP] Added API Explorer Template

reviewboard/templates/webapi/apiexplorer.html (Diff revision 2)
The issue has been resolved. Show all issues
```
Use 1 space for indentation.
```

reviewboard/templates/webapi/apiexplorer.html (Diff revision 2)

The issue has been resolved. Show all issues

We do block tags aligned to the left. We show nesting with additional spaces inside the template tag itself.

{% with dict=payload template="webapi/nested.html" %}
{%  include template %}
{% endwith %}

reviewboard/templates/webapi/nested.html (Diff revision 2)
The issue has been resolved. Show all issues
```
One space for indentation.
```
reviewboard/templates/webapi/nested.html (Diff revision 2)
The issue has been resolved. Show all issues
```
See other comment about blocktags.
Likewise for the rest of them here.
```

Change Summary:

Added styling from "syntax.less"

Diff:

Revision 3 (+58)

Show changes

	reviewboard/templates/webapi/apiexplorer.html
	reviewboard/templates/webapi/nested.html

Tool: PEP8 Style Checker
Ignored Files:
    reviewboard/templates/webapi/nested.html
    reviewboard/templates/webapi/apiexplorer.html



Tool: Pyflakes
Ignored Files:
    reviewboard/templates/webapi/nested.html
    reviewboard/templates/webapi/apiexplorer.html

reviewboard/templates/webapi/apiexplorer.html (Diff revision 3)

The issue has been resolved. Show all issues

We don't want to include CSS like this. We'll want to make use of static bundles. Have a look at staticbundles.py to see what files end up where.
You may want to add a new static bundle for the API explorer, but I could be wrong. You'll also want to look at https://github.com/reviewboard/reviewboard/blob/master/reviewboard/templates/base.html#L24 to see how we include CSS.
The same goes for JS that will eventually go here.

adilally

March 13, 2016, 6:03 p.m.

I implemented a potential fix to this issue, not sure if it's done correctly though.

reviewboard/templates/webapi/apiexplorer.html (Diff revision 3)
The issue has been resolved. Show all issues
```
Blank line contains whitespace.
```
reviewboard/templates/webapi/apiexplorer.html (Diff revision 3)
The issue has been resolved. Show all issues
```
Blank line contains whitespace.
```

reviewboard/templates/webapi/nested.html (Diff revision 3)

The issue has been dropped. Show all issues

This file needs to be reformatted.

adilally

Feb. 9, 2016, 3:15 p.m.

For reference: nested.html is going to be removed in the future, along with the mentioned template tag library.

Change Summary:

-Removed files that are no longer used

Diff:

Revision 4 (+50)

Show changes

	reviewboard/templates/webapi/apiexplorer.html
	reviewboard/templates/webapi/nested.html

Tool: Pyflakes
Ignored Files:
    reviewboard/templates/webapi/nested.html
    reviewboard/templates/webapi/apiexplorer.html



Tool: PEP8 Style Checker
Ignored Files:
    reviewboard/templates/webapi/nested.html
    reviewboard/templates/webapi/apiexplorer.html

Change Summary:

-Added ability to handle fields from a resource
-Added support for primitive types for fields of the resource

Diff:

Revision 5 (+88)

Show changes

	reviewboard/templates/webapi/apiexplorer.html
	reviewboard/templates/webapi/nested.html

Tool: Pyflakes
Ignored Files:
    reviewboard/templates/webapi/nested.html
    reviewboard/templates/webapi/apiexplorer.html



Tool: PEP8 Style Checker
Ignored Files:
    reviewboard/templates/webapi/nested.html
    reviewboard/templates/webapi/apiexplorer.html

Summary:: [WIP] Added API Explorer Template
[WIP] API Explorer template front-end

Change Summary:

-Added ability to handle required and optional fields
-Added support for GET and POST fields
-Added modularization to generation of fields on the template
-Removed unused file

Diff:

Revision 6 (+75)

Show changes

	reviewboard/templates/webapi/apiexplorer.html
	reviewboard/templates/webapi/fields.html

Tool: Pyflakes
Ignored Files:
    reviewboard/templates/webapi/fields.html
    reviewboard/templates/webapi/apiexplorer.html



Tool: PEP8 Style Checker
Ignored Files:
    reviewboard/templates/webapi/fields.html
    reviewboard/templates/webapi/apiexplorer.html

Change Summary:

-Added support for Javascript on API Explorer front-end template
-Added ability for form to disable inputs that are empty
-Added ability to make GET and POST requests to a resource
-Updated name of page used by API Explorer front-end template to a more appropriate name

Diff:

Revision 7 (+154)

Show changes

	reviewboard/staticbundles.py
	reviewboard/static/rb/js/webapi/utils/apiCaller.js
	reviewboard/templates/webapi/apiexplorer.html
	reviewboard/templates/webapi/restform.html

Tool: Pyflakes
Processed Files:
    reviewboard/staticbundles.py

Ignored Files:
    reviewboard/static/rb/js/webapi/utils/apiCaller.js
    reviewboard/templates/webapi/restform.html
    reviewboard/templates/webapi/apiexplorer.html



Tool: PEP8 Style Checker
Processed Files:
    reviewboard/staticbundles.py

Ignored Files:
    reviewboard/static/rb/js/webapi/utils/apiCaller.js
    reviewboard/templates/webapi/restform.html
    reviewboard/templates/webapi/apiexplorer.html

reviewboard/staticbundles.py (Diff revision 7)

The issue has been dropped. Show all issues

Col: 9
 E123 closing bracket does not match indentation of opening bracket's line

adilally

March 20, 2016, 6:27 p.m.

Conforms to the same formatting that was already used in the file.

Change Summary:

-Added support for displaying only the payload of a GET request
-Updated ability for form to disable inputs that are empty to handle more types
-Added success message when a POST request was successful
-Updated success codes to ensure that successful POST requests are considered such
-Added styling to forms to make them presentable

Diff:

Revision 8 (+199 -1)

Show changes

	reviewboard/staticbundles.py
	reviewboard/static/rb/js/utils/apiUtils.js
	reviewboard/static/rb/js/webapi/utils/apiCaller.js
	reviewboard/templates/webapi/apiexplorer.html
	reviewboard/templates/webapi/payload-only.html
	reviewboard/templates/webapi/restform.html

Tool: Pyflakes
Processed Files:
    reviewboard/staticbundles.py

Ignored Files:
    reviewboard/templates/webapi/payload-only.html
    reviewboard/static/rb/js/webapi/utils/apiCaller.js
    reviewboard/templates/webapi/restform.html
    reviewboard/static/rb/js/utils/apiUtils.js
    reviewboard/templates/webapi/apiexplorer.html



Tool: PEP8 Style Checker
Processed Files:
    reviewboard/staticbundles.py

Ignored Files:
    reviewboard/templates/webapi/payload-only.html
    reviewboard/static/rb/js/webapi/utils/apiCaller.js
    reviewboard/templates/webapi/restform.html
    reviewboard/static/rb/js/utils/apiUtils.js
    reviewboard/templates/webapi/apiexplorer.html

reviewboard/staticbundles.py (Diff revision 8)

The issue has been dropped. Show all issues

Col: 9
 E123 closing bracket does not match indentation of opening bracket's line

adilally

March 20, 2016, 6:27 p.m.

Adheres to the styling established by the existing static bundles.

Change Summary:


Added support for latest RB version
Added support for Collapsible HTML components
Added support for content pipeline

Diff:

Revision 9 (+199)

Show changes

	reviewboard/staticbundles.py
	reviewboard/static/rb/js/webapi/utils/apiCaller.js
	reviewboard/templates/webapi/apiexplorer.html
	reviewboard/templates/webapi/payload-only.html
	reviewboard/templates/webapi/restform.html

Tool: PEP8 Style Checker
Processed Files:
    reviewboard/staticbundles.py

Ignored Files:
    reviewboard/templates/webapi/payload-only.html
    reviewboard/static/rb/js/webapi/utils/apiCaller.js
    reviewboard/templates/webapi/restform.html
    reviewboard/templates/webapi/apiexplorer.html



Tool: Pyflakes
Processed Files:
    reviewboard/staticbundles.py

Ignored Files:
    reviewboard/templates/webapi/payload-only.html
    reviewboard/static/rb/js/webapi/utils/apiCaller.js
    reviewboard/templates/webapi/restform.html
    reviewboard/templates/webapi/apiexplorer.html

Change Summary:


Updated templates to handle different contexts efficiently
Added collapsible HTML elements to the API Explorer
Added support for file uploads on the API Explorer
Updated how HTML elements are disabled when making requests on the API Explorer
Fixed an issue making POST requests with the API Explorer front-end

Diff:

Revision 10 (+242)

Show changes

	reviewboard/staticbundles.py
	reviewboard/static/rb/js/webapi/utils/apiCaller.js
	reviewboard/templates/webapi/apiexplorer.html
	reviewboard/templates/webapi/payload-only.html
	reviewboard/templates/webapi/restform.html

Tool: Pyflakes
Processed Files:
    reviewboard/staticbundles.py

Ignored Files:
    reviewboard/templates/webapi/payload-only.html
    reviewboard/static/rb/js/webapi/utils/apiCaller.js
    reviewboard/templates/webapi/restform.html
    reviewboard/templates/webapi/apiexplorer.html



Tool: PEP8 Style Checker
Processed Files:
    reviewboard/staticbundles.py

Ignored Files:
    reviewboard/templates/webapi/payload-only.html
    reviewboard/static/rb/js/webapi/utils/apiCaller.js
    reviewboard/templates/webapi/restform.html
    reviewboard/templates/webapi/apiexplorer.html

Status:: Discarded