Skip to content

Comments

fix: rename 'inspect' endpoints to 'get'#47

Merged
jason-lynch merged 1 commit intomainfrom
feat/PLAT-86/rename-inspect-endpoints
Jun 13, 2025
Merged

fix: rename 'inspect' endpoints to 'get'#47
jason-lynch merged 1 commit intomainfrom
feat/PLAT-86/rename-inspect-endpoints

Conversation

@jason-lynch
Copy link
Member

@jason-lynch jason-lynch commented Jun 12, 2025

Renames the following endpoints to make our API more consistent:

  • inspect-cluster -> get-cluster
  • inspect-host -> get-host
  • inspect-database-task -> get-database-task

PLAT-86

@jason-lynch jason-lynch force-pushed the feat/PLAT-86/rename-inspect-endpoints branch 2 times, most recently from 670f972 to 1c3be21 Compare June 12, 2025 21:53
Renames the following endpoints to make our API more consistent:

- `inspect-cluster` -> `get-cluster`
- `inspect-host` -> `get-host`
- `inspect-database-task` -> `get-database-task`

PLAT-86
@jason-lynch jason-lynch force-pushed the feat/PLAT-86/rename-inspect-endpoints branch from 1c3be21 to 1e7a582 Compare June 13, 2025 11:31
@tsivaprasad
Copy link
Contributor

Validation:
Help command reflected all new modified commands and their descriptions.
restish control-plane-local-1 --help

Control-Plane Commands:
  backup-database-node  backup-database-node control-plane
  create-database       create-database control-plane
  delete-database       delete-database control-plane
  get-cluster           get-cluster control-plane
  get-database          get-database control-plane
  get-database-task     get-database-task control-plane
  get-database-task-log get-database-task-log control-plane
  get-host              get-host control-plane
  get-join-token        get-join-token control-plane
  get-version           get-version control-plane
  init-cluster          init-cluster control-plane
  join-cluster          join-cluster control-plane
  list-database-tasks   list-database-tasks control-plane
  list-databases        list-databases control-plane
  list-hosts            list-hosts control-plane
  openapi-json          Download ./gen/http/openapi3.json
  remove-host           remove-host control-plane
  restore-database      restore-database control-plane
  update-database       update-database control-plane

restish control-plane-local-1 get-host fa461a39-5867-4a72-9923-dd7ce91e1eab

HTTP/1.1 500 Internal Server Error
Content-Length: 117
Content-Type: application/json
Date: Fri, 13 Jun 2025 15:08:10 GMT

{
  fault: true
  id: "psyFtISB"
  message: "endpoint not implemented"
  name: "fault"
  temporary: false
  timeout: false
}

restish control-plane-local-1 get-database-task f2f1cae9-6f37-4609-aa98-d0991bff3493 01976931-88cf-7d49-85d6-86822f80f673

HTTP/1.1 200 OK
Content-Length: 215
Content-Type: application/json
Date: Fri, 13 Jun 2025 15:09:00 GMT

{
  completed_at: "2025-06-13T12:09:45Z"
  created_at: "2025-06-13T12:09:03Z"
  database_id: "f2f1cae9-6f37-4609-aa98-d0991bff3493"
  status: "completed"
  task_id: "01976931-88cf-7d49-85d6-86822f80f673"
  type: "create"
}

restish control-plane-local-1 get-database-task-log f2f1cae9-6f37-4609-aa98-d0991bff3493 01976931-88cf-7d49-85d6-86822f80f673 - received details of the task log

Copy link
Contributor

@tsivaprasad tsivaprasad left a comment

Choose a reason for hiding this comment

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

Awesome, everything looks good. I've also updated my verifications.

@jason-lynch jason-lynch merged commit 3e353db into main Jun 13, 2025
2 checks passed
@jason-lynch jason-lynch deleted the feat/PLAT-86/rename-inspect-endpoints branch June 13, 2025 15:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants