Skip to content
This repository has been archived by the owner on Dec 23, 2024. It is now read-only.

[API spec] Rename input schemas of create API request body #46

Open
rinzler-17 opened this issue Sep 21, 2022 · 1 comment
Open

[API spec] Rename input schemas of create API request body #46

rinzler-17 opened this issue Sep 21, 2022 · 1 comment

Comments

@rinzler-17
Copy link
Contributor

rinzler-17 commented Sep 21, 2022

Renaming should be done for:

  1. VrfCreateInput, CreateVrfRequest
  2. MetalGatewayInput, VrfMetalGatewayCreateInput
  3. VrfIPReservationCreateInput, IPReservationRequestInput
@rinzler-17 rinzler-17 changed the title [API spec] Refactor names of input schemas of create APIs [API spec] Rename input schemas of create API request body Sep 21, 2022
@displague
Copy link
Member

displague commented Sep 22, 2022

What are your proposals for the renames:

  • IPReservationRequestInput -> IPReservationCreateInput
  • CreateVrfRequest -> VrfCreateInput
  • MetalGatewayInput -> MetalGatewayCreateInput
  • VrfMetalGatewayCreateInput -> (already conventional)

Others to be aware of:

  • BgpConfigRequestInput.
  • TransferRequestInput
  • SupportRequestInput

In these examples "Request" may indicate that the resource is not Created but updated or returned as a report. In other cases (Support), Request creates a clause as SupportRequest, rather than acting as a modifier for Input - RequestInput.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants