Skip to content
This repository has been archived by the owner on Jul 12, 2023. It is now read-only.

add admin API to api docs #470

Merged
merged 2 commits into from
Sep 3, 2020
Merged

Conversation

mikehelmick
Copy link
Contributor

Fixes #469

Proposed Changes

  • Add API docs for admin APIs

Release Note

Added documentation for ADMIN APIs

@googlebot googlebot added the cla: yes Auto: added by CLA bot when all committers have signed a CLA. label Sep 3, 2020
Copy link
Contributor

@icco icco left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm
/hold for one small question. Feel free to submit.

* Must be `confirmed`, `likely`, `negative`
* valid values depends on your realm's settings
* `tzOffset`
* Offset in minutes of the user's timezone. Positive, negative, 0, or omitted (using the default of 0) are all valid. 0 is considered to be UTC.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minutes? Isn't this usually hours?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is the way it is in the api - not all TZ offsets are even hour increments

@google-oss-robot
Copy link

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: icco, mikehelmick

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

docs/api.md Outdated Show resolved Hide resolved
docs/api.md Outdated
"testDate": "YYYY-MM-DD",
"testType": "<valid test type>",
"tzOffset": 0,
"phone": "+1NPANXXLINE",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure I understand this format?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mikehelmick
Copy link
Contributor Author

/unhold

@sethvargo
Copy link
Member

/lgtm

@google-oss-robot google-oss-robot merged commit c74bdbe into google:main Sep 3, 2020
@google google locked and limited conversation to collaborators Oct 6, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
cla: yes Auto: added by CLA bot when all committers have signed a CLA.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add admin APIs to API doc
5 participants