Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Placement groups API documentation #932

Closed

Conversation

Vernholio
Copy link
Collaborator

@Vernholio Vernholio commented Apr 18, 2024

Added

New endpoints in support of the Placement Groups service launch (Limited Availability):

  • Placement Groups List (GET /placement/groups)
  • Placement Group View (GET /placement/groups/{groupId})
  • Placement Group Create (POST /placement/groups/)
  • Placement Group Update (PUT /placement/groups/)
  • Placement Group Assign (POST /placement/groups/{id}/assign)
  • Placement Group Unassign ([POST /placement/groups/{id}/unassign)
  • Placement Group Delete (DELETE /placement/groups/{id})

Changed

Updated endpoints in support of the Placement Groups service launch (Limited Availability):

  • Linodes List (GET /linode/instances) - Added placement_group object to show the placement group the Linode belongs to.
  • Linode View (GET /linode/instances/{linodeId}) - Added placement_group object to show the placement group the Linode belongs to.
  • Linode Create (POST /linode/instances) - Added placement_group parameter to include a new Linode in an existing placement group.
  • Linode Clone (POST /linode/instances/{linodeId}/clone) - Added placement_group parameter to include the cloned Linode in an existing placement group.
  • DC Migration/Pending Host Migration Initiate (POST /linode/instances/migrate) - Added placement_group parameter to include the migrated Linode in an existing placement group.
  • Account View (GET /account) - Includes Placement Group in the capabilities array for accounts with access to the service.
  • Region View (GET /regions/{regionId}) - Included various parameters that describe placement group availability and limitations in a region.

Fixed

Minor edits for formatting and compatibility.

@lgarber-akamai lgarber-akamai self-requested a review April 19, 2024 16:25
openapi.yaml Outdated Show resolved Hide resolved
openapi.yaml Outdated Show resolved Hide resolved
openapi.yaml Outdated Show resolved Hide resolved
openapi.yaml Outdated Show resolved Hide resolved
openapi.yaml Outdated Show resolved Hide resolved
openapi.yaml Outdated Show resolved Hide resolved
openapi.yaml Outdated Show resolved Hide resolved
openapi.yaml Outdated Show resolved Hide resolved
openapi.yaml Outdated Show resolved Hide resolved
openapi.yaml Outdated Show resolved Hide resolved
openapi.yaml Outdated Show resolved Hide resolved
openapi.yaml Outdated Show resolved Hide resolved
openapi.yaml Outdated Show resolved Hide resolved
openapi.yaml Outdated Show resolved Hide resolved
openapi.yaml Outdated Show resolved Hide resolved
@lgarber-akamai lgarber-akamai self-requested a review May 14, 2024 14:26
Vernholio and others added 3 commits May 15, 2024 09:16
Release 4.176.0 (merge main into development)
openapi.yaml Outdated
Comment on lines 18937 to 18938
- list
- ls
Copy link
Collaborator

@lgarber-akamai lgarber-akamai May 15, 2024

Choose a reason for hiding this comment

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

Could this action become groups-list and groups-ls to align with the POST request?

openapi.yaml Outdated
description: |
View a specific placement group by ID.
operationId: getPlacementGroup
x-linode-cli-action: view
Copy link
Collaborator

@lgarber-akamai lgarber-akamai May 15, 2024

Choose a reason for hiding this comment

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

Could this action become group-view to align with the POST request command?

openapi.yaml Outdated
description: |
Change the `label` for a specific placement group. This is the only value you can update. However, you can [add](#placement-group-add-linode) more compute instances or [remove](#placement-group-remove-linode) existing ones.
operationId: updatePlacementGroup
x-linode-cli-action: update
Copy link
Collaborator

Choose a reason for hiding this comment

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

Could this action become group-update to align with the POST request command?

openapi.yaml Outdated
Comment on lines 19136 to 19137
- delete
- rm
Copy link
Collaborator

Choose a reason for hiding this comment

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

Could these actions become group-delete and group-rm to align with the POST request command?

openapi.yaml Outdated
example: us-mia
affinity_type:
type: string
x-linode-filterable: true
Copy link
Collaborator

Choose a reason for hiding this comment

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

Would it make sense to add an x-linode-cli-display: 1 here to make sure the affinity type is displayed by default in the CLI output?

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.

4 participants