feat: API Sync by GitHub Action for @ctreatma #10
Conversation
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| Port *Href `json:"port,omitempty"` | ||
| Project *Href `json:"project,omitempty"` | ||
| Bill *bool `json:"bill,omitempty"` | ||
| BillType NullableVlanVirtualCircuitBillType `json:"bill_type,omitempty"` |
There was a problem hiding this comment.
Interesting type introduced here: NullableVlanVirtualCircuitBillType
There was a problem hiding this comment.
Curious if Nullable is a necessary distinction or if the spec for the attribute is more verbose in definition than others and this is what that looks like.
Without digging into this, I would have expected:
BillType *VlanVirtualCircuitBillType
There was a problem hiding this comment.
Legacy Virtual Circuits will have a value of nil.
|
non directly related, but this PR suggests that we'll need a way to generate sync PRs for each and every spec (perhaps all in one job) |
|
The service-specific sync job is created automatically when the service is onboarded. The current job structure is based on the opinion that we should expressly not sync all specs in one PR, because one PR that changes multiple services will require massive coordination just to review it. On top of that, it's not entirely clear how broadly applicable a GitHub Actions job for spec syncing is. Metal needs it because the spec URL is unversioned, and it looks like LBaaS will need it for the same reason, at least initially. Fabric is pulled from SwaggerHub using a versioned URL, so it's debatable whether a sync job is actually useful for that. More generally, it's possible the best outcome is for the sync job to go away completely. In my opinion the ideal process is for the SDK to be updated as part of the API development process rather than after production deployment; then teams can use a branch build of the SDK to validate that their changes work the way customers need them to work. |
|
This PR is included in version 0.31.0 🎉 |
This API Sync PR was triggered by @ctreatma through GitHub Actions workflow_displatch
on 2023-12-13.