[TODO] A comman list about what harborctl will support

[moooofly]

a scratch about what harborctl will support.

---

command list:

• login
• logout
• search
• project
  • check
  • create
  • delete
  • get
  • list
  • update ([NOTE] The parameters of API "PUT /projects/{project_id}" alters dramatically. #1)
  • member
    • create
    • delete
    • get
    • list
    • update
  • metadata
    • create ( [NOTE] The parameters of API "POST /projects/{project_id}/metadatas" alters dramatically. #3)
    • delete
    • get
    • list
    • update ([NOTE] API "PUT /projects/{project_id}/metadatas/{meta_name}" with wrong parameter definition #4)
  • log ([NOTE] The format of "begin_timestamp" and "end_timestamp" within API "GET /projects/{project_id}/logs" is unknown  #2)
• statistics
• user
  • list
  • create ([NOTE] API "POST /users" not work as expect #7, [NOTE] Should add comments about the length limitation of "password" in "POST /users" API #9)
  • current
  • get
  • update ([NOTE] Should add comments about parameters of content body in "PUT /users/{user_id}" API #10)
  • delete
  • password ([NOTE] Notes on "PUT /users/{user_id}/password" API #11)
  • sysadmin
• repository
  • top
  • get ([NOTE] Notes on "GET /repositories" API #13)
  • delete
  • update
  • label
    • get
    • add ([NOTE] API "POST /repositories/{repo_name}/labels" not work as expect #20, rely on "/labels" API)
    • delete
  • tag
    • get
    • delete
    • list (rely on "/labels" API)
    • retag ([NOTE] API "POST /repositories/{repo_name}/tags" not work as expect #17)
    • label
      • get
      • add ([NOTE] API "POST /repositories/{repo_name}/tags/{tag}/labels" not work as expect #21, rely on "/labels" API)
      • delete
    • manifest
    • scan ([NOTE] Totally wrong definition on "POST /repositories/{repo_name}/tags/{tag}/scan" API #18)
    • vulnerability
  • signature ([NOTE] Notes on "GET /repositories/{repo_name}/signatures" API #15)
  • scanall ([NOTE] Totally wrong definition on "POST /repositories/scanAll" API #16)
• log ([NOTE] The format of "begin_timestamp" and "end_timestamp" within API "GET /logs" is unknown #6)
• scan
  • log ([NOTE] Notes on "GET /jobs/replication" API #29)
• replication
  • list ( [NOTE] Notes on "GET /jobs/replication" API #28)
  • update
  • delete
  • policy
    • list
    • get
    • create ([NOTE] Notes on "POST /policies/replication" API #30, [NOTE] API "POST /policies/replication" not work as expect #31)
    • update ([NOTE] Notes on "PUT /policies/replication" API #33)
    • delete ([NOTE] Missing "DELETE /policies/replication" API #32)
  • trigger
  • log
• label
  • list
  • create ([NOTE] API "POST /labels" not work as expect #22)
  • get
  • update ([NOTE] Notes on "PUT /labels/{id}" API #25)
  • delete
  • resource
• target
  • list
  • get
  • delete
  • create
  • update
  • policy
  • ping ([NOTE] Notes on "POST /targets/ping" API #34)
• internal
  • syncregistry ([NOTE] API "POST /internal/syncregistry" not work as expect #27)
• systeminfo
  • get
  • volume
  • getcert
• usergroup
  • list
  • create
  • get
  • update
  • delete
• chartrepo
  • health
  • chart
    • list
    • upload - 500 error
    • get
    • delete ([NOTE] API "DELETE /chartrepo/{repo}/charts/{name}" not work as expect #43)
    • version
      • get
      • delete
    • label
      • get ([NOTE] API "GET /chartrepo/{repo}/charts/{name}/{version}/labels" not work as expect  #44)
      • delete ([NOTE] API "DELETE /chartrepo/{repo}/charts/{name}/{version}/labels/{id}" not work as expect #45)
      • attach ([NOTE] API "POST /chartrepo/{repo}/charts/{name}/{version}/labels" not work as expect #46)
  • prov
    • upload - 500 error
  • library
    • upload ([NOTE] API "POST /chartrepo/charts" can be calling by another API #47)

[steven-zou]

Some comments:

• Move system gc out of the base release(V1.6) as it's released in V1.7 and create an issue to track that work
• Move configuration and email related out of the base release as it's the priority is low, and create an issue to track that work
• Move ldap related out of the base release as it can be counted in the configuration part, and create an issue to track that work
• Suggest move the complicated commands likestatistic and tag retention policy out of the base release, those features can be supported as plugins of CLI in future. Issues should be created for tracking
• Suggest change target to registry
• Suggest use replication instead of job: harborctl replication policy * / harborctl replication run * / harborctl replication log * etc.
• Suggest use vulnerability instead of job for the scanning-related commands

[moooofly]

Suggest use vulnerability instead of job for the scanning-related commands

After discussion with @steven-zou , the suggest above will not be considered right now.

[moooofly]

update on 2019-01-23

Find /usergroups APIs are related to LDAP too, but I have fulfilled these APIs already.

[moooofly]

All APIs are support now, hooray @steven-zou