Summary

Add information on repository plans and fields in the Hosting Service API.

Review Request #11323 — Created Dec. 7, 2020 and submitted Dec. 8, 2020, 5:02 p.m.

Information

Owner

chipx86

Repository

Review Board

Branch

release-3.0.x

Bugs

Depends On

Reviewers

Groups

reviewboard

People

Description

Now that the repository API formally supports creating repositories
backed by hosting services, it's important to communicate the fields
that must be set for each repository.

This change enhances the Hosting Service API to show the repository
plans, consisting of their ID, display name, and list of fields. This
isn't comprehensive. The list of fields doesn't include any type
information, as we'd need to be careful how we represent that from form
fields, but they do include the field name, display name, required flag,
and help text. This should be enough at this stage for API consumers.

Testing Done

Unit tests passed.

Manually verified the results in the payload.

Built the docs and checked that the payloads contained the information as
well.

Commits

Summary	ID
Add information on repository plans and fields in the Hosting Service API. Now that the repository API formally supports creating repositories backed by hosting services, it's important to communicate the fields that must be set for each repository. This change enhances the Hosting Service API to show the repository plans, consisting of their ID, display name, and list of fields. This isn't comprehensive. The list of fields doesn't include any type information, as we'd need to be careful how we represent that from form fields, but they do include the field name, display name, required flag, and help text. This should be enough at this stage for API consumers.	c5f146ffa8e097fa5e64b7f9d0e45069b4d42016

Summary

Add information on repository plans and fields in the Hosting Service API.

Now that the repository API formally supports creating repositories backed by hosting services, it's important to communicate the fields that must be set for each repository. This change enhances the Hosting Service API to show the repository plans, consisting of their ID, display name, and list of fields. This isn't comprehensive. The list of fields doesn't include any type information, as we'd need to be careful how we represent that from form fields, but they do include the field name, display name, required flag, and help text. This should be enough at this stage for API consumers.

c5f146ffa8e097fa5e64b7f9d0e45069b4d42016

Issues

Description	From	Last Updated
E131 continuation line unaligned for hanging indent	reviewbot	Dec. 7, 2020, 11:02 p.m.
I think we almost always put the ) on the previous line, since this is really a function call.	david	Dec. 8, 2020, 5:02 p.m.

flake8 failed.

JSHint passed.

flake8

reviewboard/webapi/resources/hosting_service.py (Diff revision 1)
The issue has been resolved. Show all issues
```
E131 continuation line unaligned for hanging indent
```

Change Summary:

Fixed a Review Bot complaint.

Commits:

	Summary	ID
	Add information on repository plans and fields in the Hosting Service API. Now that the repository API formally supports creating repositories backed by hosting services, it's important to communicate the fields that must be set for each repository. This change enhances the Hosting Service API to show the repository plans, consisting of their ID, display name, and list of fields. This isn't comprehensive. The list of fields doesn't include any type information, as we'd need to be careful how we represent that from form fields, but they do include the field name, display name, required flag, and help text. This should be enough at this stage for API consumers.	049b95b989e2f71fd640d3f51140ae428d6b4ea2
	Add information on repository plans and fields in the Hosting Service API. Now that the repository API formally supports creating repositories backed by hosting services, it's important to communicate the fields that must be set for each repository. This change enhances the Hosting Service API to show the repository plans, consisting of their ID, display name, and list of fields. This isn't comprehensive. The list of fields doesn't include any type information, as we'd need to be careful how we represent that from form fields, but they do include the field name, display name, required flag, and help text. This should be enough at this stage for API consumers.	c5f146ffa8e097fa5e64b7f9d0e45069b4d42016

Diff:

Revision 2 (+172)

Show changes

	reviewboard/webapi/resources/hosting_service.py
	reviewboard/webapi/tests/test_hosting_service.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

reviewboard/webapi/resources/hosting_service.py (Diff revision 2)
The issue has been resolved. Show all issues
```
I think we almost always put the ) on the previous line, since this is really a function call.
```

Status:: Completed
Change Summary:: Pushed to release-3.0.x (3fdd41b)