- Notifications
You must be signed in to change notification settings - Fork928
docs: API workspace agents and builds#5538
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Uh oh!
There was an error while loading.Please reload this page.
Conversation
Uh oh!
There was an error while loading.Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Some minor questions and suggestions but looks good in all! 👍🏻
Uh oh!
There was an error while loading.Please reload this page.
Uh oh!
There was an error while loading.Please reload this page.
| DisconnectedAt *time.Time `json:"disconnected_at,omitempty"` | ||
| Status WorkspaceAgentStatus `json:"status"` | ||
| ID uuid.UUID `json:"id" format:"uuid"` | ||
| CreatedAt time.Time `json:"created_at" format:"date-time"` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Perhaps I've asked before, but is there a way to automatically transform these based on the Go type? It seems unfortunate we'd have to tag every new struct, and we will almost certainly miss to add the tag to fields in the future.
It'd be nice ifformat was reserved as an override sinceuuid andtime.Time are essentially never a different format (would take a custom json Marshaller at which point usingformat would be appropriate).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
I'm afraid that we would need a fork to apply this feature, let's say,auto-format. It doesn't look like something we can truly solve just with validation.
I'm not sure why it hasn't been implemented this way. Even officialexamples suggest usingformat tags.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
I can certainly understand why it's not the default (due to middlewares and handlers that can do whatever). But it'd be nice to enable such a feature.
Do you think they'd be open to it if we made a PR? Seems like many people could benefit.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
At the moment, we're using versionswaggo v1.8.6, but I can try to bump it tov1.8.9 so that we will also benefit from future PRs. AFAIR v1.8.9 added a lot of noise around all possible values oftime.Duration or strange value examples:
- "value": 0+ "value": -9223372036854776000
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Ah, ifv1.8.9 is problematic we can punt it for now unless you think there's a benefit to upgrading?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Let me prepare a draft PR and we can discuss the upgrade there.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
| @@ -65,13 +65,15 @@ type WorkspaceBuild struct { | |||
| InitiatorID uuid.UUID `json:"initiator_id" format:"uuid"` | |||
| InitiatorUsername string `json:"initiator_name"` | |||
| Job ProvisionerJob `json:"job"` | |||
| Reason BuildReason `db:"reason" json:"reason"` | |||
| Reason BuildReason `db:"reason" json:"reason" enums:"initiator,autostart,autostop"` | |||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Nice work! Once we get the docs in shape, it'd be nice to try to process the Go code to find these enums automatically.
Btw, would it be possible to move this enum description to the type? Like:
// BuildReason ...// @enum initiator,autostart,autostoptypeBuildReasonstring
Perhaps not supported by swaggo.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
There are some magic undocumented extensions likex-enum-varnames orx-enum-descriptions, but I don't think that this is what we're looking for.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Indeed, that seems useful with enums that are number based and have string representations in (de-)serialization.
Uh oh!
There was an error while loading.Please reload this page.
Uh oh!
There was an error while loading.Please reload this page.
| DisconnectedAt *time.Time `json:"disconnected_at,omitempty"` | ||
| Status WorkspaceAgentStatus `json:"status"` | ||
| ID uuid.UUID `json:"id" format:"uuid"` | ||
| CreatedAt time.Time `json:"created_at" format:"date-time"` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Ah, ifv1.8.9 is problematic we can punt it for now unless you think there's a benefit to upgrading?
Uh oh!
There was an error while loading.Please reload this page.
Related:#3522
Blocker:#5506 (this PR is built on top of that branch)Changes:
workspaceagents.goworkspacebuilds.go(also affects/workspaces)