From 130b93afb5661d992007d960ed4a8de04204c0c2 Mon Sep 17 00:00:00 2001 From: Sean Roberts Date: Thu, 22 Oct 2026 13:44:01 -0700 Subject: [PATCH 1/4] feat: add operation summaries and missing response schemas Give every operation a one-line summary (186/186, up from 0; 29% had any description before) and add descriptions where the API documents behavior beyond the summary. Summaries come from the operationId, path, existing descriptions, and the bitballoon controller doc comments and code. Declare the response bodies of four operations that returned JSON with no schema, each verified against the controller: - createAgentRunnerUploadUrl: { upload_url, file_key } - agentRunnerPullRequest, agentRunnerCommitToBranch: agentRunner - markDevServerActivity: devServer Regenerated the Go client: doc comments change, and the four responses gain a Payload field and GetPayload() (additive; empty bodies still decode). Co-Authored-By: Claude Opus 5.5 (1M context) --- ...create_agent_runner_upload_url_o_k_body.go | 46 ++ ...agent_runner_commit_to_branch_responses.go | 14 +- .../agent_runner_pull_request_responses.go | 14 +- ...reate_agent_runner_upload_url_responses.go | 14 +- .../mark_dev_server_activity_responses.go | 17 +- go/plumbing/operations/operations_client.go | 526 +++++++++++------- swagger.yml | 223 ++++++++ 7 files changed, 664 insertions(+), 190 deletions(-) create mode 100644 go/models/create_agent_runner_upload_url_o_k_body.go diff --git a/go/models/create_agent_runner_upload_url_o_k_body.go b/go/models/create_agent_runner_upload_url_o_k_body.go new file mode 100644 index 00000000..410d3ed8 --- /dev/null +++ b/go/models/create_agent_runner_upload_url_o_k_body.go @@ -0,0 +1,46 @@ +// Code generated by go-swagger; DO NOT EDIT. + +package models + +// This file was generated by the swagger tool. +// Editing this file might prove futile when you re-run the swagger generate command + +import ( + "github.com/go-openapi/strfmt" + "github.com/go-openapi/swag" +) + +// CreateAgentRunnerUploadURLOKBody create agent runner upload Url o k body +// +// swagger:model createAgentRunnerUploadUrlOKBody +type CreateAgentRunnerUploadURLOKBody struct { + + // Storage key of the uploaded file. + FileKey string `json:"file_key,omitempty"` + + // Presigned URL to upload the file to with a PUT request. Expires after one hour. + UploadURL string `json:"upload_url,omitempty"` +} + +// Validate validates this create agent runner upload Url o k body +func (m *CreateAgentRunnerUploadURLOKBody) Validate(formats strfmt.Registry) error { + return nil +} + +// MarshalBinary interface implementation +func (m *CreateAgentRunnerUploadURLOKBody) MarshalBinary() ([]byte, error) { + if m == nil { + return nil, nil + } + return swag.WriteJSON(m) +} + +// UnmarshalBinary interface implementation +func (m *CreateAgentRunnerUploadURLOKBody) UnmarshalBinary(b []byte) error { + var res CreateAgentRunnerUploadURLOKBody + if err := swag.ReadJSON(b, &res); err != nil { + return err + } + *m = res + return nil +} diff --git a/go/plumbing/operations/agent_runner_commit_to_branch_responses.go b/go/plumbing/operations/agent_runner_commit_to_branch_responses.go index 764c2973..7df3420d 100644 --- a/go/plumbing/operations/agent_runner_commit_to_branch_responses.go +++ b/go/plumbing/operations/agent_runner_commit_to_branch_responses.go @@ -70,14 +70,26 @@ AgentRunnerCommitToBranchOK handles this case with default header values. OK */ type AgentRunnerCommitToBranchOK struct { + Payload *models.AgentRunner } func (o *AgentRunnerCommitToBranchOK) Error() string { - return fmt.Sprintf("[POST /agent_runners/{agent_runner_id}/commit][%d] agentRunnerCommitToBranchOK ", 200) + return fmt.Sprintf("[POST /agent_runners/{agent_runner_id}/commit][%d] agentRunnerCommitToBranchOK %+v", 200, o.Payload) +} + +func (o *AgentRunnerCommitToBranchOK) GetPayload() *models.AgentRunner { + return o.Payload } func (o *AgentRunnerCommitToBranchOK) readResponse(response runtime.ClientResponse, consumer runtime.Consumer, formats strfmt.Registry) error { + o.Payload = new(models.AgentRunner) + + // response payload + if err := consumer.Consume(response.Body(), o.Payload); err != nil && err != io.EOF { + return err + } + return nil } diff --git a/go/plumbing/operations/agent_runner_pull_request_responses.go b/go/plumbing/operations/agent_runner_pull_request_responses.go index 438dadf6..66a9ba47 100644 --- a/go/plumbing/operations/agent_runner_pull_request_responses.go +++ b/go/plumbing/operations/agent_runner_pull_request_responses.go @@ -70,14 +70,26 @@ AgentRunnerPullRequestOK handles this case with default header values. OK */ type AgentRunnerPullRequestOK struct { + Payload *models.AgentRunner } func (o *AgentRunnerPullRequestOK) Error() string { - return fmt.Sprintf("[POST /agent_runners/{agent_runner_id}/pull_request][%d] agentRunnerPullRequestOK ", 200) + return fmt.Sprintf("[POST /agent_runners/{agent_runner_id}/pull_request][%d] agentRunnerPullRequestOK %+v", 200, o.Payload) +} + +func (o *AgentRunnerPullRequestOK) GetPayload() *models.AgentRunner { + return o.Payload } func (o *AgentRunnerPullRequestOK) readResponse(response runtime.ClientResponse, consumer runtime.Consumer, formats strfmt.Registry) error { + o.Payload = new(models.AgentRunner) + + // response payload + if err := consumer.Consume(response.Body(), o.Payload); err != nil && err != io.EOF { + return err + } + return nil } diff --git a/go/plumbing/operations/create_agent_runner_upload_url_responses.go b/go/plumbing/operations/create_agent_runner_upload_url_responses.go index cec077a5..72f232e0 100644 --- a/go/plumbing/operations/create_agent_runner_upload_url_responses.go +++ b/go/plumbing/operations/create_agent_runner_upload_url_responses.go @@ -64,14 +64,26 @@ CreateAgentRunnerUploadURLOK handles this case with default header values. OK */ type CreateAgentRunnerUploadURLOK struct { + Payload *models.CreateAgentRunnerUploadURLOKBody } func (o *CreateAgentRunnerUploadURLOK) Error() string { - return fmt.Sprintf("[POST /agent_runners/upload_url][%d] createAgentRunnerUploadUrlOK ", 200) + return fmt.Sprintf("[POST /agent_runners/upload_url][%d] createAgentRunnerUploadUrlOK %+v", 200, o.Payload) +} + +func (o *CreateAgentRunnerUploadURLOK) GetPayload() *models.CreateAgentRunnerUploadURLOKBody { + return o.Payload } func (o *CreateAgentRunnerUploadURLOK) readResponse(response runtime.ClientResponse, consumer runtime.Consumer, formats strfmt.Registry) error { + o.Payload = new(models.CreateAgentRunnerUploadURLOKBody) + + // response payload + if err := consumer.Consume(response.Body(), o.Payload); err != nil && err != io.EOF { + return err + } + return nil } diff --git a/go/plumbing/operations/mark_dev_server_activity_responses.go b/go/plumbing/operations/mark_dev_server_activity_responses.go index c3db9fe2..b59a52f0 100644 --- a/go/plumbing/operations/mark_dev_server_activity_responses.go +++ b/go/plumbing/operations/mark_dev_server_activity_responses.go @@ -7,9 +7,12 @@ package operations import ( "fmt" + "io" "github.com/go-openapi/runtime" "github.com/go-openapi/strfmt" + + "github.com/netlify/open-api/v2/go/models" ) // MarkDevServerActivityReader is a Reader for the MarkDevServerActivity structure. @@ -43,13 +46,25 @@ MarkDevServerActivityOK handles this case with default header values. OK */ type MarkDevServerActivityOK struct { + Payload *models.DevServer } func (o *MarkDevServerActivityOK) Error() string { - return fmt.Sprintf("[POST /sites/{site_id}/dev_servers/{dev_server_id}/activity][%d] markDevServerActivityOK ", 200) + return fmt.Sprintf("[POST /sites/{site_id}/dev_servers/{dev_server_id}/activity][%d] markDevServerActivityOK %+v", 200, o.Payload) +} + +func (o *MarkDevServerActivityOK) GetPayload() *models.DevServer { + return o.Payload } func (o *MarkDevServerActivityOK) readResponse(response runtime.ClientResponse, consumer runtime.Consumer, formats strfmt.Registry) error { + o.Payload = new(models.DevServer) + + // response payload + if err := consumer.Consume(response.Body(), o.Payload); err != nil && err != io.EOF { + return err + } + return nil } diff --git a/go/plumbing/operations/operations_client.go b/go/plumbing/operations/operations_client.go index 84092544..aaadb5b2 100644 --- a/go/plumbing/operations/operations_client.go +++ b/go/plumbing/operations/operations_client.go @@ -403,7 +403,7 @@ type ClientService interface { } /* -AddMemberToAccount add member to account API +AddMemberToAccount adds a member to a team */ func (a *Client) AddMemberToAccount(params *AddMemberToAccountParams, authInfo runtime.ClientAuthInfoWriter) (*AddMemberToAccountOK, error) { // TODO: Validate the params before sending @@ -437,7 +437,7 @@ func (a *Client) AddMemberToAccount(params *AddMemberToAccountParams, authInfo r } /* -AgentRunnerCommitToBranch agent runner commit to branch API +AgentRunnerCommitToBranch commits an agent run s changes to a branch */ func (a *Client) AgentRunnerCommitToBranch(params *AgentRunnerCommitToBranchParams, authInfo runtime.ClientAuthInfoWriter) (*AgentRunnerCommitToBranchOK, error) { // TODO: Validate the params before sending @@ -471,7 +471,9 @@ func (a *Client) AgentRunnerCommitToBranch(params *AgentRunnerCommitToBranchPara } /* -AgentRunnerPullRequest agent runner pull request API +AgentRunnerPullRequest opens a pull request from an agent run + +Opens a pull request from the run's most recent completed session that has a diff. */ func (a *Client) AgentRunnerPullRequest(params *AgentRunnerPullRequestParams, authInfo runtime.ClientAuthInfoWriter) (*AgentRunnerPullRequestOK, error) { // TODO: Validate the params before sending @@ -505,7 +507,9 @@ func (a *Client) AgentRunnerPullRequest(params *AgentRunnerPullRequestParams, au } /* -AnswerAgentRunnerSession Answers or skips a pending interaction and resumes the session. A session waiting on an interaction is in the `await_input` state. +AnswerAgentRunnerSession answers an agent run session s pending interaction + +Answers or skips a pending interaction and resumes the session. A session waiting on an interaction is in the `await_input` state. */ func (a *Client) AnswerAgentRunnerSession(params *AnswerAgentRunnerSessionParams, authInfo runtime.ClientAuthInfoWriter) (*AnswerAgentRunnerSessionOK, error) { // TODO: Validate the params before sending @@ -539,7 +543,7 @@ func (a *Client) AnswerAgentRunnerSession(params *AnswerAgentRunnerSessionParams } /* -ArchiveAgentRunner archive agent runner API +ArchiveAgentRunner archives an agent run */ func (a *Client) ArchiveAgentRunner(params *ArchiveAgentRunnerParams, authInfo runtime.ClientAuthInfoWriter) (*ArchiveAgentRunnerAccepted, error) { // TODO: Validate the params before sending @@ -573,7 +577,7 @@ func (a *Client) ArchiveAgentRunner(params *ArchiveAgentRunnerParams, authInfo r } /* -CancelAccount cancel account API +CancelAccount cancels a team */ func (a *Client) CancelAccount(params *CancelAccountParams, authInfo runtime.ClientAuthInfoWriter) (*CancelAccountNoContent, error) { // TODO: Validate the params before sending @@ -607,7 +611,7 @@ func (a *Client) CancelAccount(params *CancelAccountParams, authInfo runtime.Cli } /* -CancelSiteDeploy cancel site deploy API +CancelSiteDeploy cancels a deploy */ func (a *Client) CancelSiteDeploy(params *CancelSiteDeployParams, authInfo runtime.ClientAuthInfoWriter) (*CancelSiteDeployCreated, error) { // TODO: Validate the params before sending @@ -641,7 +645,9 @@ func (a *Client) CancelSiteDeploy(params *CancelSiteDeployParams, authInfo runti } /* -ClearSiteDatabaseComputeSettings Resets project-level compute settings to tier defaults. Requires a Pro or higher plan. +ClearSiteDatabaseComputeSettings resets database compute settings to defaults + +Resets project-level compute settings to tier defaults. Requires a Pro or higher plan. */ func (a *Client) ClearSiteDatabaseComputeSettings(params *ClearSiteDatabaseComputeSettingsParams, authInfo runtime.ClientAuthInfoWriter) (*ClearSiteDatabaseComputeSettingsNoContent, error) { // TODO: Validate the params before sending @@ -675,7 +681,9 @@ func (a *Client) ClearSiteDatabaseComputeSettings(params *ClearSiteDatabaseCompu } /* -ConfigureDNSForSite configure DNS for site API +ConfigureDNSForSite configures a site s DNS + +Creates any missing DNS zones and records for the site's custom domain and domain aliases. This usually runs automatically when the custom domain is set. */ func (a *Client) ConfigureDNSForSite(params *ConfigureDNSForSiteParams, authInfo runtime.ClientAuthInfoWriter) (*ConfigureDNSForSiteOK, error) { // TODO: Validate the params before sending @@ -709,7 +717,7 @@ func (a *Client) ConfigureDNSForSite(params *ConfigureDNSForSiteParams, authInfo } /* -CreateAccount create account API +CreateAccount creates a team */ func (a *Client) CreateAccount(params *CreateAccountParams, authInfo runtime.ClientAuthInfoWriter) (*CreateAccountCreated, error) { // TODO: Validate the params before sending @@ -743,7 +751,7 @@ func (a *Client) CreateAccount(params *CreateAccountParams, authInfo runtime.Cli } /* -CreateAgentRunner create agent runner API +CreateAgentRunner starts an agent run */ func (a *Client) CreateAgentRunner(params *CreateAgentRunnerParams, authInfo runtime.ClientAuthInfoWriter) (*CreateAgentRunnerOK, error) { // TODO: Validate the params before sending @@ -777,7 +785,9 @@ func (a *Client) CreateAgentRunner(params *CreateAgentRunnerParams, authInfo run } /* -CreateAgentRunnerSession Starts a follow-up session on the run. +CreateAgentRunnerSession starts a follow up agent run session + +Starts a follow-up session on the run. */ func (a *Client) CreateAgentRunnerSession(params *CreateAgentRunnerSessionParams, authInfo runtime.ClientAuthInfoWriter) (*CreateAgentRunnerSessionOK, error) { // TODO: Validate the params before sending @@ -811,7 +821,9 @@ func (a *Client) CreateAgentRunnerSession(params *CreateAgentRunnerSessionParams } /* -CreateAgentRunnerUploadURL create agent runner upload Url API +CreateAgentRunnerUploadURL creates an upload URL for agent run files + +Returns a presigned URL for uploading a file that agent run sessions can use, and the file's storage key. */ func (a *Client) CreateAgentRunnerUploadURL(params *CreateAgentRunnerUploadURLParams, authInfo runtime.ClientAuthInfoWriter) (*CreateAgentRunnerUploadURLOK, error) { // TODO: Validate the params before sending @@ -845,7 +857,7 @@ func (a *Client) CreateAgentRunnerUploadURL(params *CreateAgentRunnerUploadURLPa } /* -CreateDeployKey create deploy key API +CreateDeployKey creates a deploy key */ func (a *Client) CreateDeployKey(params *CreateDeployKeyParams, authInfo runtime.ClientAuthInfoWriter) (*CreateDeployKeyCreated, error) { // TODO: Validate the params before sending @@ -879,7 +891,7 @@ func (a *Client) CreateDeployKey(params *CreateDeployKeyParams, authInfo runtime } /* -CreateDNSRecord create Dns record API +CreateDNSRecord creates a DNS record */ func (a *Client) CreateDNSRecord(params *CreateDNSRecordParams, authInfo runtime.ClientAuthInfoWriter) (*CreateDNSRecordCreated, error) { // TODO: Validate the params before sending @@ -913,7 +925,7 @@ func (a *Client) CreateDNSRecord(params *CreateDNSRecordParams, authInfo runtime } /* -CreateDNSZone create Dns zone API +CreateDNSZone creates a DNS zone */ func (a *Client) CreateDNSZone(params *CreateDNSZoneParams, authInfo runtime.ClientAuthInfoWriter) (*CreateDNSZoneCreated, error) { // TODO: Validate the params before sending @@ -947,7 +959,9 @@ func (a *Client) CreateDNSZone(params *CreateDNSZoneParams, authInfo runtime.Cli } /* -CreateEnvVars Creates new environment variables. Granular scopes are available on Pro plans and above. +CreateEnvVars creates environment variables + +Creates new environment variables. Granular scopes are available on Pro plans and above. */ func (a *Client) CreateEnvVars(params *CreateEnvVarsParams, authInfo runtime.ClientAuthInfoWriter) (*CreateEnvVarsCreated, error) { // TODO: Validate the params before sending @@ -981,7 +995,7 @@ func (a *Client) CreateEnvVars(params *CreateEnvVarsParams, authInfo runtime.Cli } /* -CreateHookBySiteID create hook by site Id API +CreateHookBySiteID creates an outgoing hook */ func (a *Client) CreateHookBySiteID(params *CreateHookBySiteIDParams, authInfo runtime.ClientAuthInfoWriter) (*CreateHookBySiteIDCreated, error) { // TODO: Validate the params before sending @@ -1015,7 +1029,9 @@ func (a *Client) CreateHookBySiteID(params *CreateHookBySiteIDParams, authInfo r } /* -CreatePluginRun This is an internal-only endpoint. +CreatePluginRun creates a build plugin run + +This is an internal-only endpoint. */ func (a *Client) CreatePluginRun(params *CreatePluginRunParams, authInfo runtime.ClientAuthInfoWriter) (*CreatePluginRunCreated, error) { // TODO: Validate the params before sending @@ -1049,7 +1065,7 @@ func (a *Client) CreatePluginRun(params *CreatePluginRunParams, authInfo runtime } /* -CreateServiceInstance create service instance API +CreateServiceInstance creates an add on instance */ func (a *Client) CreateServiceInstance(params *CreateServiceInstanceParams, authInfo runtime.ClientAuthInfoWriter) (*CreateServiceInstanceCreated, error) { // TODO: Validate the params before sending @@ -1083,7 +1099,9 @@ func (a *Client) CreateServiceInstance(params *CreateServiceInstanceParams, auth } /* -CreateSite **Note:** Environment variable keys and values have moved from `build_settings.env` and `repo.env` to a new endpoint. Please use [createEnvVars](#tag/environmentVariables/operation/createEnvVars) to create environment variables for a site. +CreateSite creates a site + +**Note:** Environment variable keys and values have moved from `build_settings.env` and `repo.env` to a new endpoint. Please use [createEnvVars](#tag/environmentVariables/operation/createEnvVars) to create environment variables for a site. */ func (a *Client) CreateSite(params *CreateSiteParams, authInfo runtime.ClientAuthInfoWriter) (*CreateSiteCreated, error) { // TODO: Validate the params before sending @@ -1117,7 +1135,9 @@ func (a *Client) CreateSite(params *CreateSiteParams, authInfo runtime.ClientAut } /* -CreateSiteAgentRunner Starts an agent run on the site. +CreateSiteAgentRunner starts an agent run on a site + +Starts an agent run on the site. */ func (a *Client) CreateSiteAgentRunner(params *CreateSiteAgentRunnerParams, authInfo runtime.ClientAuthInfoWriter) (*CreateSiteAgentRunnerOK, error) { // TODO: Validate the params before sending @@ -1151,7 +1171,7 @@ func (a *Client) CreateSiteAgentRunner(params *CreateSiteAgentRunnerParams, auth } /* -CreateSiteAgentRunnerHook create site agent runner hook API +CreateSiteAgentRunnerHook creates an agent runner hook */ func (a *Client) CreateSiteAgentRunnerHook(params *CreateSiteAgentRunnerHookParams, authInfo runtime.ClientAuthInfoWriter) (*CreateSiteAgentRunnerHookCreated, error) { // TODO: Validate the params before sending @@ -1185,7 +1205,9 @@ func (a *Client) CreateSiteAgentRunnerHook(params *CreateSiteAgentRunnerHookPara } /* -CreateSiteAsset create site asset API +CreateSiteAsset creates a site asset + +_This endpoint is only available to certain sites._ */ func (a *Client) CreateSiteAsset(params *CreateSiteAssetParams, authInfo runtime.ClientAuthInfoWriter) (*CreateSiteAssetCreated, error) { // TODO: Validate the params before sending @@ -1219,7 +1241,9 @@ func (a *Client) CreateSiteAsset(params *CreateSiteAssetParams, authInfo runtime } /* - CreateSiteBuild Runs a build for a site. The build will be scheduled to run at the first opportunity, but it might not start immediately if insufficient account build capacity is available. + CreateSiteBuild starts a build + + Runs a build for a site. The build will be scheduled to run at the first opportunity, but it might not start immediately if insufficient account build capacity is available. Files for build can be uploaded as a zipped site using one of these methods: 1. Set Content-Type to 'application/zip' and send the zip file as the raw request body @@ -1257,7 +1281,7 @@ func (a *Client) CreateSiteBuild(params *CreateSiteBuildParams, authInfo runtime } /* -CreateSiteBuildHook create site build hook API +CreateSiteBuildHook creates a build hook */ func (a *Client) CreateSiteBuildHook(params *CreateSiteBuildHookParams, authInfo runtime.ClientAuthInfoWriter) (*CreateSiteBuildHookCreated, error) { // TODO: Validate the params before sending @@ -1291,7 +1315,9 @@ func (a *Client) CreateSiteBuildHook(params *CreateSiteBuildHookParams, authInfo } /* -CreateSiteDatabase Creates a new database for the specified site. If a database already exists, returns the existing connection string. The database region defaults to the site's functions region if not specified. +CreateSiteDatabase creates a site database + +Creates a new database for the specified site. If a database already exists, returns the existing connection string. The database region defaults to the site's functions region if not specified. */ func (a *Client) CreateSiteDatabase(params *CreateSiteDatabaseParams, authInfo runtime.ClientAuthInfoWriter) (*CreateSiteDatabaseOK, *CreateSiteDatabaseCreated, error) { // TODO: Validate the params before sending @@ -1327,7 +1353,9 @@ func (a *Client) CreateSiteDatabase(params *CreateSiteDatabaseParams, authInfo r } /* -CreateSiteDatabaseBranch Creates a new database branch. If a branch already exists for the specified branch ID, returns the existing connection string. +CreateSiteDatabaseBranch creates a database branch + +Creates a new database branch. If a branch already exists for the specified branch ID, returns the existing connection string. */ func (a *Client) CreateSiteDatabaseBranch(params *CreateSiteDatabaseBranchParams, authInfo runtime.ClientAuthInfoWriter) (*CreateSiteDatabaseBranchOK, *CreateSiteDatabaseBranchCreated, error) { // TODO: Validate the params before sending @@ -1363,7 +1391,9 @@ func (a *Client) CreateSiteDatabaseBranch(params *CreateSiteDatabaseBranchParams } /* -CreateSiteDatabaseSnapshot Creates a point-in-time snapshot of a database branch. Defaults to the production branch if no branch name is specified. +CreateSiteDatabaseSnapshot creates a database snapshot + +Creates a point-in-time snapshot of a database branch. Defaults to the production branch if no branch name is specified. */ func (a *Client) CreateSiteDatabaseSnapshot(params *CreateSiteDatabaseSnapshotParams, authInfo runtime.ClientAuthInfoWriter) (*CreateSiteDatabaseSnapshotCreated, error) { // TODO: Validate the params before sending @@ -1397,7 +1427,7 @@ func (a *Client) CreateSiteDatabaseSnapshot(params *CreateSiteDatabaseSnapshotPa } /* -CreateSiteDeploy create site deploy API +CreateSiteDeploy creates a deploy */ func (a *Client) CreateSiteDeploy(params *CreateSiteDeployParams, authInfo runtime.ClientAuthInfoWriter) (*CreateSiteDeployOK, error) { // TODO: Validate the params before sending @@ -1431,7 +1461,7 @@ func (a *Client) CreateSiteDeploy(params *CreateSiteDeployParams, authInfo runti } /* -CreateSiteDevServer create site dev server API +CreateSiteDevServer starts a dev server */ func (a *Client) CreateSiteDevServer(params *CreateSiteDevServerParams, authInfo runtime.ClientAuthInfoWriter) (*CreateSiteDevServerOK, error) { // TODO: Validate the params before sending @@ -1465,7 +1495,7 @@ func (a *Client) CreateSiteDevServer(params *CreateSiteDevServerParams, authInfo } /* -CreateSiteDevServerHook create site dev server hook API +CreateSiteDevServerHook creates a dev server hook */ func (a *Client) CreateSiteDevServerHook(params *CreateSiteDevServerHookParams, authInfo runtime.ClientAuthInfoWriter) (*CreateSiteDevServerHookCreated, error) { // TODO: Validate the params before sending @@ -1499,7 +1529,9 @@ func (a *Client) CreateSiteDevServerHook(params *CreateSiteDevServerHookParams, } /* -CreateSiteInTeam **Note:** Environment variable keys and values have moved from `build_settings.env` and `repo.env` to a new endpoint. Please use [createEnvVars](#tag/environmentVariables/operation/createEnvVars) to create environment variables for a site. +CreateSiteInTeam creates a site in a team + +**Note:** Environment variable keys and values have moved from `build_settings.env` and `repo.env` to a new endpoint. Please use [createEnvVars](#tag/environmentVariables/operation/createEnvVars) to create environment variables for a site. */ func (a *Client) CreateSiteInTeam(params *CreateSiteInTeamParams, authInfo runtime.ClientAuthInfoWriter) (*CreateSiteInTeamCreated, error) { // TODO: Validate the params before sending @@ -1533,7 +1565,7 @@ func (a *Client) CreateSiteInTeam(params *CreateSiteInTeamParams, authInfo runti } /* -CreateSiteSnippet create site snippet API +CreateSiteSnippet creates a snippet */ func (a *Client) CreateSiteSnippet(params *CreateSiteSnippetParams, authInfo runtime.ClientAuthInfoWriter) (*CreateSiteSnippetCreated, error) { // TODO: Validate the params before sending @@ -1567,7 +1599,7 @@ func (a *Client) CreateSiteSnippet(params *CreateSiteSnippetParams, authInfo run } /* -CreateSplitTest create split test API +CreateSplitTest creates a split test */ func (a *Client) CreateSplitTest(params *CreateSplitTestParams, authInfo runtime.ClientAuthInfoWriter) (*CreateSplitTestCreated, error) { // TODO: Validate the params before sending @@ -1601,7 +1633,7 @@ func (a *Client) CreateSplitTest(params *CreateSplitTestParams, authInfo runtime } /* -CreateTicket create ticket API +CreateTicket creates an o auth ticket */ func (a *Client) CreateTicket(params *CreateTicketParams, authInfo runtime.ClientAuthInfoWriter) (*CreateTicketCreated, error) { // TODO: Validate the params before sending @@ -1635,7 +1667,9 @@ func (a *Client) CreateTicket(params *CreateTicketParams, authInfo runtime.Clien } /* -DeleteAgentRunner Same as `POST /agent_runners/{agent_runner_id}/stop`. Doesn't delete the run. +DeleteAgentRunner stops an agent run alias + +Same as `POST /agent_runners/{agent_runner_id}/stop`. Doesn't delete the run. */ func (a *Client) DeleteAgentRunner(params *DeleteAgentRunnerParams, authInfo runtime.ClientAuthInfoWriter) (*DeleteAgentRunnerAccepted, error) { // TODO: Validate the params before sending @@ -1669,7 +1703,9 @@ func (a *Client) DeleteAgentRunner(params *DeleteAgentRunnerParams, authInfo run } /* -DeleteAgentRunnerSession Same as `POST /agent_runners/{agent_runner_id}/sessions/{agent_runner_session_id}/stop`. Doesn't delete the session. +DeleteAgentRunnerSession stops an agent run session alias + +Same as `POST /agent_runners/{agent_runner_id}/sessions/{agent_runner_session_id}/stop`. Doesn't delete the session. */ func (a *Client) DeleteAgentRunnerSession(params *DeleteAgentRunnerSessionParams, authInfo runtime.ClientAuthInfoWriter) (*DeleteAgentRunnerSessionAccepted, error) { // TODO: Validate the params before sending @@ -1703,7 +1739,9 @@ func (a *Client) DeleteAgentRunnerSession(params *DeleteAgentRunnerSessionParams } /* -DeleteDeploy delete deploy API +DeleteDeploy deletes a deploy + +Marks a deploy for deletion. */ func (a *Client) DeleteDeploy(params *DeleteDeployParams, authInfo runtime.ClientAuthInfoWriter) (*DeleteDeployNoContent, error) { // TODO: Validate the params before sending @@ -1737,7 +1775,7 @@ func (a *Client) DeleteDeploy(params *DeleteDeployParams, authInfo runtime.Clien } /* -DeleteDeployKey delete deploy key API +DeleteDeployKey deletes a deploy key */ func (a *Client) DeleteDeployKey(params *DeleteDeployKeyParams, authInfo runtime.ClientAuthInfoWriter) (*DeleteDeployKeyNoContent, error) { // TODO: Validate the params before sending @@ -1771,7 +1809,7 @@ func (a *Client) DeleteDeployKey(params *DeleteDeployKeyParams, authInfo runtime } /* -DeleteDNSRecord delete Dns record API +DeleteDNSRecord deletes a DNS record */ func (a *Client) DeleteDNSRecord(params *DeleteDNSRecordParams, authInfo runtime.ClientAuthInfoWriter) (*DeleteDNSRecordNoContent, error) { // TODO: Validate the params before sending @@ -1805,7 +1843,7 @@ func (a *Client) DeleteDNSRecord(params *DeleteDNSRecordParams, authInfo runtime } /* -DeleteDNSZone delete Dns zone API +DeleteDNSZone deletes a DNS zone */ func (a *Client) DeleteDNSZone(params *DeleteDNSZoneParams, authInfo runtime.ClientAuthInfoWriter) (*DeleteDNSZoneNoContent, error) { // TODO: Validate the params before sending @@ -1839,7 +1877,9 @@ func (a *Client) DeleteDNSZone(params *DeleteDNSZoneParams, authInfo runtime.Cli } /* -DeleteEnvVar Deletes an environment variable +DeleteEnvVar deletes an environment variable + +Deletes an environment variable */ func (a *Client) DeleteEnvVar(params *DeleteEnvVarParams, authInfo runtime.ClientAuthInfoWriter) (*DeleteEnvVarNoContent, error) { // TODO: Validate the params before sending @@ -1873,7 +1913,9 @@ func (a *Client) DeleteEnvVar(params *DeleteEnvVarParams, authInfo runtime.Clien } /* -DeleteEnvVarValue Deletes a specific environment variable value. +DeleteEnvVarValue deletes an environment variable value + +Deletes a specific environment variable value. */ func (a *Client) DeleteEnvVarValue(params *DeleteEnvVarValueParams, authInfo runtime.ClientAuthInfoWriter) (*DeleteEnvVarValueNoContent, error) { // TODO: Validate the params before sending @@ -1907,7 +1949,7 @@ func (a *Client) DeleteEnvVarValue(params *DeleteEnvVarValueParams, authInfo run } /* -DeleteHook delete hook API +DeleteHook deletes an outgoing hook */ func (a *Client) DeleteHook(params *DeleteHookParams, authInfo runtime.ClientAuthInfoWriter) (*DeleteHookNoContent, error) { // TODO: Validate the params before sending @@ -1942,7 +1984,7 @@ func (a *Client) DeleteHook(params *DeleteHookParams, authInfo runtime.ClientAut } /* -DeleteServiceInstance delete service instance API +DeleteServiceInstance deletes an add on instance */ func (a *Client) DeleteServiceInstance(params *DeleteServiceInstanceParams, authInfo runtime.ClientAuthInfoWriter) (*DeleteServiceInstanceNoContent, error) { // TODO: Validate the params before sending @@ -1976,7 +2018,7 @@ func (a *Client) DeleteServiceInstance(params *DeleteServiceInstanceParams, auth } /* -DeleteSite delete site API +DeleteSite deletes a site */ func (a *Client) DeleteSite(params *DeleteSiteParams, authInfo runtime.ClientAuthInfoWriter) (*DeleteSiteNoContent, error) { // TODO: Validate the params before sending @@ -2010,7 +2052,7 @@ func (a *Client) DeleteSite(params *DeleteSiteParams, authInfo runtime.ClientAut } /* -DeleteSiteAgentRunnerHook delete site agent runner hook API +DeleteSiteAgentRunnerHook deletes an agent runner hook */ func (a *Client) DeleteSiteAgentRunnerHook(params *DeleteSiteAgentRunnerHookParams, authInfo runtime.ClientAuthInfoWriter) (*DeleteSiteAgentRunnerHookNoContent, error) { // TODO: Validate the params before sending @@ -2044,7 +2086,9 @@ func (a *Client) DeleteSiteAgentRunnerHook(params *DeleteSiteAgentRunnerHookPara } /* -DeleteSiteAsset delete site asset API +DeleteSiteAsset deletes a site asset + +_This endpoint is only available to certain sites._ */ func (a *Client) DeleteSiteAsset(params *DeleteSiteAssetParams, authInfo runtime.ClientAuthInfoWriter) (*DeleteSiteAssetNoContent, error) { // TODO: Validate the params before sending @@ -2078,7 +2122,7 @@ func (a *Client) DeleteSiteAsset(params *DeleteSiteAssetParams, authInfo runtime } /* -DeleteSiteBuildHook delete site build hook API +DeleteSiteBuildHook deletes a build hook */ func (a *Client) DeleteSiteBuildHook(params *DeleteSiteBuildHookParams, authInfo runtime.ClientAuthInfoWriter) (*DeleteSiteBuildHookNoContent, error) { // TODO: Validate the params before sending @@ -2112,7 +2156,9 @@ func (a *Client) DeleteSiteBuildHook(params *DeleteSiteBuildHookParams, authInfo } /* -DeleteSiteDatabase Deletes the database and all associated branches and snapshots for the specified site. +DeleteSiteDatabase deletes a site database + +Deletes the database and all associated branches and snapshots for the specified site. */ func (a *Client) DeleteSiteDatabase(params *DeleteSiteDatabaseParams, authInfo runtime.ClientAuthInfoWriter) (*DeleteSiteDatabaseNoContent, error) { // TODO: Validate the params before sending @@ -2146,7 +2192,9 @@ func (a *Client) DeleteSiteDatabase(params *DeleteSiteDatabaseParams, authInfo r } /* -DeleteSiteDatabaseBranch Deletes a database branch. +DeleteSiteDatabaseBranch deletes a database branch + +Deletes a database branch. */ func (a *Client) DeleteSiteDatabaseBranch(params *DeleteSiteDatabaseBranchParams, authInfo runtime.ClientAuthInfoWriter) (*DeleteSiteDatabaseBranchNoContent, error) { // TODO: Validate the params before sending @@ -2180,7 +2228,9 @@ func (a *Client) DeleteSiteDatabaseBranch(params *DeleteSiteDatabaseBranchParams } /* -DeleteSiteDatabaseSnapshot Deletes a database snapshot. +DeleteSiteDatabaseSnapshot deletes a database snapshot + +Deletes a database snapshot. */ func (a *Client) DeleteSiteDatabaseSnapshot(params *DeleteSiteDatabaseSnapshotParams, authInfo runtime.ClientAuthInfoWriter) (*DeleteSiteDatabaseSnapshotNoContent, error) { // TODO: Validate the params before sending @@ -2214,7 +2264,9 @@ func (a *Client) DeleteSiteDatabaseSnapshot(params *DeleteSiteDatabaseSnapshotPa } /* -DeleteSiteDeploy delete site deploy API +DeleteSiteDeploy deletes a site s deploy + +Marks a deploy for deletion. */ func (a *Client) DeleteSiteDeploy(params *DeleteSiteDeployParams, authInfo runtime.ClientAuthInfoWriter) (*DeleteSiteDeployNoContent, error) { // TODO: Validate the params before sending @@ -2248,7 +2300,7 @@ func (a *Client) DeleteSiteDeploy(params *DeleteSiteDeployParams, authInfo runti } /* -DeleteSiteDevServerHook delete site dev server hook API +DeleteSiteDevServerHook deletes a dev server hook */ func (a *Client) DeleteSiteDevServerHook(params *DeleteSiteDevServerHookParams, authInfo runtime.ClientAuthInfoWriter) (*DeleteSiteDevServerHookNoContent, error) { // TODO: Validate the params before sending @@ -2282,7 +2334,9 @@ func (a *Client) DeleteSiteDevServerHook(params *DeleteSiteDevServerHookParams, } /* -DeleteSiteDevServers delete site dev servers API +DeleteSiteDevServers stops a branch s dev servers + +Stops all dev servers for a branch. Stopping happens in the background. */ func (a *Client) DeleteSiteDevServers(params *DeleteSiteDevServersParams, authInfo runtime.ClientAuthInfoWriter) (*DeleteSiteDevServersAccepted, error) { // TODO: Validate the params before sending @@ -2316,7 +2370,9 @@ func (a *Client) DeleteSiteDevServers(params *DeleteSiteDevServersParams, authIn } /* -DeleteSiteForm delete site form API +DeleteSiteForm deletes a form + +Deletes a form and all of its submissions. */ func (a *Client) DeleteSiteForm(params *DeleteSiteFormParams, authInfo runtime.ClientAuthInfoWriter) (*DeleteSiteFormNoContent, error) { // TODO: Validate the params before sending @@ -2350,7 +2406,7 @@ func (a *Client) DeleteSiteForm(params *DeleteSiteFormParams, authInfo runtime.C } /* -DeleteSiteSnippet delete site snippet API +DeleteSiteSnippet deletes a snippet */ func (a *Client) DeleteSiteSnippet(params *DeleteSiteSnippetParams, authInfo runtime.ClientAuthInfoWriter) (*DeleteSiteSnippetNoContent, error) { // TODO: Validate the params before sending @@ -2384,7 +2440,7 @@ func (a *Client) DeleteSiteSnippet(params *DeleteSiteSnippetParams, authInfo run } /* -DeleteSubmission delete submission API +DeleteSubmission deletes a form submission */ func (a *Client) DeleteSubmission(params *DeleteSubmissionParams, authInfo runtime.ClientAuthInfoWriter) (*DeleteSubmissionNoContent, error) { // TODO: Validate the params before sending @@ -2418,7 +2474,9 @@ func (a *Client) DeleteSubmission(params *DeleteSubmissionParams, authInfo runti } /* -DisableSite Disables a site, preventing it from serving content. The site can be re-enabled later using the enable endpoint. +DisableSite disables a site + +Disables a site, preventing it from serving content. The site can be re-enabled later using the enable endpoint. */ func (a *Client) DisableSite(params *DisableSiteParams, authInfo runtime.ClientAuthInfoWriter) (*DisableSiteNoContent, error) { // TODO: Validate the params before sending @@ -2452,7 +2510,7 @@ func (a *Client) DisableSite(params *DisableSiteParams, authInfo runtime.ClientA } /* -DisableSplitTest disable split test API +DisableSplitTest unpublishes a split test */ func (a *Client) DisableSplitTest(params *DisableSplitTestParams, authInfo runtime.ClientAuthInfoWriter) (*DisableSplitTestNoContent, error) { // TODO: Validate the params before sending @@ -2486,7 +2544,9 @@ func (a *Client) DisableSplitTest(params *DisableSplitTestParams, authInfo runti } /* -EnableHook enable hook API +EnableHook res enable an outgoing hook + +Re-enables an outgoing hook that was disabled after repeated delivery errors. */ func (a *Client) EnableHook(params *EnableHookParams, authInfo runtime.ClientAuthInfoWriter) (*EnableHookOK, error) { // TODO: Validate the params before sending @@ -2520,7 +2580,9 @@ func (a *Client) EnableHook(params *EnableHookParams, authInfo runtime.ClientAut } /* -EnableSite Re-enables a site that was previously disabled by the user. Sites that were disabled for usage exceeded or marked as spam cannot be re-enabled via this endpoint. +EnableSite enables a site + +Re-enables a site that was previously disabled by the user. Sites that were disabled for usage exceeded or marked as spam cannot be re-enabled via this endpoint. */ func (a *Client) EnableSite(params *EnableSiteParams, authInfo runtime.ClientAuthInfoWriter) (*EnableSiteNoContent, error) { // TODO: Validate the params before sending @@ -2554,7 +2616,7 @@ func (a *Client) EnableSite(params *EnableSiteParams, authInfo runtime.ClientAut } /* -EnableSplitTest enable split test API +EnableSplitTest publishes a split test */ func (a *Client) EnableSplitTest(params *EnableSplitTestParams, authInfo runtime.ClientAuthInfoWriter) (*EnableSplitTestNoContent, error) { // TODO: Validate the params before sending @@ -2588,7 +2650,7 @@ func (a *Client) EnableSplitTest(params *EnableSplitTestParams, authInfo runtime } /* -ExchangeTicket exchange ticket API +ExchangeTicket exchanges an o auth ticket for an access token */ func (a *Client) ExchangeTicket(params *ExchangeTicketParams, authInfo runtime.ClientAuthInfoWriter) (*ExchangeTicketCreated, error) { // TODO: Validate the params before sending @@ -2622,7 +2684,7 @@ func (a *Client) ExchangeTicket(params *ExchangeTicketParams, authInfo runtime.C } /* -GetAIGatewayProviders get a i gateway providers API +GetAIGatewayProviders lists a i gateway providers and models */ func (a *Client) GetAIGatewayProviders(params *GetAIGatewayProvidersParams) (*GetAIGatewayProvidersOK, error) { // TODO: Validate the params before sending @@ -2655,7 +2717,9 @@ func (a *Client) GetAIGatewayProviders(params *GetAIGatewayProvidersParams) (*Ge } /* -GetAIGatewayToken Returns an AI Gateway token for a specific site +GetAIGatewayToken gets a site s a i gateway token + +Returns an AI Gateway token for a specific site */ func (a *Client) GetAIGatewayToken(params *GetAIGatewayTokenParams, authInfo runtime.ClientAuthInfoWriter) (*GetAIGatewayTokenOK, error) { // TODO: Validate the params before sending @@ -2689,7 +2753,7 @@ func (a *Client) GetAIGatewayToken(params *GetAIGatewayTokenParams, authInfo run } /* -GetAccount get account API +GetAccount gets a team */ func (a *Client) GetAccount(params *GetAccountParams, authInfo runtime.ClientAuthInfoWriter) (*GetAccountOK, error) { // TODO: Validate the params before sending @@ -2723,7 +2787,9 @@ func (a *Client) GetAccount(params *GetAccountParams, authInfo runtime.ClientAut } /* -GetAccountAIGatewayToken Returns an AI Gateway token scoped to an account +GetAccountAIGatewayToken gets a team s a i gateway token + +Returns an AI Gateway token scoped to an account */ func (a *Client) GetAccountAIGatewayToken(params *GetAccountAIGatewayTokenParams, authInfo runtime.ClientAuthInfoWriter) (*GetAccountAIGatewayTokenOK, error) { // TODO: Validate the params before sending @@ -2757,7 +2823,9 @@ func (a *Client) GetAccountAIGatewayToken(params *GetAccountAIGatewayTokenParams } /* -GetAccountBuildStatus get account build status API +GetAccountBuildStatus gets a team s build status + +Returns the team's counts of active, concurrency-pending, and enqueued builds, and its build minutes usage. */ func (a *Client) GetAccountBuildStatus(params *GetAccountBuildStatusParams, authInfo runtime.ClientAuthInfoWriter) (*GetAccountBuildStatusOK, error) { // TODO: Validate the params before sending @@ -2791,7 +2859,7 @@ func (a *Client) GetAccountBuildStatus(params *GetAccountBuildStatusParams, auth } /* -GetAccountMember get account member API +GetAccountMember gets a team member */ func (a *Client) GetAccountMember(params *GetAccountMemberParams, authInfo runtime.ClientAuthInfoWriter) (*GetAccountMemberOK, error) { // TODO: Validate the params before sending @@ -2825,7 +2893,7 @@ func (a *Client) GetAccountMember(params *GetAccountMemberParams, authInfo runti } /* -GetAgentRunner get agent runner API +GetAgentRunner gets an agent run */ func (a *Client) GetAgentRunner(params *GetAgentRunnerParams, authInfo runtime.ClientAuthInfoWriter) (*GetAgentRunnerOK, error) { // TODO: Validate the params before sending @@ -2859,7 +2927,9 @@ func (a *Client) GetAgentRunner(params *GetAgentRunnerParams, authInfo runtime.C } /* -GetAgentRunnerDiff Returns the run's changes as a unified diff. With `page`, returns that page of changed files and sets pagination headers. +GetAgentRunnerDiff gets an agent run s diff + +Returns the run's changes as a unified diff. With `page`, returns that page of changed files and sets pagination headers. */ func (a *Client) GetAgentRunnerDiff(params *GetAgentRunnerDiffParams, authInfo runtime.ClientAuthInfoWriter) (*GetAgentRunnerDiffOK, error) { // TODO: Validate the params before sending @@ -2893,7 +2963,7 @@ func (a *Client) GetAgentRunnerDiff(params *GetAgentRunnerDiffParams, authInfo r } /* -GetAgentRunnerSession get agent runner session API +GetAgentRunnerSession gets an agent run session */ func (a *Client) GetAgentRunnerSession(params *GetAgentRunnerSessionParams, authInfo runtime.ClientAuthInfoWriter) (*GetAgentRunnerSessionOK, error) { // TODO: Validate the params before sending @@ -2927,7 +2997,9 @@ func (a *Client) GetAgentRunnerSession(params *GetAgentRunnerSessionParams, auth } /* -GetAllCertificates get all certificates API +GetAllCertificates lists TLS certificates for a site s domain + +Returns details about the certificates associated with a domain. The site must be using the domain. */ func (a *Client) GetAllCertificates(params *GetAllCertificatesParams, authInfo runtime.ClientAuthInfoWriter) (*GetAllCertificatesOK, error) { // TODO: Validate the params before sending @@ -2962,7 +3034,7 @@ func (a *Client) GetAllCertificates(params *GetAllCertificatesParams, authInfo r } /* -GetCurrentUser get current user API +GetCurrentUser gets the current user */ func (a *Client) GetCurrentUser(params *GetCurrentUserParams, authInfo runtime.ClientAuthInfoWriter) (*GetCurrentUserOK, error) { // TODO: Validate the params before sending @@ -2996,7 +3068,7 @@ func (a *Client) GetCurrentUser(params *GetCurrentUserParams, authInfo runtime.C } /* -GetDNSForSite get DNS for site API +GetDNSForSite gets a site s DNS configuration */ func (a *Client) GetDNSForSite(params *GetDNSForSiteParams, authInfo runtime.ClientAuthInfoWriter) (*GetDNSForSiteOK, error) { // TODO: Validate the params before sending @@ -3030,7 +3102,7 @@ func (a *Client) GetDNSForSite(params *GetDNSForSiteParams, authInfo runtime.Cli } /* -GetDeploy get deploy API +GetDeploy gets a deploy */ func (a *Client) GetDeploy(params *GetDeployParams, authInfo runtime.ClientAuthInfoWriter) (*GetDeployOK, error) { // TODO: Validate the params before sending @@ -3064,7 +3136,7 @@ func (a *Client) GetDeploy(params *GetDeployParams, authInfo runtime.ClientAuthI } /* -GetDeployKey get deploy key API +GetDeployKey gets a deploy key */ func (a *Client) GetDeployKey(params *GetDeployKeyParams, authInfo runtime.ClientAuthInfoWriter) (*GetDeployKeyOK, error) { // TODO: Validate the params before sending @@ -3098,7 +3170,7 @@ func (a *Client) GetDeployKey(params *GetDeployKeyParams, authInfo runtime.Clien } /* -GetDNSRecords get Dns records API +GetDNSRecords lists a DNS zone s records */ func (a *Client) GetDNSRecords(params *GetDNSRecordsParams, authInfo runtime.ClientAuthInfoWriter) (*GetDNSRecordsOK, error) { // TODO: Validate the params before sending @@ -3132,7 +3204,7 @@ func (a *Client) GetDNSRecords(params *GetDNSRecordsParams, authInfo runtime.Cli } /* -GetDNSZone get Dns zone API +GetDNSZone gets a DNS zone */ func (a *Client) GetDNSZone(params *GetDNSZoneParams, authInfo runtime.ClientAuthInfoWriter) (*GetDNSZoneOK, error) { // TODO: Validate the params before sending @@ -3166,7 +3238,9 @@ func (a *Client) GetDNSZone(params *GetDNSZoneParams, authInfo runtime.ClientAut } /* -GetDNSZones get Dns zones API +GetDNSZones lists DNS zones + +Returns the DNS zones for the team given by `account_slug`, or all DNS zones the current user can access. */ func (a *Client) GetDNSZones(params *GetDNSZonesParams, authInfo runtime.ClientAuthInfoWriter) (*GetDNSZonesOK, error) { // TODO: Validate the params before sending @@ -3200,7 +3274,9 @@ func (a *Client) GetDNSZones(params *GetDNSZonesParams, authInfo runtime.ClientA } /* -GetEnvVar Returns an individual environment variable. +GetEnvVar gets an environment variable + +Returns an individual environment variable. */ func (a *Client) GetEnvVar(params *GetEnvVarParams, authInfo runtime.ClientAuthInfoWriter) (*GetEnvVarOK, error) { // TODO: Validate the params before sending @@ -3234,7 +3310,9 @@ func (a *Client) GetEnvVar(params *GetEnvVarParams, authInfo runtime.ClientAuthI } /* -GetEnvVars Returns all environment variables for an account or site. An account corresponds to a team in the Netlify UI. +GetEnvVars lists environment variables for a team or site + +Returns all environment variables for an account or site. An account corresponds to a team in the Netlify UI. */ func (a *Client) GetEnvVars(params *GetEnvVarsParams, authInfo runtime.ClientAuthInfoWriter) (*GetEnvVarsOK, error) { // TODO: Validate the params before sending @@ -3268,7 +3346,7 @@ func (a *Client) GetEnvVars(params *GetEnvVarsParams, authInfo runtime.ClientAut } /* -GetHook get hook API +GetHook gets an outgoing hook */ func (a *Client) GetHook(params *GetHookParams, authInfo runtime.ClientAuthInfoWriter) (*GetHookOK, error) { // TODO: Validate the params before sending @@ -3302,7 +3380,7 @@ func (a *Client) GetHook(params *GetHookParams, authInfo runtime.ClientAuthInfoW } /* -GetIndividualDNSRecord get individual Dns record API +GetIndividualDNSRecord gets a DNS record */ func (a *Client) GetIndividualDNSRecord(params *GetIndividualDNSRecordParams, authInfo runtime.ClientAuthInfoWriter) (*GetIndividualDNSRecordOK, error) { // TODO: Validate the params before sending @@ -3336,7 +3414,9 @@ func (a *Client) GetIndividualDNSRecord(params *GetIndividualDNSRecordParams, au } /* -GetLatestPluginRuns This is an internal-only endpoint. +GetLatestPluginRuns lists a site s latest build plugin runs + +This is an internal-only endpoint. */ func (a *Client) GetLatestPluginRuns(params *GetLatestPluginRunsParams, authInfo runtime.ClientAuthInfoWriter) (*GetLatestPluginRunsOK, error) { // TODO: Validate the params before sending @@ -3370,7 +3450,7 @@ func (a *Client) GetLatestPluginRuns(params *GetLatestPluginRunsParams, authInfo } /* -GetServices get services API +GetServices lists add on services */ func (a *Client) GetServices(params *GetServicesParams, authInfo runtime.ClientAuthInfoWriter) (*GetServicesOK, error) { // TODO: Validate the params before sending @@ -3404,7 +3484,9 @@ func (a *Client) GetServices(params *GetServicesParams, authInfo runtime.ClientA } /* -GetSite **Note:** Environment variable keys and values have moved from `build_settings.env` and `repo.env` to a new endpoint. Please use [getEnvVars](#tag/environmentVariables/operation/getEnvVars) to retrieve site environment variables. +GetSite gets a site + +**Note:** Environment variable keys and values have moved from `build_settings.env` and `repo.env` to a new endpoint. Please use [getEnvVars](#tag/environmentVariables/operation/getEnvVars) to retrieve site environment variables. */ func (a *Client) GetSite(params *GetSiteParams, authInfo runtime.ClientAuthInfoWriter) (*GetSiteOK, error) { // TODO: Validate the params before sending @@ -3438,7 +3520,7 @@ func (a *Client) GetSite(params *GetSiteParams, authInfo runtime.ClientAuthInfoW } /* -GetSiteAgentRunnerHook get site agent runner hook API +GetSiteAgentRunnerHook gets an agent runner hook */ func (a *Client) GetSiteAgentRunnerHook(params *GetSiteAgentRunnerHookParams, authInfo runtime.ClientAuthInfoWriter) (*GetSiteAgentRunnerHookOK, error) { // TODO: Validate the params before sending @@ -3472,7 +3554,9 @@ func (a *Client) GetSiteAgentRunnerHook(params *GetSiteAgentRunnerHookParams, au } /* -GetSiteAssetInfo get site asset info API +GetSiteAssetInfo gets a site asset + +_This endpoint is only available to certain sites._ */ func (a *Client) GetSiteAssetInfo(params *GetSiteAssetInfoParams, authInfo runtime.ClientAuthInfoWriter) (*GetSiteAssetInfoOK, error) { // TODO: Validate the params before sending @@ -3506,7 +3590,9 @@ func (a *Client) GetSiteAssetInfo(params *GetSiteAssetInfoParams, authInfo runti } /* -GetSiteAssetPublicSignature get site asset public signature API +GetSiteAssetPublicSignature gets a site asset s URL + +Returns the URL of the asset. If the asset isn't publicly visible, returns a signed URL. _This endpoint is only available to certain sites._ */ func (a *Client) GetSiteAssetPublicSignature(params *GetSiteAssetPublicSignatureParams, authInfo runtime.ClientAuthInfoWriter) (*GetSiteAssetPublicSignatureOK, error) { // TODO: Validate the params before sending @@ -3540,7 +3626,7 @@ func (a *Client) GetSiteAssetPublicSignature(params *GetSiteAssetPublicSignature } /* -GetSiteBuild get site build API +GetSiteBuild gets a build */ func (a *Client) GetSiteBuild(params *GetSiteBuildParams, authInfo runtime.ClientAuthInfoWriter) (*GetSiteBuildOK, error) { // TODO: Validate the params before sending @@ -3574,7 +3660,7 @@ func (a *Client) GetSiteBuild(params *GetSiteBuildParams, authInfo runtime.Clien } /* -GetSiteBuildHook get site build hook API +GetSiteBuildHook gets a build hook */ func (a *Client) GetSiteBuildHook(params *GetSiteBuildHookParams, authInfo runtime.ClientAuthInfoWriter) (*GetSiteBuildHookOK, error) { // TODO: Validate the params before sending @@ -3608,7 +3694,9 @@ func (a *Client) GetSiteBuildHook(params *GetSiteBuildHookParams, authInfo runti } /* -GetSiteDatabase Returns the database connection string for the specified site. +GetSiteDatabase gets a site database + +Returns the database connection string for the specified site. */ func (a *Client) GetSiteDatabase(params *GetSiteDatabaseParams, authInfo runtime.ClientAuthInfoWriter) (*GetSiteDatabaseOK, error) { // TODO: Validate the params before sending @@ -3642,7 +3730,9 @@ func (a *Client) GetSiteDatabase(params *GetSiteDatabaseParams, authInfo runtime } /* -GetSiteDatabaseBranch Returns the database branch connection string for a specific branch. +GetSiteDatabaseBranch gets a database branch + +Returns the database branch connection string for a specific branch. */ func (a *Client) GetSiteDatabaseBranch(params *GetSiteDatabaseBranchParams, authInfo runtime.ClientAuthInfoWriter) (*GetSiteDatabaseBranchOK, error) { // TODO: Validate the params before sending @@ -3676,7 +3766,9 @@ func (a *Client) GetSiteDatabaseBranch(params *GetSiteDatabaseBranchParams, auth } /* -GetSiteDatabaseComputeSettings Returns the project-level compute settings for the database. Returns effective settings (custom or tier defaults). Requires a Pro or higher plan. +GetSiteDatabaseComputeSettings gets database compute settings + +Returns the project-level compute settings for the database. Returns effective settings (custom or tier defaults). Requires a Pro or higher plan. */ func (a *Client) GetSiteDatabaseComputeSettings(params *GetSiteDatabaseComputeSettingsParams, authInfo runtime.ClientAuthInfoWriter) (*GetSiteDatabaseComputeSettingsOK, error) { // TODO: Validate the params before sending @@ -3710,7 +3802,9 @@ func (a *Client) GetSiteDatabaseComputeSettings(params *GetSiteDatabaseComputeSe } /* -GetSiteDatabaseMigration Returns the contents of a named migration for the specified branch. +GetSiteDatabaseMigration gets a database migration + +Returns the contents of a named migration for the specified branch. */ func (a *Client) GetSiteDatabaseMigration(params *GetSiteDatabaseMigrationParams, authInfo runtime.ClientAuthInfoWriter) (*GetSiteDatabaseMigrationOK, error) { // TODO: Validate the params before sending @@ -3744,7 +3838,7 @@ func (a *Client) GetSiteDatabaseMigration(params *GetSiteDatabaseMigrationParams } /* -GetSiteDeploy get site deploy API +GetSiteDeploy gets a site s deploy */ func (a *Client) GetSiteDeploy(params *GetSiteDeployParams, authInfo runtime.ClientAuthInfoWriter) (*GetSiteDeployOK, error) { // TODO: Validate the params before sending @@ -3778,7 +3872,7 @@ func (a *Client) GetSiteDeploy(params *GetSiteDeployParams, authInfo runtime.Cli } /* -GetSiteDevServer get site dev server API +GetSiteDevServer gets a dev server */ func (a *Client) GetSiteDevServer(params *GetSiteDevServerParams, authInfo runtime.ClientAuthInfoWriter) (*GetSiteDevServerOK, error) { // TODO: Validate the params before sending @@ -3813,7 +3907,7 @@ func (a *Client) GetSiteDevServer(params *GetSiteDevServerParams, authInfo runti } /* -GetSiteDevServerHook get site dev server hook API +GetSiteDevServerHook gets a dev server hook */ func (a *Client) GetSiteDevServerHook(params *GetSiteDevServerHookParams, authInfo runtime.ClientAuthInfoWriter) (*GetSiteDevServerHookOK, error) { // TODO: Validate the params before sending @@ -3847,7 +3941,9 @@ func (a *Client) GetSiteDevServerHook(params *GetSiteDevServerHookParams, authIn } /* -GetSiteEnvVars Returns all environment variables for a site. This convenience method behaves the same as `getEnvVars` but doesn't require an `account_id` as input. +GetSiteEnvVars lists environment variables for a site + +Returns all environment variables for a site. This convenience method behaves the same as `getEnvVars` but doesn't require an `account_id` as input. */ func (a *Client) GetSiteEnvVars(params *GetSiteEnvVarsParams, authInfo runtime.ClientAuthInfoWriter) (*GetSiteEnvVarsOK, error) { // TODO: Validate the params before sending @@ -3881,7 +3977,7 @@ func (a *Client) GetSiteEnvVars(params *GetSiteEnvVarsParams, authInfo runtime.C } /* -GetSiteFileByPathName get site file by path name API +GetSiteFileByPathName gets a site file by path */ func (a *Client) GetSiteFileByPathName(params *GetSiteFileByPathNameParams, authInfo runtime.ClientAuthInfoWriter) (*GetSiteFileByPathNameOK, error) { // TODO: Validate the params before sending @@ -3915,7 +4011,7 @@ func (a *Client) GetSiteFileByPathName(params *GetSiteFileByPathNameParams, auth } /* -GetSiteMetadata get site metadata API +GetSiteMetadata gets a site s metadata */ func (a *Client) GetSiteMetadata(params *GetSiteMetadataParams, authInfo runtime.ClientAuthInfoWriter) (*GetSiteMetadataOK, error) { // TODO: Validate the params before sending @@ -3949,7 +4045,7 @@ func (a *Client) GetSiteMetadata(params *GetSiteMetadataParams, authInfo runtime } /* -GetSiteSnippet get site snippet API +GetSiteSnippet gets a snippet */ func (a *Client) GetSiteSnippet(params *GetSiteSnippetParams, authInfo runtime.ClientAuthInfoWriter) (*GetSiteSnippetOK, error) { // TODO: Validate the params before sending @@ -3983,7 +4079,7 @@ func (a *Client) GetSiteSnippet(params *GetSiteSnippetParams, authInfo runtime.C } /* -GetSplitTest get split test API +GetSplitTest gets a split test */ func (a *Client) GetSplitTest(params *GetSplitTestParams, authInfo runtime.ClientAuthInfoWriter) (*GetSplitTestOK, error) { // TODO: Validate the params before sending @@ -4017,7 +4113,7 @@ func (a *Client) GetSplitTest(params *GetSplitTestParams, authInfo runtime.Clien } /* -GetSplitTests get split tests API +GetSplitTests lists a site s split tests */ func (a *Client) GetSplitTests(params *GetSplitTestsParams, authInfo runtime.ClientAuthInfoWriter) (*GetSplitTestsOK, error) { // TODO: Validate the params before sending @@ -4051,7 +4147,7 @@ func (a *Client) GetSplitTests(params *GetSplitTestsParams, authInfo runtime.Cli } /* -ListAccountAuditEvents list account audit events API +ListAccountAuditEvents lists a team s audit log events */ func (a *Client) ListAccountAuditEvents(params *ListAccountAuditEventsParams, authInfo runtime.ClientAuthInfoWriter) (*ListAccountAuditEventsOK, error) { // TODO: Validate the params before sending @@ -4085,7 +4181,7 @@ func (a *Client) ListAccountAuditEvents(params *ListAccountAuditEventsParams, au } /* -ListAccountTypesForUser list account types for user API +ListAccountTypesForUser lists plans available for new teams */ func (a *Client) ListAccountTypesForUser(params *ListAccountTypesForUserParams, authInfo runtime.ClientAuthInfoWriter) (*ListAccountTypesForUserOK, error) { // TODO: Validate the params before sending @@ -4119,7 +4215,7 @@ func (a *Client) ListAccountTypesForUser(params *ListAccountTypesForUserParams, } /* -ListAccountsForUser list accounts for user API +ListAccountsForUser lists the current user s teams */ func (a *Client) ListAccountsForUser(params *ListAccountsForUserParams, authInfo runtime.ClientAuthInfoWriter) (*ListAccountsForUserOK, error) { // TODO: Validate the params before sending @@ -4153,7 +4249,7 @@ func (a *Client) ListAccountsForUser(params *ListAccountsForUserParams, authInfo } /* -ListAgentRunnerSessions list agent runner sessions API +ListAgentRunnerSessions lists an agent run s sessions */ func (a *Client) ListAgentRunnerSessions(params *ListAgentRunnerSessionsParams, authInfo runtime.ClientAuthInfoWriter) (*ListAgentRunnerSessionsOK, error) { // TODO: Validate the params before sending @@ -4187,7 +4283,9 @@ func (a *Client) ListAgentRunnerSessions(params *ListAgentRunnerSessionsParams, } /* -ListAgentRunners Lists a site's agent runs, most recently active first. Archived runs are left out unless `state` is `archived`. +ListAgentRunners lists a site s agent runs + +Lists a site's agent runs, most recently active first. Archived runs are left out unless `state` is `archived`. */ func (a *Client) ListAgentRunners(params *ListAgentRunnersParams, authInfo runtime.ClientAuthInfoWriter) (*ListAgentRunnersOK, error) { // TODO: Validate the params before sending @@ -4221,7 +4319,7 @@ func (a *Client) ListAgentRunners(params *ListAgentRunnersParams, authInfo runti } /* -ListDeployKeys list deploy keys API +ListDeployKeys lists deploy keys */ func (a *Client) ListDeployKeys(params *ListDeployKeysParams, authInfo runtime.ClientAuthInfoWriter) (*ListDeployKeysOK, error) { // TODO: Validate the params before sending @@ -4255,7 +4353,7 @@ func (a *Client) ListDeployKeys(params *ListDeployKeysParams, authInfo runtime.C } /* -ListFormSubmission list form submission API +ListFormSubmission gets a form submission */ func (a *Client) ListFormSubmission(params *ListFormSubmissionParams, authInfo runtime.ClientAuthInfoWriter) (*ListFormSubmissionOK, error) { // TODO: Validate the params before sending @@ -4289,7 +4387,7 @@ func (a *Client) ListFormSubmission(params *ListFormSubmissionParams, authInfo r } /* -ListFormSubmissions list form submissions API +ListFormSubmissions lists a form s submissions */ func (a *Client) ListFormSubmissions(params *ListFormSubmissionsParams, authInfo runtime.ClientAuthInfoWriter) (*ListFormSubmissionsOK, error) { // TODO: Validate the params before sending @@ -4323,7 +4421,9 @@ func (a *Client) ListFormSubmissions(params *ListFormSubmissionsParams, authInfo } /* -ListHookTypes list hook types API +ListHookTypes lists outgoing hook types + +Returns the available outgoing hook types. When `site_id` is given, returns only the types available to that site. */ func (a *Client) ListHookTypes(params *ListHookTypesParams, authInfo runtime.ClientAuthInfoWriter) (*ListHookTypesOK, error) { // TODO: Validate the params before sending @@ -4357,7 +4457,9 @@ func (a *Client) ListHookTypes(params *ListHookTypesParams, authInfo runtime.Cli } /* -ListHooksBySiteID list hooks by site Id API +ListHooksBySiteID lists a site s outgoing hooks + +Returns the outgoing hooks for a site. Pass `form_id` or `event` to filter the results. */ func (a *Client) ListHooksBySiteID(params *ListHooksBySiteIDParams, authInfo runtime.ClientAuthInfoWriter) (*ListHooksBySiteIDOK, error) { // TODO: Validate the params before sending @@ -4391,7 +4493,7 @@ func (a *Client) ListHooksBySiteID(params *ListHooksBySiteIDParams, authInfo run } /* -ListMembersForAccount list members for account API +ListMembersForAccount lists a team s members */ func (a *Client) ListMembersForAccount(params *ListMembersForAccountParams, authInfo runtime.ClientAuthInfoWriter) (*ListMembersForAccountOK, error) { // TODO: Validate the params before sending @@ -4425,7 +4527,7 @@ func (a *Client) ListMembersForAccount(params *ListMembersForAccountParams, auth } /* -ListPaymentMethodsForUser list payment methods for user API +ListPaymentMethodsForUser lists payment methods */ func (a *Client) ListPaymentMethodsForUser(params *ListPaymentMethodsForUserParams, authInfo runtime.ClientAuthInfoWriter) (*ListPaymentMethodsForUserOK, error) { // TODO: Validate the params before sending @@ -4459,7 +4561,7 @@ func (a *Client) ListPaymentMethodsForUser(params *ListPaymentMethodsForUserPara } /* -ListServiceInstancesForSite list service instances for site API +ListServiceInstancesForSite lists a site s add on instances */ func (a *Client) ListServiceInstancesForSite(params *ListServiceInstancesForSiteParams, authInfo runtime.ClientAuthInfoWriter) (*ListServiceInstancesForSiteOK, error) { // TODO: Validate the params before sending @@ -4493,7 +4595,7 @@ func (a *Client) ListServiceInstancesForSite(params *ListServiceInstancesForSite } /* -ListSiteAgentRunnerHooks list site agent runner hooks API +ListSiteAgentRunnerHooks lists a site s agent runner hooks */ func (a *Client) ListSiteAgentRunnerHooks(params *ListSiteAgentRunnerHooksParams, authInfo runtime.ClientAuthInfoWriter) (*ListSiteAgentRunnerHooksOK, error) { // TODO: Validate the params before sending @@ -4527,7 +4629,9 @@ func (a *Client) ListSiteAgentRunnerHooks(params *ListSiteAgentRunnerHooksParams } /* -ListSiteAssets list site assets API +ListSiteAssets lists a site s assets + +_This endpoint is only available to certain sites._ */ func (a *Client) ListSiteAssets(params *ListSiteAssetsParams, authInfo runtime.ClientAuthInfoWriter) (*ListSiteAssetsOK, error) { // TODO: Validate the params before sending @@ -4561,7 +4665,7 @@ func (a *Client) ListSiteAssets(params *ListSiteAssetsParams, authInfo runtime.C } /* -ListSiteBuildHooks list site build hooks API +ListSiteBuildHooks lists a site s build hooks */ func (a *Client) ListSiteBuildHooks(params *ListSiteBuildHooksParams, authInfo runtime.ClientAuthInfoWriter) (*ListSiteBuildHooksOK, error) { // TODO: Validate the params before sending @@ -4595,7 +4699,7 @@ func (a *Client) ListSiteBuildHooks(params *ListSiteBuildHooksParams, authInfo r } /* -ListSiteBuilds list site builds API +ListSiteBuilds lists a site s builds */ func (a *Client) ListSiteBuilds(params *ListSiteBuildsParams, authInfo runtime.ClientAuthInfoWriter) (*ListSiteBuildsOK, error) { // TODO: Validate the params before sending @@ -4629,7 +4733,9 @@ func (a *Client) ListSiteBuilds(params *ListSiteBuildsParams, authInfo runtime.C } /* -ListSiteDatabaseBranches Returns all branches for the site's database with compute status and metadata. +ListSiteDatabaseBranches lists database branches + +Returns all branches for the site's database with compute status and metadata. */ func (a *Client) ListSiteDatabaseBranches(params *ListSiteDatabaseBranchesParams, authInfo runtime.ClientAuthInfoWriter) (*ListSiteDatabaseBranchesOK, error) { // TODO: Validate the params before sending @@ -4663,7 +4769,9 @@ func (a *Client) ListSiteDatabaseBranches(params *ListSiteDatabaseBranchesParams } /* -ListSiteDatabaseMigrations Returns the list of migrations available for the specified branch, indicating which ones have been applied to the database. +ListSiteDatabaseMigrations lists database migrations + +Returns the list of migrations available for the specified branch, indicating which ones have been applied to the database. */ func (a *Client) ListSiteDatabaseMigrations(params *ListSiteDatabaseMigrationsParams, authInfo runtime.ClientAuthInfoWriter) (*ListSiteDatabaseMigrationsOK, error) { // TODO: Validate the params before sending @@ -4697,7 +4805,9 @@ func (a *Client) ListSiteDatabaseMigrations(params *ListSiteDatabaseMigrationsPa } /* -ListSiteDatabaseSnapshots Returns all snapshots for the site's database. +ListSiteDatabaseSnapshots lists database snapshots + +Returns all snapshots for the site's database. */ func (a *Client) ListSiteDatabaseSnapshots(params *ListSiteDatabaseSnapshotsParams, authInfo runtime.ClientAuthInfoWriter) (*ListSiteDatabaseSnapshotsOK, error) { // TODO: Validate the params before sending @@ -4731,7 +4841,7 @@ func (a *Client) ListSiteDatabaseSnapshots(params *ListSiteDatabaseSnapshotsPara } /* -ListSiteDeployedBranches list site deployed branches API +ListSiteDeployedBranches lists a site s deployed branches */ func (a *Client) ListSiteDeployedBranches(params *ListSiteDeployedBranchesParams, authInfo runtime.ClientAuthInfoWriter) (*ListSiteDeployedBranchesOK, error) { // TODO: Validate the params before sending @@ -4765,7 +4875,7 @@ func (a *Client) ListSiteDeployedBranches(params *ListSiteDeployedBranchesParams } /* -ListSiteDeploys list site deploys API +ListSiteDeploys lists a site s deploys */ func (a *Client) ListSiteDeploys(params *ListSiteDeploysParams, authInfo runtime.ClientAuthInfoWriter) (*ListSiteDeploysOK, error) { // TODO: Validate the params before sending @@ -4799,7 +4909,7 @@ func (a *Client) ListSiteDeploys(params *ListSiteDeploysParams, authInfo runtime } /* -ListSiteDevServerHooks list site dev server hooks API +ListSiteDevServerHooks lists a site s dev server hooks */ func (a *Client) ListSiteDevServerHooks(params *ListSiteDevServerHooksParams, authInfo runtime.ClientAuthInfoWriter) (*ListSiteDevServerHooksOK, error) { // TODO: Validate the params before sending @@ -4833,7 +4943,7 @@ func (a *Client) ListSiteDevServerHooks(params *ListSiteDevServerHooksParams, au } /* -ListSiteDevServers list site dev servers API +ListSiteDevServers lists a site s dev servers */ func (a *Client) ListSiteDevServers(params *ListSiteDevServersParams, authInfo runtime.ClientAuthInfoWriter) (*ListSiteDevServersOK, error) { // TODO: Validate the params before sending @@ -4867,7 +4977,7 @@ func (a *Client) ListSiteDevServers(params *ListSiteDevServersParams, authInfo r } /* -ListSiteFiles list site files API +ListSiteFiles lists a site s files */ func (a *Client) ListSiteFiles(params *ListSiteFilesParams, authInfo runtime.ClientAuthInfoWriter) (*ListSiteFilesOK, error) { // TODO: Validate the params before sending @@ -4901,7 +5011,7 @@ func (a *Client) ListSiteFiles(params *ListSiteFilesParams, authInfo runtime.Cli } /* -ListSiteForms list site forms API +ListSiteForms lists a site s forms */ func (a *Client) ListSiteForms(params *ListSiteFormsParams, authInfo runtime.ClientAuthInfoWriter) (*ListSiteFormsOK, error) { // TODO: Validate the params before sending @@ -4935,7 +5045,7 @@ func (a *Client) ListSiteForms(params *ListSiteFormsParams, authInfo runtime.Cli } /* -ListSiteSnippets list site snippets API +ListSiteSnippets lists a site s snippets */ func (a *Client) ListSiteSnippets(params *ListSiteSnippetsParams, authInfo runtime.ClientAuthInfoWriter) (*ListSiteSnippetsOK, error) { // TODO: Validate the params before sending @@ -4969,7 +5079,7 @@ func (a *Client) ListSiteSnippets(params *ListSiteSnippetsParams, authInfo runti } /* -ListSiteSubmissions list site submissions API +ListSiteSubmissions lists a site s form submissions */ func (a *Client) ListSiteSubmissions(params *ListSiteSubmissionsParams, authInfo runtime.ClientAuthInfoWriter) (*ListSiteSubmissionsOK, error) { // TODO: Validate the params before sending @@ -5003,7 +5113,9 @@ func (a *Client) ListSiteSubmissions(params *ListSiteSubmissionsParams, authInfo } /* -ListSites **Note:** Environment variable keys and values have moved from `build_settings.env` and `repo.env` to a new endpoint. Please use [getEnvVars](#tag/environmentVariables/operation/getEnvVars) to retrieve site environment variables. +ListSites lists sites + +**Note:** Environment variable keys and values have moved from `build_settings.env` and `repo.env` to a new endpoint. Please use [getEnvVars](#tag/environmentVariables/operation/getEnvVars) to retrieve site environment variables. */ func (a *Client) ListSites(params *ListSitesParams, authInfo runtime.ClientAuthInfoWriter) (*ListSitesOK, error) { // TODO: Validate the params before sending @@ -5037,7 +5149,9 @@ func (a *Client) ListSites(params *ListSitesParams, authInfo runtime.ClientAuthI } /* -ListSitesForAccount **Note:** Environment variable keys and values have moved from `build_settings.env` and `repo.env` to a new endpoint. Please use [getEnvVars](#tag/environmentVariables/operation/getEnvVars) to retrieve site environment variables. +ListSitesForAccount lists a team s sites + +**Note:** Environment variable keys and values have moved from `build_settings.env` and `repo.env` to a new endpoint. Please use [getEnvVars](#tag/environmentVariables/operation/getEnvVars) to retrieve site environment variables. */ func (a *Client) ListSitesForAccount(params *ListSitesForAccountParams, authInfo runtime.ClientAuthInfoWriter) (*ListSitesForAccountOK, error) { // TODO: Validate the params before sending @@ -5071,7 +5185,9 @@ func (a *Client) ListSitesForAccount(params *ListSitesForAccountParams, authInfo } /* -LockDeploy lock deploy API +LockDeploy locks a deploy + +Locks a deploy. Subsequent deploys are built but not published. */ func (a *Client) LockDeploy(params *LockDeployParams, authInfo runtime.ClientAuthInfoWriter) (*LockDeployOK, error) { // TODO: Validate the params before sending @@ -5105,7 +5221,7 @@ func (a *Client) LockDeploy(params *LockDeployParams, authInfo runtime.ClientAut } /* -MarkDevServerActivity mark dev server activity API +MarkDevServerActivity records dev server activity */ func (a *Client) MarkDevServerActivity(params *MarkDevServerActivityParams, authInfo runtime.ClientAuthInfoWriter) (*MarkDevServerActivityOK, error) { // TODO: Validate the params before sending @@ -5140,7 +5256,7 @@ func (a *Client) MarkDevServerActivity(params *MarkDevServerActivityParams, auth } /* -NotifyBuildStart notify build start API +NotifyBuildStart marks a build as started */ func (a *Client) NotifyBuildStart(params *NotifyBuildStartParams, authInfo runtime.ClientAuthInfoWriter) (*NotifyBuildStartNoContent, error) { // TODO: Validate the params before sending @@ -5174,7 +5290,9 @@ func (a *Client) NotifyBuildStart(params *NotifyBuildStartParams, authInfo runti } /* - ProvisionSiteTLSCertificate Provisions or updates a TLS certificate for the site. + ProvisionSiteTLSCertificate provisions or update a site s TLS certificate + + Provisions or updates a TLS certificate for the site. **Creating a certificate (site has no certificate):** - Omit certificate params to initiate Let's Encrypt provisioning @@ -5216,7 +5334,9 @@ func (a *Client) ProvisionSiteTLSCertificate(params *ProvisionSiteTLSCertificate } /* -PurgeCache Purges cached content from Netlify's CDN. Supports purging by Cache-Tag. +PurgeCache purges cached content + +Purges cached content from Netlify's CDN. Supports purging by Cache-Tag. */ func (a *Client) PurgeCache(params *PurgeCacheParams, authInfo runtime.ClientAuthInfoWriter) (*PurgeCacheAccepted, error) { // TODO: Validate the params before sending @@ -5251,7 +5371,7 @@ func (a *Client) PurgeCache(params *PurgeCacheParams, authInfo runtime.ClientAut } /* -RemoveAccountMember remove account member API +RemoveAccountMember removes a team member */ func (a *Client) RemoveAccountMember(params *RemoveAccountMemberParams, authInfo runtime.ClientAuthInfoWriter) (*RemoveAccountMemberNoContent, error) { // TODO: Validate the params before sending @@ -5285,7 +5405,9 @@ func (a *Client) RemoveAccountMember(params *RemoveAccountMemberParams, authInfo } /* -ResetSiteDatabaseBranch Resets a non-production database branch by re-forking it from a source branch (defaults to the production branch). If the target branch is already in sync with the source, returns the existing connection string without performing a reset, unless `force=true` is passed. The production branch cannot be reset. +ResetSiteDatabaseBranch resets a database branch + +Resets a non-production database branch by re-forking it from a source branch (defaults to the production branch). If the target branch is already in sync with the source, returns the existing connection string without performing a reset, unless `force=true` is passed. The production branch cannot be reset. */ func (a *Client) ResetSiteDatabaseBranch(params *ResetSiteDatabaseBranchParams, authInfo runtime.ClientAuthInfoWriter) (*ResetSiteDatabaseBranchOK, error) { // TODO: Validate the params before sending @@ -5319,7 +5441,9 @@ func (a *Client) ResetSiteDatabaseBranch(params *ResetSiteDatabaseBranchParams, } /* -RestoreSiteDatabaseSnapshot Restores a snapshot to a database branch. Defaults to the production branch if no branch_name is specified. +RestoreSiteDatabaseSnapshot restores a database snapshot + +Restores a snapshot to a database branch. Defaults to the production branch if no branch_name is specified. */ func (a *Client) RestoreSiteDatabaseSnapshot(params *RestoreSiteDatabaseSnapshotParams, authInfo runtime.ClientAuthInfoWriter) (*RestoreSiteDatabaseSnapshotOK, error) { // TODO: Validate the params before sending @@ -5353,7 +5477,9 @@ func (a *Client) RestoreSiteDatabaseSnapshot(params *RestoreSiteDatabaseSnapshot } /* -RestoreSiteDeploy restore site deploy API +RestoreSiteDeploy restores a previous deploy + +Publishes a previous deploy of the site. */ func (a *Client) RestoreSiteDeploy(params *RestoreSiteDeployParams, authInfo runtime.ClientAuthInfoWriter) (*RestoreSiteDeployCreated, error) { // TODO: Validate the params before sending @@ -5387,7 +5513,9 @@ func (a *Client) RestoreSiteDeploy(params *RestoreSiteDeployParams, authInfo run } /* -RollbackSiteDeploy rollback site deploy API +RollbackSiteDeploy rolls back a site s production deploy + +Rolls back the production deploy to the deploy referenced by its `rollback_id`. Does nothing if the current production deploy has no `rollback_id`. */ func (a *Client) RollbackSiteDeploy(params *RollbackSiteDeployParams, authInfo runtime.ClientAuthInfoWriter) (*RollbackSiteDeployNoContent, error) { // TODO: Validate the params before sending @@ -5421,7 +5549,9 @@ func (a *Client) RollbackSiteDeploy(params *RollbackSiteDeployParams, authInfo r } /* -RunSiteDatabaseMigrations Runs database migrations for the specified deploy. Finds the deploy and determines the appropriate branch. +RunSiteDatabaseMigrations runs database migrations for a deploy + +Runs database migrations for the specified deploy. Finds the deploy and determines the appropriate branch. */ func (a *Client) RunSiteDatabaseMigrations(params *RunSiteDatabaseMigrationsParams, authInfo runtime.ClientAuthInfoWriter) (*RunSiteDatabaseMigrationsOK, error) { // TODO: Validate the params before sending @@ -5455,7 +5585,7 @@ func (a *Client) RunSiteDatabaseMigrations(params *RunSiteDatabaseMigrationsPara } /* -SearchSiteFunctions search site functions API +SearchSiteFunctions searches a site s functions */ func (a *Client) SearchSiteFunctions(params *SearchSiteFunctionsParams, authInfo runtime.ClientAuthInfoWriter) (*SearchSiteFunctionsOK, error) { // TODO: Validate the params before sending @@ -5489,7 +5619,9 @@ func (a *Client) SearchSiteFunctions(params *SearchSiteFunctionsParams, authInfo } /* -SetEnvVarValue Updates or creates a new value for an existing environment variable. +SetEnvVarValue sets a value on an environment variable + +Updates or creates a new value for an existing environment variable. */ func (a *Client) SetEnvVarValue(params *SetEnvVarValueParams, authInfo runtime.ClientAuthInfoWriter) (*SetEnvVarValueCreated, error) { // TODO: Validate the params before sending @@ -5523,7 +5655,9 @@ func (a *Client) SetEnvVarValue(params *SetEnvVarValueParams, authInfo runtime.C } /* -SetSiteDatabaseBranchComputeSettings Sets compute settings for a specific database branch, overriding project-level settings. Requires a Pro or higher plan. +SetSiteDatabaseBranchComputeSettings sets a database branch s compute settings + +Sets compute settings for a specific database branch, overriding project-level settings. Requires a Pro or higher plan. */ func (a *Client) SetSiteDatabaseBranchComputeSettings(params *SetSiteDatabaseBranchComputeSettingsParams, authInfo runtime.ClientAuthInfoWriter) (*SetSiteDatabaseBranchComputeSettingsOK, error) { // TODO: Validate the params before sending @@ -5557,7 +5691,9 @@ func (a *Client) SetSiteDatabaseBranchComputeSettings(params *SetSiteDatabaseBra } /* -SetSiteDatabaseComputeSettings Sets project-level compute settings for the database. Applied to new branches. Can be overridden per-branch. Requires a Pro or higher plan. +SetSiteDatabaseComputeSettings sets database compute settings + +Sets project-level compute settings for the database. Applied to new branches. Can be overridden per-branch. Requires a Pro or higher plan. */ func (a *Client) SetSiteDatabaseComputeSettings(params *SetSiteDatabaseComputeSettingsParams, authInfo runtime.ClientAuthInfoWriter) (*SetSiteDatabaseComputeSettingsOK, error) { // TODO: Validate the params before sending @@ -5591,7 +5727,7 @@ func (a *Client) SetSiteDatabaseComputeSettings(params *SetSiteDatabaseComputeSe } /* -ShowService show service API +ShowService gets an add on service */ func (a *Client) ShowService(params *ShowServiceParams, authInfo runtime.ClientAuthInfoWriter) (*ShowServiceOK, error) { // TODO: Validate the params before sending @@ -5625,7 +5761,7 @@ func (a *Client) ShowService(params *ShowServiceParams, authInfo runtime.ClientA } /* -ShowServiceInstance show service instance API +ShowServiceInstance gets an add on instance */ func (a *Client) ShowServiceInstance(params *ShowServiceInstanceParams, authInfo runtime.ClientAuthInfoWriter) (*ShowServiceInstanceOK, error) { // TODO: Validate the params before sending @@ -5659,7 +5795,7 @@ func (a *Client) ShowServiceInstance(params *ShowServiceInstanceParams, authInfo } /* -ShowServiceManifest show service manifest API +ShowServiceManifest gets an add on service s manifest */ func (a *Client) ShowServiceManifest(params *ShowServiceManifestParams, authInfo runtime.ClientAuthInfoWriter) (*ShowServiceManifestCreated, error) { // TODO: Validate the params before sending @@ -5693,7 +5829,7 @@ func (a *Client) ShowServiceManifest(params *ShowServiceManifestParams, authInfo } /* -ShowSiteTLSCertificate show site TLS certificate API +ShowSiteTLSCertificate gets a site s TLS certificate */ func (a *Client) ShowSiteTLSCertificate(params *ShowSiteTLSCertificateParams, authInfo runtime.ClientAuthInfoWriter) (*ShowSiteTLSCertificateOK, error) { // TODO: Validate the params before sending @@ -5727,7 +5863,7 @@ func (a *Client) ShowSiteTLSCertificate(params *ShowSiteTLSCertificateParams, au } /* -ShowTicket show ticket API +ShowTicket gets an o auth ticket */ func (a *Client) ShowTicket(params *ShowTicketParams, authInfo runtime.ClientAuthInfoWriter) (*ShowTicketOK, error) { // TODO: Validate the params before sending @@ -5761,7 +5897,9 @@ func (a *Client) ShowTicket(params *ShowTicketParams, authInfo runtime.ClientAut } /* -StopAgentRunner Stops the run's active session. Stopping happens in the background. +StopAgentRunner stops an agent run + +Stops the run's active session. Stopping happens in the background. */ func (a *Client) StopAgentRunner(params *StopAgentRunnerParams, authInfo runtime.ClientAuthInfoWriter) (*StopAgentRunnerAccepted, error) { // TODO: Validate the params before sending @@ -5795,7 +5933,9 @@ func (a *Client) StopAgentRunner(params *StopAgentRunnerParams, authInfo runtime } /* -StopAgentRunnerSession Stops the session. Stopping happens in the background. +StopAgentRunnerSession stops an agent run session + +Stops the session. Stopping happens in the background. */ func (a *Client) StopAgentRunnerSession(params *StopAgentRunnerSessionParams, authInfo runtime.ClientAuthInfoWriter) (*StopAgentRunnerSessionAccepted, error) { // TODO: Validate the params before sending @@ -5829,7 +5969,7 @@ func (a *Client) StopAgentRunnerSession(params *StopAgentRunnerSessionParams, au } /* -TransferDNSZone transfer Dns zone API +TransferDNSZone transfers a DNS zone to another team */ func (a *Client) TransferDNSZone(params *TransferDNSZoneParams, authInfo runtime.ClientAuthInfoWriter) (*TransferDNSZoneOK, error) { // TODO: Validate the params before sending @@ -5863,7 +6003,9 @@ func (a *Client) TransferDNSZone(params *TransferDNSZoneParams, authInfo runtime } /* - UnlinkSiteRepo [Beta] Unlinks the repo from the site. + UnlinkSiteRepo unlinks a site s repository + + [Beta] Unlinks the repo from the site. This action will also: - Delete associated deploy keys @@ -5903,7 +6045,7 @@ func (a *Client) UnlinkSiteRepo(params *UnlinkSiteRepoParams, authInfo runtime.C } /* -UnlockDeploy unlock deploy API +UnlockDeploy unlocks a deploy */ func (a *Client) UnlockDeploy(params *UnlockDeployParams, authInfo runtime.ClientAuthInfoWriter) (*UnlockDeployOK, error) { // TODO: Validate the params before sending @@ -5937,7 +6079,7 @@ func (a *Client) UnlockDeploy(params *UnlockDeployParams, authInfo runtime.Clien } /* -UpdateAccount update account API +UpdateAccount updates a team */ func (a *Client) UpdateAccount(params *UpdateAccountParams, authInfo runtime.ClientAuthInfoWriter) (*UpdateAccountOK, error) { // TODO: Validate the params before sending @@ -5971,7 +6113,7 @@ func (a *Client) UpdateAccount(params *UpdateAccountParams, authInfo runtime.Cli } /* -UpdateAccountMember update account member API +UpdateAccountMember updates a team member */ func (a *Client) UpdateAccountMember(params *UpdateAccountMemberParams, authInfo runtime.ClientAuthInfoWriter) (*UpdateAccountMemberOK, error) { // TODO: Validate the params before sending @@ -6005,7 +6147,7 @@ func (a *Client) UpdateAccountMember(params *UpdateAccountMemberParams, authInfo } /* -UpdateAgentRunner update agent runner API +UpdateAgentRunner updates an agent run */ func (a *Client) UpdateAgentRunner(params *UpdateAgentRunnerParams, authInfo runtime.ClientAuthInfoWriter) (*UpdateAgentRunnerOK, error) { // TODO: Validate the params before sending @@ -6039,7 +6181,7 @@ func (a *Client) UpdateAgentRunner(params *UpdateAgentRunnerParams, authInfo run } /* -UpdateAgentRunnerSession update agent runner session API +UpdateAgentRunnerSession updates an agent run session */ func (a *Client) UpdateAgentRunnerSession(params *UpdateAgentRunnerSessionParams, authInfo runtime.ClientAuthInfoWriter) (*UpdateAgentRunnerSessionOK, error) { // TODO: Validate the params before sending @@ -6073,7 +6215,9 @@ func (a *Client) UpdateAgentRunnerSession(params *UpdateAgentRunnerSessionParams } /* -UpdateDeployValidations Updates the deploy validations report for a deploy. +UpdateDeployValidations updates a deploy s validations report + +Updates the deploy validations report for a deploy. */ func (a *Client) UpdateDeployValidations(params *UpdateDeployValidationsParams, authInfo runtime.ClientAuthInfoWriter) (*UpdateDeployValidationsOK, error) { // TODO: Validate the params before sending @@ -6108,7 +6252,7 @@ func (a *Client) UpdateDeployValidations(params *UpdateDeployValidationsParams, } /* -UpdateDevServerState update dev server state API +UpdateDevServerState updates a dev server s state */ func (a *Client) UpdateDevServerState(params *UpdateDevServerStateParams, authInfo runtime.ClientAuthInfoWriter) (*UpdateDevServerStateOK, error) { // TODO: Validate the params before sending @@ -6143,7 +6287,9 @@ func (a *Client) UpdateDevServerState(params *UpdateDevServerStateParams, authIn } /* -UpdateEnvVar Updates an existing environment variable and all of its values. Existing values will be replaced by values provided. +UpdateEnvVar updates an environment variable + +Updates an existing environment variable and all of its values. Existing values will be replaced by values provided. */ func (a *Client) UpdateEnvVar(params *UpdateEnvVarParams, authInfo runtime.ClientAuthInfoWriter) (*UpdateEnvVarOK, error) { // TODO: Validate the params before sending @@ -6177,7 +6323,7 @@ func (a *Client) UpdateEnvVar(params *UpdateEnvVarParams, authInfo runtime.Clien } /* -UpdateHook update hook API +UpdateHook updates an outgoing hook */ func (a *Client) UpdateHook(params *UpdateHookParams, authInfo runtime.ClientAuthInfoWriter) (*UpdateHookOK, error) { // TODO: Validate the params before sending @@ -6211,7 +6357,9 @@ func (a *Client) UpdateHook(params *UpdateHookParams, authInfo runtime.ClientAut } /* -UpdatePlugin This is an internal-only endpoint. +UpdatePlugin updates a site s build plugin + +This is an internal-only endpoint. */ func (a *Client) UpdatePlugin(params *UpdatePluginParams, authInfo runtime.ClientAuthInfoWriter) (*UpdatePluginOK, error) { // TODO: Validate the params before sending @@ -6245,7 +6393,7 @@ func (a *Client) UpdatePlugin(params *UpdatePluginParams, authInfo runtime.Clien } /* -UpdateServiceInstance update service instance API +UpdateServiceInstance updates an add on instance */ func (a *Client) UpdateServiceInstance(params *UpdateServiceInstanceParams, authInfo runtime.ClientAuthInfoWriter) (*UpdateServiceInstanceNoContent, error) { // TODO: Validate the params before sending @@ -6279,7 +6427,9 @@ func (a *Client) UpdateServiceInstance(params *UpdateServiceInstanceParams, auth } /* -UpdateSite **Note:** Environment variable keys and values have moved from `build_settings.env` and `repo.env` to a new endpoint. Please use [updateEnvVar](#tag/environmentVariables/operation/updateEnvVar) to update a site's environment variables. +UpdateSite updates a site + +**Note:** Environment variable keys and values have moved from `build_settings.env` and `repo.env` to a new endpoint. Please use [updateEnvVar](#tag/environmentVariables/operation/updateEnvVar) to update a site's environment variables. */ func (a *Client) UpdateSite(params *UpdateSiteParams, authInfo runtime.ClientAuthInfoWriter) (*UpdateSiteOK, error) { // TODO: Validate the params before sending @@ -6313,7 +6463,7 @@ func (a *Client) UpdateSite(params *UpdateSiteParams, authInfo runtime.ClientAut } /* -UpdateSiteAgentRunnerHook update site agent runner hook API +UpdateSiteAgentRunnerHook updates an agent runner hook */ func (a *Client) UpdateSiteAgentRunnerHook(params *UpdateSiteAgentRunnerHookParams, authInfo runtime.ClientAuthInfoWriter) (*UpdateSiteAgentRunnerHookNoContent, error) { // TODO: Validate the params before sending @@ -6347,7 +6497,9 @@ func (a *Client) UpdateSiteAgentRunnerHook(params *UpdateSiteAgentRunnerHookPara } /* -UpdateSiteAsset update site asset API +UpdateSiteAsset updates a site asset s state + +_This endpoint is only available to certain sites._ */ func (a *Client) UpdateSiteAsset(params *UpdateSiteAssetParams, authInfo runtime.ClientAuthInfoWriter) (*UpdateSiteAssetOK, error) { // TODO: Validate the params before sending @@ -6381,7 +6533,7 @@ func (a *Client) UpdateSiteAsset(params *UpdateSiteAssetParams, authInfo runtime } /* -UpdateSiteBuildHook update site build hook API +UpdateSiteBuildHook updates a build hook */ func (a *Client) UpdateSiteBuildHook(params *UpdateSiteBuildHookParams, authInfo runtime.ClientAuthInfoWriter) (*UpdateSiteBuildHookNoContent, error) { // TODO: Validate the params before sending @@ -6415,7 +6567,7 @@ func (a *Client) UpdateSiteBuildHook(params *UpdateSiteBuildHookParams, authInfo } /* -UpdateSiteBuildLog update site build log API +UpdateSiteBuildLog adds a message to a build log */ func (a *Client) UpdateSiteBuildLog(params *UpdateSiteBuildLogParams, authInfo runtime.ClientAuthInfoWriter) (*UpdateSiteBuildLogNoContent, error) { // TODO: Validate the params before sending @@ -6449,7 +6601,7 @@ func (a *Client) UpdateSiteBuildLog(params *UpdateSiteBuildLogParams, authInfo r } /* -UpdateSiteDeploy update site deploy API +UpdateSiteDeploy updates a deploy */ func (a *Client) UpdateSiteDeploy(params *UpdateSiteDeployParams, authInfo runtime.ClientAuthInfoWriter) (*UpdateSiteDeployOK, error) { // TODO: Validate the params before sending @@ -6483,7 +6635,7 @@ func (a *Client) UpdateSiteDeploy(params *UpdateSiteDeployParams, authInfo runti } /* -UpdateSiteDevServerHook update site dev server hook API +UpdateSiteDevServerHook updates a dev server hook */ func (a *Client) UpdateSiteDevServerHook(params *UpdateSiteDevServerHookParams, authInfo runtime.ClientAuthInfoWriter) (*UpdateSiteDevServerHookNoContent, error) { // TODO: Validate the params before sending @@ -6517,7 +6669,7 @@ func (a *Client) UpdateSiteDevServerHook(params *UpdateSiteDevServerHookParams, } /* -UpdateSiteMetadata update site metadata API +UpdateSiteMetadata updates a site s metadata */ func (a *Client) UpdateSiteMetadata(params *UpdateSiteMetadataParams, authInfo runtime.ClientAuthInfoWriter) (*UpdateSiteMetadataNoContent, error) { // TODO: Validate the params before sending @@ -6551,7 +6703,7 @@ func (a *Client) UpdateSiteMetadata(params *UpdateSiteMetadataParams, authInfo r } /* -UpdateSiteSnippet update site snippet API +UpdateSiteSnippet updates a snippet */ func (a *Client) UpdateSiteSnippet(params *UpdateSiteSnippetParams, authInfo runtime.ClientAuthInfoWriter) (*UpdateSiteSnippetNoContent, error) { // TODO: Validate the params before sending @@ -6585,7 +6737,7 @@ func (a *Client) UpdateSiteSnippet(params *UpdateSiteSnippetParams, authInfo run } /* -UpdateSplitTest update split test API +UpdateSplitTest updates a split test */ func (a *Client) UpdateSplitTest(params *UpdateSplitTestParams, authInfo runtime.ClientAuthInfoWriter) (*UpdateSplitTestCreated, error) { // TODO: Validate the params before sending @@ -6619,7 +6771,7 @@ func (a *Client) UpdateSplitTest(params *UpdateSplitTestParams, authInfo runtime } /* -UploadDeployEdgeFunction upload deploy edge function API +UploadDeployEdgeFunction uploads a deploy s edge functions bundle */ func (a *Client) UploadDeployEdgeFunction(params *UploadDeployEdgeFunctionParams, authInfo runtime.ClientAuthInfoWriter) (*UploadDeployEdgeFunctionOK, error) { // TODO: Validate the params before sending @@ -6653,7 +6805,7 @@ func (a *Client) UploadDeployEdgeFunction(params *UploadDeployEdgeFunctionParams } /* -UploadDeployFile upload deploy file API +UploadDeployFile uploads a deploy file */ func (a *Client) UploadDeployFile(params *UploadDeployFileParams, authInfo runtime.ClientAuthInfoWriter) (*UploadDeployFileOK, error) { // TODO: Validate the params before sending @@ -6687,7 +6839,7 @@ func (a *Client) UploadDeployFile(params *UploadDeployFileParams, authInfo runti } /* -UploadDeployFunction upload deploy function API +UploadDeployFunction uploads a deploy function */ func (a *Client) UploadDeployFunction(params *UploadDeployFunctionParams, authInfo runtime.ClientAuthInfoWriter) (*UploadDeployFunctionOK, error) { // TODO: Validate the params before sending @@ -6721,7 +6873,9 @@ func (a *Client) UploadDeployFunction(params *UploadDeployFunctionParams, authIn } /* - UploadDeployServer Uploads the deploy's Netlify Server bundle, addressed by the digest the deploy + UploadDeployServer uploads a deploy s netlify server bundle + + Uploads the deploy's Netlify Server bundle, addressed by the digest the deploy declared in its `server` property. */ diff --git a/swagger.yml b/swagger.yml index c1ba9bc1..54a9b9a7 100644 --- a/swagger.yml +++ b/swagger.yml @@ -54,6 +54,7 @@ paths: /sites: get: operationId: listSites + summary: List sites tags: [site] parameters: - name: name @@ -79,6 +80,7 @@ paths: Please use [getEnvVars](#tag/environmentVariables/operation/getEnvVars) to retrieve site environment variables. post: operationId: createSite + summary: Create a site tags: [site] consumes: - application/json @@ -109,6 +111,7 @@ paths: required: true get: operationId: getSite + summary: Get a site tags: [site] parameters: - name: feature_flags @@ -127,6 +130,7 @@ paths: Please use [getEnvVars](#tag/environmentVariables/operation/getEnvVars) to retrieve site environment variables. patch: operationId: updateSite + summary: Update a site tags: [site] consumes: - application/json @@ -148,6 +152,7 @@ paths: Please use [updateEnvVar](#tag/environmentVariables/operation/updateEnvVar) to update a site's environment variables. delete: operationId: deleteSite + summary: Delete a site tags: [site] responses: '204': @@ -157,6 +162,7 @@ paths: /sites/{site_id}/ssl: post: operationId: provisionSiteTLSCertificate + summary: Provision or update a site's TLS certificate tags: [sniCertificate] description: >- Provisions or updates a TLS certificate for the site. @@ -203,6 +209,7 @@ paths: $ref: '#/responses/error' get: operationId: showSiteTLSCertificate + summary: Get a site's TLS certificate tags: [sniCertificate] parameters: - name: site_id @@ -219,6 +226,8 @@ paths: /sites/{site_id}/ssl/certificates: get: operationId: getAllCertificates + summary: List TLS certificates for a site's domain + description: Returns details about the certificates associated with a domain. The site must be using the domain. tags: [sniCertificate] parameters: - name: site_id @@ -245,6 +254,7 @@ paths: tags: - environmentVariables operationId: getEnvVars + summary: List environment variables for a team or site parameters: - name: account_id description: Scope response to account_id @@ -294,6 +304,7 @@ paths: tags: - environmentVariables operationId: createEnvVars + summary: Create environment variables description: >- Creates new environment variables. Granular scopes are available on Pro plans and above. @@ -357,6 +368,7 @@ paths: tags: - environmentVariables operationId: getSiteEnvVars + summary: List environment variables for a site parameters: - name: context_name description: Filter by deploy context @@ -400,6 +412,7 @@ paths: tags: - environmentVariables operationId: getEnvVar + summary: Get an environment variable parameters: - name: account_id description: Scope response to account_id @@ -431,6 +444,7 @@ paths: tags: - environmentVariables operationId: updateEnvVar + summary: Update an environment variable description: >- Updates an existing environment variable and all of its values. Existing values will be replaced by values provided. @@ -492,6 +506,7 @@ paths: tags: - environmentVariables operationId: setEnvVarValue + summary: Set a value on an environment variable description: >- Updates or creates a new value for an existing environment variable. parameters: @@ -543,6 +558,7 @@ paths: tags: - environmentVariables operationId: deleteEnvVar + summary: Delete an environment variable parameters: - name: account_id description: Scope response to account_id @@ -571,6 +587,7 @@ paths: tags: - environmentVariables operationId: deleteEnvVarValue + summary: Delete an environment variable value parameters: - name: account_id description: Scope response to account_id @@ -605,6 +622,7 @@ paths: /sites/{site_id}/functions: get: operationId: searchSiteFunctions + summary: Search a site's functions tags: [function] parameters: - name: site_id @@ -628,6 +646,7 @@ paths: /sites/{site_id}/forms: get: operationId: listSiteForms + summary: List a site's forms tags: [form] parameters: - name: site_id @@ -646,6 +665,8 @@ paths: /sites/{site_id}/forms/{form_id}: delete: operationId: deleteSiteForm + summary: Delete a form + description: Deletes a form and all of its submissions. tags: [form] parameters: - name: site_id @@ -664,6 +685,7 @@ paths: /sites/{site_id}/submissions: get: operationId: listSiteSubmissions + summary: List a site's form submissions tags: [submission] parameters: - name: site_id @@ -684,6 +706,7 @@ paths: /sites/{site_id}/files: get: operationId: listSiteFiles + summary: List a site's files tags: [file] parameters: - name: site_id @@ -707,6 +730,8 @@ paths: required: true get: operationId: listSiteAssets + summary: List a site's assets + description: _This endpoint is only available to certain sites._ tags: [asset] responses: '200': @@ -719,6 +744,8 @@ paths: $ref: '#/responses/error' post: operationId: createSiteAsset + summary: Create a site asset + description: _This endpoint is only available to certain sites._ tags: [asset] parameters: - name: name @@ -756,6 +783,8 @@ paths: required: true get: operationId: getSiteAssetInfo + summary: Get a site asset + description: _This endpoint is only available to certain sites._ tags: [asset] responses: '200': @@ -766,6 +795,8 @@ paths: $ref: '#/responses/error' put: operationId: updateSiteAsset + summary: Update a site asset's state + description: _This endpoint is only available to certain sites._ tags: [asset] parameters: - name: state @@ -781,6 +812,8 @@ paths: $ref: '#/responses/error' delete: operationId: deleteSiteAsset + summary: Delete a site asset + description: _This endpoint is only available to certain sites._ tags: [asset] responses: '204': @@ -799,6 +832,8 @@ paths: required: true get: operationId: getSiteAssetPublicSignature + summary: Get a site asset's URL + description: Returns the URL of the asset. If the asset isn't publicly visible, returns a signed URL. _This endpoint is only available to certain sites._ tags: [assetPublicSignature] responses: '200': @@ -810,6 +845,7 @@ paths: /sites/{site_id}/files/{file_path}: get: operationId: getSiteFileByPathName + summary: Get a site file by path tags: [file] parameters: - name: site_id @@ -830,6 +866,7 @@ paths: /purge: post: operationId: purgeCache + summary: Purge cached content description: >- Purges cached content from Netlify's CDN. Supports purging by Cache-Tag. tags: [purge] @@ -859,6 +896,7 @@ paths: required: true get: operationId: listSiteSnippets + summary: List a site's snippets tags: [snippet] responses: '200': @@ -871,6 +909,7 @@ paths: $ref: '#/responses/error' post: operationId: createSiteSnippet + summary: Create a snippet tags: [snippet] consumes: - application/json @@ -899,6 +938,7 @@ paths: required: true get: operationId: getSiteSnippet + summary: Get a snippet tags: [snippet] responses: '200': @@ -909,6 +949,7 @@ paths: $ref: '#/responses/error' put: operationId: updateSiteSnippet + summary: Update a snippet tags: [snippet] consumes: - application/json @@ -925,6 +966,7 @@ paths: $ref: '#/responses/error' delete: operationId: deleteSiteSnippet + summary: Delete a snippet tags: [snippet] responses: '204': @@ -939,6 +981,7 @@ paths: required: true get: operationId: getSiteMetadata + summary: Get a site's metadata tags: [metadata] responses: '200': @@ -949,6 +992,7 @@ paths: $ref: '#/responses/error' put: operationId: updateSiteMetadata + summary: Update a site's metadata tags: [metadata] parameters: - name: metadata @@ -969,6 +1013,7 @@ paths: required: true get: operationId: listSiteBuildHooks + summary: List a site's build hooks tags: [buildHook] responses: '200': @@ -981,6 +1026,7 @@ paths: $ref: '#/responses/error' post: operationId: createSiteBuildHook + summary: Create a build hook tags: [buildHook] consumes: - application/json @@ -1009,6 +1055,7 @@ paths: required: true get: operationId: getSiteBuildHook + summary: Get a build hook tags: [buildHook] responses: '200': @@ -1019,6 +1066,7 @@ paths: $ref: '#/responses/error' put: operationId: updateSiteBuildHook + summary: Update a build hook tags: [buildHook] consumes: - application/json @@ -1035,6 +1083,7 @@ paths: $ref: '#/responses/error' delete: operationId: deleteSiteBuildHook + summary: Delete a build hook tags: [buildHook] responses: '204': @@ -1080,6 +1129,7 @@ paths: in: query get: operationId: listSiteDeploys + summary: List a site's deploys tags: [deploy] parameters: - $ref: '#/parameters/page' @@ -1095,6 +1145,7 @@ paths: $ref: '#/responses/error' post: operationId: createSiteDeploy + summary: Create a deploy tags: [deploy] parameters: - name: title @@ -1115,6 +1166,7 @@ paths: /sites/{site_id}/deploys/{deploy_id}: get: operationId: getSiteDeploy + summary: Get a site's deploy tags: [deploy] parameters: - name: site_id @@ -1134,6 +1186,7 @@ paths: $ref: '#/responses/error' put: operationId: updateSiteDeploy + summary: Update a deploy tags: [deploy] parameters: - name: site_id @@ -1161,6 +1214,8 @@ paths: $ref: '#/responses/error' delete: operationId: deleteSiteDeploy + summary: Delete a site's deploy + description: Marks a deploy for deletion. tags: [deploy] parameters: - name: deploy_id @@ -1179,6 +1234,7 @@ paths: /deploys/{deploy_id}/cancel: post: operationId: cancelSiteDeploy + summary: Cancel a deploy tags: [deploy] parameters: - name: deploy_id @@ -1195,6 +1251,8 @@ paths: /sites/{site_id}/deploys/{deploy_id}/restore: post: operationId: restoreSiteDeploy + summary: Restore a previous deploy + description: Publishes a previous deploy of the site. tags: [deploy] parameters: - name: site_id @@ -1220,6 +1278,7 @@ paths: required: true get: operationId: listSiteBuilds + summary: List a site's builds tags: [build] parameters: - $ref: '#/parameters/page' @@ -1235,6 +1294,7 @@ paths: $ref: '#/responses/error' post: operationId: createSiteBuild + summary: Start a build tags: [build] description: | Runs a build for a site. The build will be scheduled to run at the first opportunity, but it might not start immediately if insufficient account build capacity is available. @@ -1321,6 +1381,7 @@ paths: required: true get: operationId: listSiteDeployedBranches + summary: List a site's deployed branches tags: [deployedBranch] responses: '200': @@ -1339,6 +1400,7 @@ paths: required: true put: operationId: unlinkSiteRepo + summary: Unlink a site's repository tags: [site] description: >- [Beta] Unlinks the repo from the site. @@ -1366,6 +1428,7 @@ paths: required: true put: operationId: enableSite + summary: Enable a site tags: [site] description: >- Re-enables a site that was previously disabled by the user. @@ -1388,6 +1451,7 @@ paths: required: true put: operationId: disableSite + summary: Disable a site tags: [site] description: >- Disables a site, preventing it from serving content. @@ -1411,6 +1475,7 @@ paths: required: true get: operationId: getSiteBuild + summary: Get a build tags: [build] responses: '200': @@ -1432,6 +1497,7 @@ paths: required: true post: operationId: updateSiteBuildLog + summary: Add a message to a build log tags: [buildLogMsg] responses: '204': @@ -1458,6 +1524,7 @@ paths: required: false post: operationId: notifyBuildStart + summary: Mark a build as started tags: [build] responses: '204': @@ -1472,6 +1539,8 @@ paths: required: true get: operationId: getAccountBuildStatus + summary: Get a team's build status + description: Returns the team's counts of active, concurrency-pending, and enqueued builds, and its build minutes usage. tags: [build] responses: '200': @@ -1490,6 +1559,7 @@ paths: required: true get: operationId: getDNSForSite + summary: Get a site's DNS configuration tags: [dnsZone] responses: '200': @@ -1502,6 +1572,8 @@ paths: $ref: '#/responses/error' put: operationId: configureDNSForSite + summary: Configure a site's DNS + description: Creates any missing DNS zones and records for the site's custom domain and domain aliases. This usually runs automatically when the custom domain is set. tags: [dnsZone] responses: '200': @@ -1520,6 +1592,8 @@ paths: required: true put: operationId: rollbackSiteDeploy + summary: Roll back a site's production deploy + description: Rolls back the production deploy to the deploy referenced by its `rollback_id`. Does nothing if the current production deploy has no `rollback_id`. tags: [deploy] responses: '204': @@ -1529,6 +1603,7 @@ paths: /deploys/{deploy_id}: get: operationId: getDeploy + summary: Get a deploy tags: [deploy] parameters: - name: deploy_id @@ -1544,6 +1619,8 @@ paths: $ref: '#/responses/error' delete: operationId: deleteDeploy + summary: Delete a deploy + description: Marks a deploy for deletion. tags: [deploy] parameters: - name: deploy_id @@ -1558,6 +1635,7 @@ paths: /deploys/{deploy_id}/validations_report: patch: operationId: updateDeployValidations + summary: Update a deploy's validations report tags: [deploy] description: Updates the deploy validations report for a deploy. x-internal: true @@ -1586,6 +1664,8 @@ paths: /deploys/{deploy_id}/lock: post: operationId: lockDeploy + summary: Lock a deploy + description: Locks a deploy. Subsequent deploys are built but not published. tags: [deploy] parameters: - name: deploy_id @@ -1602,6 +1682,7 @@ paths: /deploys/{deploy_id}/unlock: post: operationId: unlockDeploy + summary: Unlock a deploy tags: [deploy] parameters: - name: deploy_id @@ -1618,6 +1699,7 @@ paths: /deploys/{deploy_id}/files/{path}: put: operationId: uploadDeployFile + summary: Upload a deploy file tags: [file] consumes: - application/octet-stream @@ -1649,6 +1731,7 @@ paths: /deploys/{deploy_id}/functions/{name}: put: operationId: uploadDeployFunction + summary: Upload a deploy function tags: [function] consumes: - application/octet-stream @@ -1690,6 +1773,7 @@ paths: /deploys/{deploy_id}/server/{code_sha}: put: operationId: uploadDeployServer + summary: Upload a deploy's Netlify Server bundle tags: [deploy] consumes: - application/octet-stream @@ -1723,6 +1807,7 @@ paths: /deploys/{deploy_id}/edge_functions/{code_sha}: put: operationId: uploadDeployEdgeFunction + summary: Upload a deploy's edge functions bundle tags: [edgeFunction] consumes: - application/octet-stream @@ -1751,6 +1836,7 @@ paths: put: x-internal: true operationId: updatePlugin + summary: Update a site's build plugin tags: [x-internal] description: 'This is an internal-only endpoint.' parameters: @@ -1777,6 +1863,7 @@ paths: get: x-internal: true operationId: getLatestPluginRuns + summary: List a site's latest build plugin runs tags: [x-internal] description: 'This is an internal-only endpoint.' parameters: @@ -1806,6 +1893,7 @@ paths: post: x-internal: true operationId: createPluginRun + summary: Create a build plugin run tags: [x-internal] description: 'This is an internal-only endpoint.' parameters: @@ -1827,6 +1915,7 @@ paths: /forms/{form_id}/submissions: get: operationId: listFormSubmissions + summary: List a form's submissions tags: [submission] parameters: - name: form_id @@ -1847,6 +1936,8 @@ paths: /hooks: get: operationId: listHooksBySiteId + summary: List a site's outgoing hooks + description: Returns the outgoing hooks for a site. Pass `form_id` or `event` to filter the results. tags: [hook] parameters: - name: site_id @@ -1864,6 +1955,7 @@ paths: $ref: '#/responses/error' post: operationId: createHookBySiteId + summary: Create an outgoing hook tags: [hook] consumes: - application/json @@ -1892,6 +1984,7 @@ paths: required: true get: operationId: getHook + summary: Get an outgoing hook tags: [hook] responses: '200': @@ -1902,6 +1995,7 @@ paths: $ref: '#/responses/error' put: operationId: updateHook + summary: Update an outgoing hook tags: [hook] parameters: - name: hook @@ -1918,6 +2012,7 @@ paths: $ref: '#/responses/error' delete: operationId: deleteHook + summary: Delete an outgoing hook tags: [hook] responses: '204': @@ -1930,6 +2025,8 @@ paths: required: true post: operationId: enableHook + summary: Re-enable an outgoing hook + description: Re-enables an outgoing hook that was disabled after repeated delivery errors. tags: [hook] responses: '200': @@ -1941,6 +2038,8 @@ paths: /hooks/types: get: operationId: listHookTypes + summary: List outgoing hook types + description: Returns the available outgoing hook types. When `site_id` is given, returns only the types available to that site. tags: [hookType] responses: '200': @@ -1954,6 +2053,7 @@ paths: /oauth/tickets: post: operationId: createTicket + summary: Create an OAuth ticket tags: [ticket] parameters: - name: client_id @@ -1985,6 +2085,7 @@ paths: /oauth/tickets/{ticket_id}: get: operationId: showTicket + summary: Get an OAuth ticket tags: [ticket] parameters: - name: ticket_id @@ -2001,6 +2102,7 @@ paths: /oauth/tickets/{ticket_id}/exchange: post: operationId: exchangeTicket + summary: Exchange an OAuth ticket for an access token tags: [accessToken] parameters: - name: ticket_id @@ -2017,6 +2119,7 @@ paths: /deploy_keys: get: operationId: listDeployKeys + summary: List deploy keys tags: [deployKey] responses: '200': @@ -2029,6 +2132,7 @@ paths: $ref: '#/responses/error' post: operationId: createDeployKey + summary: Create a deploy key tags: [deployKey] consumes: - application/json @@ -2047,6 +2151,7 @@ paths: required: true get: operationId: getDeployKey + summary: Get a deploy key tags: [deployKey] responses: '200': @@ -2057,6 +2162,7 @@ paths: $ref: '#/responses/error' delete: operationId: deleteDeployKey + summary: Delete a deploy key tags: [deployKey] responses: '204': @@ -2066,6 +2172,7 @@ paths: /{account_slug}/sites: post: operationId: createSiteInTeam + summary: Create a site in a team tags: [site] consumes: - application/json @@ -2093,6 +2200,7 @@ paths: Please use [createEnvVars](#tag/environmentVariables/operation/createEnvVars) to create environment variables for a site. get: operationId: listSitesForAccount # an account represents a team or a user + summary: List a team's sites tags: [site] parameters: - name: name @@ -2124,6 +2232,7 @@ paths: required: true get: operationId: listMembersForAccount # an account represents a team or a user + summary: List a team's members tags: [member] responses: '200': @@ -2136,6 +2245,7 @@ paths: $ref: '#/responses/error' post: operationId: addMemberToAccount # an account represents a team or a user + summary: Add a member to a team tags: [member] consumes: - application/json @@ -2166,6 +2276,7 @@ paths: required: true get: operationId: getAccountMember # an account represents a team or a user + summary: Get a team member tags: [member] responses: '200': @@ -2176,6 +2287,7 @@ paths: $ref: '#/responses/error' put: operationId: updateAccountMember # an account represents a team or a user + summary: Update a team member tags: [member] consumes: - application/json @@ -2194,6 +2306,7 @@ paths: $ref: '#/responses/error' delete: operationId: removeAccountMember + summary: Remove a team member tags: [member] responses: '204': @@ -2203,6 +2316,7 @@ paths: /billing/payment_methods: get: operationId: listPaymentMethodsForUser + summary: List payment methods tags: [paymentMethod] responses: '200': @@ -2216,6 +2330,7 @@ paths: /accounts/types: get: operationId: listAccountTypesForUser + summary: List plans available for new teams tags: [accountType] responses: '200': @@ -2229,6 +2344,7 @@ paths: /accounts: get: operationId: listAccountsForUser + summary: List the current user's teams tags: [accountMembership] parameters: - name: minimal @@ -2246,6 +2362,7 @@ paths: $ref: '#/responses/error' post: operationId: createAccount + summary: Create a team tags: [accountMembership] parameters: - name: accountSetup @@ -2268,6 +2385,7 @@ paths: required: true get: operationId: getAccount + summary: Get a team tags: [accountMembership] responses: '200': @@ -2278,6 +2396,7 @@ paths: $ref: '#/responses/error' put: operationId: updateAccount + summary: Update a team tags: [accountMembership] parameters: - name: accountUpdateSetup @@ -2293,6 +2412,7 @@ paths: $ref: '#/responses/error' delete: operationId: cancelAccount + summary: Cancel a team tags: [accountMembership] responses: '204': @@ -2307,6 +2427,7 @@ paths: required: true get: operationId: listAccountAuditEvents + summary: List a team's audit log events tags: [auditLog] parameters: - name: query @@ -2331,6 +2452,7 @@ paths: /agent_runners: get: operationId: listAgentRunners + summary: List a site's agent runs tags: [agentRunner] description: >- Lists a site's agent runs, most recently active first. Archived runs @@ -2382,6 +2504,7 @@ paths: $ref: '#/responses/error' post: operationId: createAgentRunner + summary: Start an agent run tags: [agentRunner] parameters: - name: site_id @@ -2434,6 +2557,7 @@ paths: description: The site's ID or one of its hostnames. post: operationId: createSiteAgentRunner + summary: Start an agent run on a site tags: [agentRunner] description: Starts an agent run on the site. parameters: @@ -2476,6 +2600,8 @@ paths: post: x-internal: true operationId: createAgentRunnerUploadUrl + summary: Create an upload URL for agent run files + description: Returns a presigned URL for uploading a file that agent run sessions can use, and the file's storage key. tags: [agentRunner] parameters: - name: account_id @@ -2493,6 +2619,15 @@ paths: responses: '200': description: OK + schema: + type: object + properties: + upload_url: + type: string + description: Presigned URL to upload the file to with a PUT request. Expires after one hour. + file_key: + type: string + description: Storage key of the uploaded file. '400': description: Bad Request '422': @@ -2507,6 +2642,7 @@ paths: required: true get: operationId: getAgentRunner + summary: Get an agent run tags: [agentRunner] responses: '200': @@ -2517,6 +2653,7 @@ paths: $ref: '#/responses/error' patch: operationId: updateAgentRunner + summary: Update an agent run tags: [agentRunner] responses: '200': @@ -2527,6 +2664,7 @@ paths: $ref: '#/responses/error' delete: operationId: deleteAgentRunner + summary: Stop an agent run (alias) # This tag is in no x-tagGroups entry, which keeps the operation out of the docs but not the clients. tags: [hiddenAgentRunner] description: Same as `POST /agent_runners/{agent_runner_id}/stop`. Doesn't delete the run. @@ -2548,6 +2686,7 @@ paths: required: true post: operationId: stopAgentRunner + summary: Stop an agent run tags: [agentRunner] description: Stops the run's active session. Stopping happens in the background. responses: @@ -2568,6 +2707,7 @@ paths: required: true get: operationId: getAgentRunnerDiff + summary: Get an agent run's diff tags: [agentRunner] description: >- Returns the run's changes as a unified diff. With `page`, returns that @@ -2598,6 +2738,7 @@ paths: required: true post: operationId: archiveAgentRunner + summary: Archive an agent run tags: [agentRunner] responses: '202': @@ -2620,10 +2761,14 @@ paths: post: x-internal: true operationId: agentRunnerPullRequest + summary: Open a pull request from an agent run + description: Opens a pull request from the run's most recent completed session that has a diff. tags: [agentRunner] responses: '200': description: OK + schema: + $ref: '#/definitions/agentRunner' '400': description: Bad Request '409': @@ -2641,6 +2786,7 @@ paths: post: x-internal: true operationId: agentRunnerCommitToBranch + summary: Commit an agent run's changes to a branch tags: [agentRunner] parameters: - name: target_branch @@ -2650,6 +2796,8 @@ paths: responses: '200': description: OK + schema: + $ref: '#/definitions/agentRunner' '400': description: Bad Request '409': @@ -2669,6 +2817,7 @@ paths: required: true get: operationId: listAgentRunnerSessions + summary: List an agent run's sessions tags: [agentRunnerSession] parameters: - $ref: '#/parameters/page' @@ -2700,6 +2849,7 @@ paths: $ref: '#/responses/error' post: operationId: createAgentRunnerSession + summary: Start a follow-up agent run session tags: [agentRunnerSession] description: Starts a follow-up session on the run. parameters: @@ -2770,6 +2920,7 @@ paths: required: true get: operationId: getAgentRunnerSession + summary: Get an agent run session tags: [agentRunnerSession] responses: '200': @@ -2780,6 +2931,7 @@ paths: $ref: '#/responses/error' patch: operationId: updateAgentRunnerSession + summary: Update an agent run session tags: [agentRunnerSession] parameters: - name: is_published @@ -2794,6 +2946,7 @@ paths: $ref: '#/responses/error' delete: operationId: deleteAgentRunnerSession + summary: Stop an agent run session (alias) # This tag is in no x-tagGroups entry, which keeps the operation out of the docs but not the clients. tags: [hiddenAgentRunner] description: Same as `POST /agent_runners/{agent_runner_id}/sessions/{agent_runner_session_id}/stop`. Doesn't delete the session. @@ -2819,6 +2972,7 @@ paths: required: true post: operationId: stopAgentRunnerSession + summary: Stop an agent run session tags: [agentRunnerSession] description: Stops the session. Stopping happens in the background. responses: @@ -2843,6 +2997,7 @@ paths: required: true post: operationId: answerAgentRunnerSession + summary: Answer an agent run session's pending interaction tags: [agentRunnerSession] description: >- Answers or skips a pending interaction and resumes the session. A @@ -2886,6 +3041,7 @@ paths: required: true get: operationId: listFormSubmission + summary: Get a form submission tags: [submission] parameters: - name: query @@ -2904,6 +3060,7 @@ paths: $ref: '#/responses/error' delete: operationId: deleteSubmission + summary: Delete a form submission tags: [submission] responses: '204': @@ -2920,6 +3077,7 @@ paths: required: true get: operationId: listServiceInstancesForSite + summary: List a site's add-on instances tags: [serviceInstance] responses: '200': @@ -2942,6 +3100,7 @@ paths: required: true post: operationId: createServiceInstance + summary: Create an add-on instance tags: [serviceInstance] consumes: - application/json @@ -2974,6 +3133,7 @@ paths: required: true get: operationId: showServiceInstance + summary: Get an add-on instance tags: [serviceInstance] responses: '200': @@ -2984,6 +3144,7 @@ paths: $ref: '#/responses/error' put: operationId: updateServiceInstance + summary: Update an add-on instance tags: [serviceInstance] consumes: - application/json @@ -3000,6 +3161,7 @@ paths: $ref: '#/responses/error' delete: operationId: deleteServiceInstance + summary: Delete an add-on instance tags: [serviceInstance] responses: '204': @@ -3015,6 +3177,7 @@ paths: in: query get: operationId: getServices + summary: List add-on services tags: [service] responses: '200': @@ -3033,6 +3196,7 @@ paths: required: true get: operationId: showService + summary: Get an add-on service tags: [service] responses: '200': @@ -3052,6 +3216,7 @@ paths: required: true get: operationId: showServiceManifest + summary: Get an add-on service's manifest tags: [service] responses: '201': @@ -3065,6 +3230,7 @@ paths: /user: get: operationId: getCurrentUser + summary: Get the current user tags: [user] responses: '200': @@ -3083,6 +3249,7 @@ paths: required: true post: operationId: createSplitTest + summary: Create a split test tags: [splitTest] consumes: - application/json @@ -3101,6 +3268,7 @@ paths: $ref: '#/responses/error' get: operationId: getSplitTests + summary: List a site's split tests tags: [splitTest] responses: '200': @@ -3123,6 +3291,7 @@ paths: required: true put: operationId: updateSplitTest + summary: Update a split test tags: [splitTest] consumes: - application/json @@ -3141,6 +3310,7 @@ paths: $ref: '#/responses/error' get: operationId: getSplitTest + summary: Get a split test tags: [splitTest] responses: '200': @@ -3163,6 +3333,7 @@ paths: required: true post: operationId: enableSplitTest + summary: Publish a split test tags: [splitTest] responses: '204': @@ -3183,6 +3354,7 @@ paths: required: true post: operationId: disableSplitTest + summary: Unpublish a split test tags: [splitTest] responses: '204': @@ -3194,6 +3366,7 @@ paths: /dns_zones: post: operationId: createDnsZone + summary: Create a DNS zone tags: [dnsZone] consumes: - application/json @@ -3212,6 +3385,8 @@ paths: $ref: '#/responses/error' get: operationId: getDnsZones + summary: List DNS zones + description: Returns the DNS zones for the team given by `account_slug`, or all DNS zones the current user can access. tags: [dnsZone] parameters: - name: account_slug @@ -3235,6 +3410,7 @@ paths: required: true get: operationId: getDnsZone + summary: Get a DNS zone tags: [dnsZone] responses: '200': @@ -3245,6 +3421,7 @@ paths: $ref: '#/responses/error' delete: operationId: deleteDnsZone + summary: Delete a DNS zone tags: [dnsZone] responses: '204': @@ -3276,6 +3453,7 @@ paths: required: true put: operationId: transferDnsZone + summary: Transfer a DNS zone to another team tags: [dnsZone] responses: '200': @@ -3294,6 +3472,7 @@ paths: required: true get: operationId: getDnsRecords + summary: List a DNS zone's records tags: [dnsZone] responses: '200': @@ -3304,6 +3483,7 @@ paths: $ref: '#/responses/error' post: operationId: createDnsRecord + summary: Create a DNS record tags: [dnsZone] consumes: - application/json @@ -3334,6 +3514,7 @@ paths: required: true get: operationId: getIndividualDnsRecord + summary: Get a DNS record tags: [dnsZone] responses: '200': @@ -3344,6 +3525,7 @@ paths: $ref: '#/responses/error' delete: operationId: deleteDnsRecord + summary: Delete a DNS record tags: [dnsZone] responses: '204': @@ -3360,6 +3542,7 @@ paths: required: true get: operationId: listSiteDevServers + summary: List a site's dev servers tags: [devServer] parameters: - $ref: '#/parameters/page' @@ -3375,6 +3558,7 @@ paths: $ref: '#/responses/error' post: operationId: createSiteDevServer + summary: Start a dev server tags: [devServer] parameters: - name: branch @@ -3391,6 +3575,8 @@ paths: $ref: '#/responses/error' delete: operationId: deleteSiteDevServers + summary: Stop a branch's dev servers + description: Stops all dev servers for a branch. Stopping happens in the background. tags: [devServer] parameters: - name: branch @@ -3420,6 +3606,7 @@ paths: required: true get: operationId: getSiteDevServer + summary: Get a dev server tags: [devServer] responses: '200': @@ -3441,10 +3628,13 @@ paths: post: x-internal: true operationId: markDevServerActivity + summary: Record dev server activity tags: [devServer] responses: '200': description: OK + schema: + $ref: '#/definitions/devServer' # end sites/{site_id}/dev_servers/{dev_server_id}/activity # begin sites/{site_id}/dev_servers/{dev_server_id}/state /sites/{site_id}/dev_servers/{dev_server_id}/state: @@ -3459,6 +3649,7 @@ paths: required: true post: operationId: updateDevServerState + summary: Update a dev server's state tags: [devServer] parameters: - name: body @@ -3496,6 +3687,7 @@ paths: required: true get: operationId: listSiteDevServerHooks + summary: List a site's dev server hooks tags: [devServerHook] responses: '200': @@ -3508,6 +3700,7 @@ paths: $ref: '#/responses/error' post: operationId: createSiteDevServerHook + summary: Create a dev server hook tags: [devServerHook] consumes: - application/json @@ -3536,6 +3729,7 @@ paths: required: true get: operationId: getSiteDevServerHook + summary: Get a dev server hook tags: [devServerHook] responses: '200': @@ -3546,6 +3740,7 @@ paths: $ref: '#/responses/error' put: operationId: updateSiteDevServerHook + summary: Update a dev server hook tags: [devServerHook] consumes: - application/json @@ -3562,6 +3757,7 @@ paths: $ref: '#/responses/error' delete: operationId: deleteSiteDevServerHook + summary: Delete a dev server hook tags: [devServerHook] responses: '204': @@ -3578,6 +3774,7 @@ paths: get: x-internal: true operationId: listSiteAgentRunnerHooks + summary: List a site's agent runner hooks tags: [agentRunnerHook] responses: '200': @@ -3591,6 +3788,7 @@ paths: post: x-internal: true operationId: createSiteAgentRunnerHook + summary: Create an agent runner hook tags: [agentRunnerHook] consumes: - application/json @@ -3620,6 +3818,7 @@ paths: get: x-internal: true operationId: getSiteAgentRunnerHook + summary: Get an agent runner hook tags: [agentRunnerHook] responses: '200': @@ -3631,6 +3830,7 @@ paths: put: x-internal: true operationId: updateSiteAgentRunnerHook + summary: Update an agent runner hook tags: [agentRunnerHook] consumes: - application/json @@ -3648,6 +3848,7 @@ paths: delete: x-internal: true operationId: deleteSiteAgentRunnerHook + summary: Delete an agent runner hook tags: [agentRunnerHook] responses: '204': @@ -3658,6 +3859,7 @@ paths: /ai-gateway/providers: get: operationId: getAIGatewayProviders + summary: List AI Gateway providers and models tags: [aiGateway] security: [] responses: @@ -3681,6 +3883,7 @@ paths: description: The site ID get: operationId: getAIGatewayToken + summary: Get a site's AI Gateway token tags: [aiGateway] responses: '200': @@ -3701,6 +3904,7 @@ paths: description: The account ID get: operationId: getAccountAIGatewayToken + summary: Get a team's AI Gateway token tags: [aiGateway] responses: '200': @@ -3722,6 +3926,7 @@ paths: required: true post: operationId: createSiteDatabase + summary: Create a site database tags: [database] description: >- Creates a new database for the specified site. If a database already exists, @@ -3747,6 +3952,7 @@ paths: $ref: '#/responses/error' get: operationId: getSiteDatabase + summary: Get a site database tags: [database] description: Returns the database connection string for the specified site. parameters: @@ -3768,6 +3974,7 @@ paths: $ref: '#/responses/error' delete: operationId: deleteSiteDatabase + summary: Delete a site database tags: [database] description: Deletes the database and all associated branches and snapshots for the specified site. responses: @@ -3783,6 +3990,7 @@ paths: required: true post: operationId: createSiteDatabaseBranch + summary: Create a database branch tags: [database] description: >- Creates a new database branch. If a branch already exists @@ -3814,6 +4022,7 @@ paths: required: true get: operationId: listSiteDatabaseBranches + summary: List database branches tags: [database] description: Returns all branches for the site's database with compute status and metadata. responses: @@ -3836,6 +4045,7 @@ paths: description: The branch ID get: operationId: getSiteDatabaseBranch + summary: Get a database branch tags: [database] description: Returns the database branch connection string for a specific branch. parameters: @@ -3859,6 +4069,7 @@ paths: $ref: '#/responses/error' delete: operationId: deleteSiteDatabaseBranch + summary: Delete a database branch tags: [database] description: Deletes a database branch. responses: @@ -3879,6 +4090,7 @@ paths: description: The branch ID to reset post: operationId: resetSiteDatabaseBranch + summary: Reset a database branch tags: [database] description: >- Resets a non-production database branch by re-forking it from a source branch @@ -3932,6 +4144,7 @@ paths: description: The branch ID put: operationId: setSiteDatabaseBranchComputeSettings + summary: Set a database branch's compute settings tags: [database] description: >- Sets compute settings for a specific database branch, overriding project-level settings. @@ -3961,6 +4174,7 @@ paths: required: true put: operationId: setSiteDatabaseComputeSettings + summary: Set database compute settings tags: [database] description: >- Sets project-level compute settings for the database. @@ -3985,6 +4199,7 @@ paths: $ref: '#/responses/error' get: operationId: getSiteDatabaseComputeSettings + summary: Get database compute settings tags: [database] description: >- Returns the project-level compute settings for the database. @@ -4001,6 +4216,7 @@ paths: $ref: '#/responses/error' delete: operationId: clearSiteDatabaseComputeSettings + summary: Reset database compute settings to defaults tags: [database] description: >- Resets project-level compute settings to tier defaults. @@ -4020,6 +4236,7 @@ paths: required: true get: operationId: listSiteDatabaseMigrations + summary: List database migrations tags: [database] description: >- Returns the list of migrations available for the specified branch, @@ -4055,6 +4272,7 @@ paths: description: The migration name get: operationId: getSiteDatabaseMigration + summary: Get a database migration tags: [database] description: >- Returns the contents of a named migration for the specified branch. @@ -4089,6 +4307,7 @@ paths: description: The deploy ID to run migrations for post: operationId: runSiteDatabaseMigrations + summary: Run database migrations for a deploy tags: [database] description: >- Runs database migrations for the specified deploy. @@ -4117,6 +4336,7 @@ paths: required: true post: operationId: createSiteDatabaseSnapshot + summary: Create a database snapshot tags: [database] description: >- Creates a point-in-time snapshot of a database branch. @@ -4143,6 +4363,7 @@ paths: required: true get: operationId: listSiteDatabaseSnapshots + summary: List database snapshots tags: [database] description: Returns all snapshots for the site's database. responses: @@ -4165,6 +4386,7 @@ paths: description: The snapshot ID delete: operationId: deleteSiteDatabaseSnapshot + summary: Delete a database snapshot tags: [database] description: Deletes a database snapshot. responses: @@ -4185,6 +4407,7 @@ paths: description: The snapshot ID to restore post: operationId: restoreSiteDatabaseSnapshot + summary: Restore a database snapshot tags: [database] description: >- Restores a snapshot to a database branch. From 6a7c64f751cd076cf4bd7b553a644ded444111df Mon Sep 17 00:00:00 2001 From: Sean Roberts Date: Thu, 22 Oct 2026 16:47:52 -0700 Subject: [PATCH 2/4] fix: declare hook filters and require upload URL response fields - listHooksBySiteId: declare the optional form_id and event filters the API already reads (Api::V1::HooksController#index). - listHookTypes: declare the optional site_id it already accepts. - createAgentRunnerUploadUrl: mark upload_url and file_key required; the controller always returns both. Co-Authored-By: Claude Opus 5.5 (1M context) --- ...create_agent_runner_upload_url_o_k_body.go | 39 ++++++++++- .../operations/list_hook_types_parameters.go | 42 ++++++++++-- .../list_hooks_by_site_id_parameters.go | 64 +++++++++++++++++++ swagger.yml | 14 ++++ 4 files changed, 153 insertions(+), 6 deletions(-) diff --git a/go/models/create_agent_runner_upload_url_o_k_body.go b/go/models/create_agent_runner_upload_url_o_k_body.go index 410d3ed8..ad3cdb38 100644 --- a/go/models/create_agent_runner_upload_url_o_k_body.go +++ b/go/models/create_agent_runner_upload_url_o_k_body.go @@ -6,8 +6,10 @@ package models // Editing this file might prove futile when you re-run the swagger generate command import ( + "github.com/go-openapi/errors" "github.com/go-openapi/strfmt" "github.com/go-openapi/swag" + "github.com/go-openapi/validate" ) // CreateAgentRunnerUploadURLOKBody create agent runner upload Url o k body @@ -16,14 +18,47 @@ import ( type CreateAgentRunnerUploadURLOKBody struct { // Storage key of the uploaded file. - FileKey string `json:"file_key,omitempty"` + // Required: true + FileKey *string `json:"file_key"` // Presigned URL to upload the file to with a PUT request. Expires after one hour. - UploadURL string `json:"upload_url,omitempty"` + // Required: true + UploadURL *string `json:"upload_url"` } // Validate validates this create agent runner upload Url o k body func (m *CreateAgentRunnerUploadURLOKBody) Validate(formats strfmt.Registry) error { + var res []error + + if err := m.validateFileKey(formats); err != nil { + res = append(res, err) + } + + if err := m.validateUploadURL(formats); err != nil { + res = append(res, err) + } + + if len(res) > 0 { + return errors.CompositeValidationError(res...) + } + return nil +} + +func (m *CreateAgentRunnerUploadURLOKBody) validateFileKey(formats strfmt.Registry) error { + + if err := validate.Required("file_key", "body", m.FileKey); err != nil { + return err + } + + return nil +} + +func (m *CreateAgentRunnerUploadURLOKBody) validateUploadURL(formats strfmt.Registry) error { + + if err := validate.Required("upload_url", "body", m.UploadURL); err != nil { + return err + } + return nil } diff --git a/go/plumbing/operations/list_hook_types_parameters.go b/go/plumbing/operations/list_hook_types_parameters.go index d15c172d..71056b1d 100644 --- a/go/plumbing/operations/list_hook_types_parameters.go +++ b/go/plumbing/operations/list_hook_types_parameters.go @@ -19,7 +19,7 @@ import ( // NewListHookTypesParams creates a new ListHookTypesParams object // with the default values initialized. func NewListHookTypesParams() *ListHookTypesParams { - + var () return &ListHookTypesParams{ timeout: cr.DefaultTimeout, @@ -29,7 +29,7 @@ func NewListHookTypesParams() *ListHookTypesParams { // NewListHookTypesParamsWithTimeout creates a new ListHookTypesParams object // with the default values initialized, and the ability to set a timeout on a request func NewListHookTypesParamsWithTimeout(timeout time.Duration) *ListHookTypesParams { - + var () return &ListHookTypesParams{ timeout: timeout, @@ -39,7 +39,7 @@ func NewListHookTypesParamsWithTimeout(timeout time.Duration) *ListHookTypesPara // NewListHookTypesParamsWithContext creates a new ListHookTypesParams object // with the default values initialized, and the ability to set a context for a request func NewListHookTypesParamsWithContext(ctx context.Context) *ListHookTypesParams { - + var () return &ListHookTypesParams{ Context: ctx, @@ -49,7 +49,7 @@ func NewListHookTypesParamsWithContext(ctx context.Context) *ListHookTypesParams // NewListHookTypesParamsWithHTTPClient creates a new ListHookTypesParams object // with the default values initialized, and the ability to set a custom HTTPClient for a request func NewListHookTypesParamsWithHTTPClient(client *http.Client) *ListHookTypesParams { - + var () return &ListHookTypesParams{ HTTPClient: client, } @@ -60,6 +60,13 @@ ListHookTypesParams contains all the parameters to send to the API endpoint for the list hook types operation typically these are written to a http.Request */ type ListHookTypesParams struct { + + /*SiteID + Only return the hook types available to this site. + + */ + SiteID *string + timeout time.Duration Context context.Context HTTPClient *http.Client @@ -98,6 +105,17 @@ func (o *ListHookTypesParams) SetHTTPClient(client *http.Client) { o.HTTPClient = client } +// WithSiteID adds the siteID to the list hook types params +func (o *ListHookTypesParams) WithSiteID(siteID *string) *ListHookTypesParams { + o.SetSiteID(siteID) + return o +} + +// SetSiteID adds the siteId to the list hook types params +func (o *ListHookTypesParams) SetSiteID(siteID *string) { + o.SiteID = siteID +} + // WriteToRequest writes these params to a swagger request func (o *ListHookTypesParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error { @@ -106,6 +124,22 @@ func (o *ListHookTypesParams) WriteToRequest(r runtime.ClientRequest, reg strfmt } var res []error + if o.SiteID != nil { + + // query param site_id + var qrSiteID string + if o.SiteID != nil { + qrSiteID = *o.SiteID + } + qSiteID := qrSiteID + if qSiteID != "" { + if err := r.SetQueryParam("site_id", qSiteID); err != nil { + return err + } + } + + } + if len(res) > 0 { return errors.CompositeValidationError(res...) } diff --git a/go/plumbing/operations/list_hooks_by_site_id_parameters.go b/go/plumbing/operations/list_hooks_by_site_id_parameters.go index 16cb069e..8687957f 100644 --- a/go/plumbing/operations/list_hooks_by_site_id_parameters.go +++ b/go/plumbing/operations/list_hooks_by_site_id_parameters.go @@ -61,6 +61,16 @@ for the list hooks by site Id operation typically these are written to a http.Re */ type ListHooksBySiteIDParams struct { + /*Event + Only return hooks for this event name. + + */ + Event *string + /*FormID + Only return hooks attached to this form. + + */ + FormID *string /*SiteID*/ SiteID string @@ -102,6 +112,28 @@ func (o *ListHooksBySiteIDParams) SetHTTPClient(client *http.Client) { o.HTTPClient = client } +// WithEvent adds the event to the list hooks by site Id params +func (o *ListHooksBySiteIDParams) WithEvent(event *string) *ListHooksBySiteIDParams { + o.SetEvent(event) + return o +} + +// SetEvent adds the event to the list hooks by site Id params +func (o *ListHooksBySiteIDParams) SetEvent(event *string) { + o.Event = event +} + +// WithFormID adds the formID to the list hooks by site Id params +func (o *ListHooksBySiteIDParams) WithFormID(formID *string) *ListHooksBySiteIDParams { + o.SetFormID(formID) + return o +} + +// SetFormID adds the formId to the list hooks by site Id params +func (o *ListHooksBySiteIDParams) SetFormID(formID *string) { + o.FormID = formID +} + // WithSiteID adds the siteID to the list hooks by site Id params func (o *ListHooksBySiteIDParams) WithSiteID(siteID string) *ListHooksBySiteIDParams { o.SetSiteID(siteID) @@ -121,6 +153,38 @@ func (o *ListHooksBySiteIDParams) WriteToRequest(r runtime.ClientRequest, reg st } var res []error + if o.Event != nil { + + // query param event + var qrEvent string + if o.Event != nil { + qrEvent = *o.Event + } + qEvent := qrEvent + if qEvent != "" { + if err := r.SetQueryParam("event", qEvent); err != nil { + return err + } + } + + } + + if o.FormID != nil { + + // query param form_id + var qrFormID string + if o.FormID != nil { + qrFormID = *o.FormID + } + qFormID := qrFormID + if qFormID != "" { + if err := r.SetQueryParam("form_id", qFormID); err != nil { + return err + } + } + + } + // query param site_id qrSiteID := o.SiteID qSiteID := qrSiteID diff --git a/swagger.yml b/swagger.yml index 54a9b9a7..26f66d68 100644 --- a/swagger.yml +++ b/swagger.yml @@ -1944,6 +1944,14 @@ paths: in: query type: string required: true + - name: form_id + in: query + type: string + description: Only return hooks attached to this form. + - name: event + in: query + type: string + description: Only return hooks for this event name. responses: '200': description: OK @@ -2041,6 +2049,11 @@ paths: summary: List outgoing hook types description: Returns the available outgoing hook types. When `site_id` is given, returns only the types available to that site. tags: [hookType] + parameters: + - name: site_id + in: query + type: string + description: Only return the hook types available to this site. responses: '200': description: OK @@ -2621,6 +2634,7 @@ paths: description: OK schema: type: object + required: [upload_url, file_key] properties: upload_url: type: string From 28019cf2a490ff96948da51fe2e7988189176126 Mon Sep 17 00:00:00 2001 From: Sean Roberts Date: Fri, 23 Oct 2026 11:19:31 -0400 Subject: [PATCH 3/4] fix: correct agent run and lock descriptions; keep operationIds visible in docs - agentRunnerPullRequest: the PR is built from the run's own result_diff and queued (GithubCreatePullRequestWorker), so pr_url is usually unset in the response; describe polling getAgentRunner for pr_url / pr_error. - agentRunnerCommitToBranch: also queued; describe polling for merge_commit_sha / merge_commit_error. - lockDeploy: locking an unpublished deploy publishes it first, and a gated publish responds 202 with the deploy. - Docs: Redoc headings now use summaries, which hid operationIds that `netlify api --help` points people to. A docs-only Redocly decorator (docs@latest) prefixes each heading with its operationId. swagger.json, openapi.json and index.d.ts keep plain summaries. Co-Authored-By: Claude Opus 5.5 (1M context) --- go/plumbing/operations/operations_client.go | 6 ++++-- redocly.yml | 7 +++++++ src/docs/build.js | 14 ++++++++++--- src/docs/redocly-plugin.js | 22 +++++++++++++++++++++ swagger.yml | 15 ++++++++++++-- 5 files changed, 57 insertions(+), 7 deletions(-) create mode 100644 src/docs/redocly-plugin.js diff --git a/go/plumbing/operations/operations_client.go b/go/plumbing/operations/operations_client.go index aaadb5b2..f3cade14 100644 --- a/go/plumbing/operations/operations_client.go +++ b/go/plumbing/operations/operations_client.go @@ -438,6 +438,8 @@ func (a *Client) AddMemberToAccount(params *AddMemberToAccountParams, authInfo r /* AgentRunnerCommitToBranch commits an agent run s changes to a branch + +Queues a commit of the run's diff to `target_branch`. The commit is made in the background: `merge_commit_is_being_created` is `true` until it finishes. Poll `getAgentRunner` until `merge_commit_sha` or `merge_commit_error` is set. */ func (a *Client) AgentRunnerCommitToBranch(params *AgentRunnerCommitToBranchParams, authInfo runtime.ClientAuthInfoWriter) (*AgentRunnerCommitToBranchOK, error) { // TODO: Validate the params before sending @@ -473,7 +475,7 @@ func (a *Client) AgentRunnerCommitToBranch(params *AgentRunnerCommitToBranchPara /* AgentRunnerPullRequest opens a pull request from an agent run -Opens a pull request from the run's most recent completed session that has a diff. +Queues a pull request for the run's diff (`result_diff`). The pull request is created in the background, so `pr_url` is usually not set yet in the response: `pr_is_being_created` is `true` until it finishes. Poll `getAgentRunner` until `pr_url` or `pr_error` is set. Returns 409 if a pull request already exists or is being created, and 422 if the run has no diff, no branch, no GitHub repository or installation, or needs a git sync. */ func (a *Client) AgentRunnerPullRequest(params *AgentRunnerPullRequestParams, authInfo runtime.ClientAuthInfoWriter) (*AgentRunnerPullRequestOK, error) { // TODO: Validate the params before sending @@ -5187,7 +5189,7 @@ func (a *Client) ListSitesForAccount(params *ListSitesForAccountParams, authInfo /* LockDeploy locks a deploy -Locks a deploy. Subsequent deploys are built but not published. +Locks a deploy so that subsequent deploys are built but not published. If the deploy is not the site's published deploy, locking publishes it first. When publishing is gated, the publish and lock are queued and the API responds with 202 Accepted and the deploy; poll `getDeploy` to follow it. */ func (a *Client) LockDeploy(params *LockDeployParams, authInfo runtime.ClientAuthInfoWriter) (*LockDeployOK, error) { // TODO: Validate the params before sending diff --git a/redocly.yml b/redocly.yml index 62e611af..5c87eb16 100644 --- a/redocly.yml +++ b/redocly.yml @@ -1,3 +1,5 @@ +plugins: + - ./src/docs/redocly-plugin.js apis: external@latest: root: ./swagger.yml @@ -5,3 +7,8 @@ apis: remove-x-internal: on x-openapi-ts: output: ./index.d.ts + docs@latest: + root: ./swagger.yml + decorators: + remove-x-internal: on + netlify-docs/operation-id-in-summary: on diff --git a/src/docs/build.js b/src/docs/build.js index 75dd4f67..e55fc3c0 100644 --- a/src/docs/build.js +++ b/src/docs/build.js @@ -1,12 +1,15 @@ -const { normalize } = require('path') +const { tmpdir } = require('os') +const { join, normalize } = require('path') const execa = require('execa') const { copyAssets } = require('./assets') const { injectContent } = require('./inject') -const SWAGGER_PATH = `${__dirname}/../../external.yml` const OUTPUT_DIR = `${__dirname}/../../dist` +// Docs-only bundle of docs@latest (redocly.yml). build-docs doesn't run +// decorators itself, so bundle first, like `npm run bundle` does for external.yml. +const DOCS_BUNDLE_PATH = join(tmpdir(), 'netlify-open-api-docs.yml') const OUTPUT_PATH = `${OUTPUT_DIR}/index.html` // Build API documentation single self-contained HTML file using `redoc-cli` @@ -15,6 +18,11 @@ const buildDocs = async function () { } const redocCli = async function () { + await execa( + 'redocly', + ['bundle', 'docs@latest', `--output=${DOCS_BUNDLE_PATH}`], + { stdio: 'inherit' } + ) await execa( 'redocly', [ @@ -27,7 +35,7 @@ const redocCli = async function () { `--theme.openapi.logo.gutter=${LOGO_PADDING}`, `--output=${normalize(OUTPUT_PATH)}`, 'build-docs', - SWAGGER_PATH, + DOCS_BUNDLE_PATH, ], { stdio: 'inherit' } ) diff --git a/src/docs/redocly-plugin.js b/src/docs/redocly-plugin.js new file mode 100644 index 00000000..88bc0679 --- /dev/null +++ b/src/docs/redocly-plugin.js @@ -0,0 +1,22 @@ +// Docs-only Redocly decorator (wired up in redocly.yml for `docs@latest`). +// Redoc uses an operation's `summary` as its heading and sidebar label, which +// hides the operationId. `netlify api --help` sends people to this page to +// find method names, so prefix each summary with its operationId in the docs. +// The published swagger.json and openapi.json keep the plain summary. +const operationIdInSummary = () => ({ + Operation: { + leave(operation) { + if (operation.operationId && operation.summary) { + operation.summary = `${operation.operationId}: ${operation.summary}` + } + }, + }, +}) + +module.exports = { + id: 'netlify-docs', + decorators: { + oas2: { 'operation-id-in-summary': operationIdInSummary }, + oas3: { 'operation-id-in-summary': operationIdInSummary }, + }, +} diff --git a/swagger.yml b/swagger.yml index 26f66d68..3166be29 100644 --- a/swagger.yml +++ b/swagger.yml @@ -1665,7 +1665,10 @@ paths: post: operationId: lockDeploy summary: Lock a deploy - description: Locks a deploy. Subsequent deploys are built but not published. + description: >- + Locks a deploy so that subsequent deploys are built but not published. If the deploy is not the site's + published deploy, locking publishes it first. When publishing is gated, the publish and lock are queued and the + API responds with 202 Accepted and the deploy; poll `getDeploy` to follow it. tags: [deploy] parameters: - name: deploy_id @@ -2776,7 +2779,11 @@ paths: x-internal: true operationId: agentRunnerPullRequest summary: Open a pull request from an agent run - description: Opens a pull request from the run's most recent completed session that has a diff. + description: >- + Queues a pull request for the run's diff (`result_diff`). The pull request is created in the background, so + `pr_url` is usually not set yet in the response: `pr_is_being_created` is `true` until it finishes. Poll + `getAgentRunner` until `pr_url` or `pr_error` is set. Returns 409 if a pull request already exists or is being + created, and 422 if the run has no diff, no branch, no GitHub repository or installation, or needs a git sync. tags: [agentRunner] responses: '200': @@ -2801,6 +2808,10 @@ paths: x-internal: true operationId: agentRunnerCommitToBranch summary: Commit an agent run's changes to a branch + description: >- + Queues a commit of the run's diff to `target_branch`. The commit is made in the background: + `merge_commit_is_being_created` is `true` until it finishes. Poll `getAgentRunner` until `merge_commit_sha` or + `merge_commit_error` is set. tags: [agentRunner] parameters: - name: target_branch From 398ce690262bfe8f8203810e3db72e6a28a0941c Mon Sep 17 00:00:00 2001 From: Sean Roberts Date: Fri, 23 Oct 2026 12:58:54 -0400 Subject: [PATCH 4/4] fix: bundle docs to a per-build temp directory Each docs build now bundles docs@latest into its own mkdtemp directory and removes it afterwards, so concurrent builds can't render each other's spec. Co-Authored-By: Claude Opus 5.5 (1M context) --- src/docs/build.js | 54 ++++++++++++++++++++++++++--------------------- 1 file changed, 30 insertions(+), 24 deletions(-) diff --git a/src/docs/build.js b/src/docs/build.js index e55fc3c0..ec6ed7c8 100644 --- a/src/docs/build.js +++ b/src/docs/build.js @@ -1,3 +1,4 @@ +const { mkdtemp, rm } = require('fs/promises') const { tmpdir } = require('os') const { join, normalize } = require('path') @@ -7,9 +8,6 @@ const { copyAssets } = require('./assets') const { injectContent } = require('./inject') const OUTPUT_DIR = `${__dirname}/../../dist` -// Docs-only bundle of docs@latest (redocly.yml). build-docs doesn't run -// decorators itself, so bundle first, like `npm run bundle` does for external.yml. -const DOCS_BUNDLE_PATH = join(tmpdir(), 'netlify-open-api-docs.yml') const OUTPUT_PATH = `${OUTPUT_DIR}/index.html` // Build API documentation single self-contained HTML file using `redoc-cli` @@ -17,28 +15,36 @@ const buildDocs = async function () { await Promise.all([redocCli(), copyAssets(OUTPUT_DIR)]) } +// build-docs doesn't run decorators, so bundle docs@latest (redocly.yml) to a +// per-build temp file first, like `npm run bundle` does for external.yml. const redocCli = async function () { - await execa( - 'redocly', - ['bundle', 'docs@latest', `--output=${DOCS_BUNDLE_PATH}`], - { stdio: 'inherit' } - ) - await execa( - 'redocly', - [ - `--title=${TITLE}`, - '--theme.openapi.requiredPropsFirst', - '--theme.openapi.sortOperationsAlphabetically', - `--theme.openapi.colors.primary.main=${HEADINGS_TEXT_COLOR}`, - `--theme.openapi.sidebar.backgroundColor=${MENU_BACKGROUND_COLOR}`, - `--theme.openapi.typography.headings.fontFamily=${FONT}`, - `--theme.openapi.logo.gutter=${LOGO_PADDING}`, - `--output=${normalize(OUTPUT_PATH)}`, - 'build-docs', - DOCS_BUNDLE_PATH, - ], - { stdio: 'inherit' } - ) + const bundleDir = await mkdtemp(join(tmpdir(), 'netlify-open-api-docs-')) + const bundlePath = join(bundleDir, 'docs.yml') + try { + await execa( + 'redocly', + ['bundle', 'docs@latest', `--output=${bundlePath}`], + { stdio: 'inherit' } + ) + await execa( + 'redocly', + [ + `--title=${TITLE}`, + '--theme.openapi.requiredPropsFirst', + '--theme.openapi.sortOperationsAlphabetically', + `--theme.openapi.colors.primary.main=${HEADINGS_TEXT_COLOR}`, + `--theme.openapi.sidebar.backgroundColor=${MENU_BACKGROUND_COLOR}`, + `--theme.openapi.typography.headings.fontFamily=${FONT}`, + `--theme.openapi.logo.gutter=${LOGO_PADDING}`, + `--output=${normalize(OUTPUT_PATH)}`, + 'build-docs', + bundlePath, + ], + { stdio: 'inherit' } + ) + } finally { + await rm(bundleDir, { recursive: true, force: true }) + } await injectContent(OUTPUT_PATH) }