Add harbormaster.buildplan.search api method
ClosedPublic
Actions

Authored by timhirsh on Nov 2 2018, 1:50 AM.

Details

Reviewers

epriestley

Group Reviewers

Blessed Reviewers

Commits

rP9bea00c159b6: Add harbormaster.buildplan.search api method

Summary

This revision adds a conduit search method for build plans. Other api methods (eg: harbormaster.build.search) support build plan phid's as a constraint, but they weren't exposed anywhere, so this provides a way to fetch them.

Test Plan

Used the api console to run some searches. Output:

{
  "data": [
    {
      "id": 1,
      "type": "HMCP",
      "phid": "PHID-HMCP-q2c25wvegzdkxs7gzor6",
      "fields": {
        "name": "my build plan",
        "planStatus": "active",
        "dateCreated": 1538085249,
        "dateModified": 1538085249,
        "policy": {
          "view": "users",
          "edit": "admin"
        }
      },
    {
      "id": 1,
      "type": "HMCP",
      "phid": "PHID-HMCP-q2c25wvegzdkxs7gzor6",
      "fields": {
        "name": "my build plan",
        "status": {
          "value": "active"
        },
        "dateCreated": 1538085249,
        "dateModified": 1538085249,
        "policy": {
          "view": "users",
          "edit": "admin"
        }
      },
      "attachments": {}
    },
    ...
  ],
  "maps": {},
  "query": {
    "queryKey": null
  },
  "cursor": {
    "limit": 100,
    "after": null,
    "before": null,
    "order": null
  }
}

Diff Detail

Repository

rP Phabricator

Lint

Lint Not Applicable

Unit

Tests Not Applicable

Event Timeline

timhirsh created this revision.Nov 2 2018, 1:50 AM

Herald added a reviewer: Blessed Reviewers. · View Herald TranscriptNov 2 2018, 1:50 AM

Herald added a subscriber: yelirekim. · View Herald Transcript

Harbormaster completed remote builds in B21071: Diff 47224.Nov 2 2018, 1:52 AM

timhirsh requested review of this revision.Nov 2 2018, 1:52 AM

Herald added a subscriber: Korvin. · View Herald TranscriptNov 2 2018, 1:52 AM

Couple of minor inlines, happy to upstream this otherwise.

src/applications/harbormaster/conduit/HarbormasterBuildPlanSearchAPIMethod.php
16	For consistency, capitalize "Harbormaster".
src/applications/harbormaster/storage/configuration/HarbormasterBuildPlan.php
231	Let's just call this `status` and make it a dictionary with the status constant in `"value"` so we can add `name`, `icon`, `color`, etc., later if necessary. See `DifferentialRevision` for a similar object. ... "status": { "value": <whatever getPlanStatus() returns> } ...