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

Review Request #11323 — Created Dec. 7, 2020 and submitted

Information

Review Board
release-3.0.x

Reviewers

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.

Unit tests passed.

Manually verified the results in the payload.

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

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
Description From Last Updated

E131 continuation line unaligned for hanging indent

reviewbotreviewbot

I think we almost always put the ) on the previous line, since this is really a function call.

daviddavid
Checks run (1 failed, 1 succeeded)
flake8 failed.
JSHint passed.

flake8

chipx86
david
  1. 
      
  2. Show all issues

    I think we almost always put the ) on the previous line, since this is really a function call.

  3. 
      
chipx86
Review request changed

Status: Closed (submitted)

Change Summary:

Pushed to release-3.0.x (3fdd41b)
Loading...