Create a change proposal | Grist Octri Preview

1 parameter · 1 body field

docIdstringrequired

A string id (UUID)

retractedbooleanoptional

Set to true to retract an existing proposal

Default:false

2 status codes

200Proposal created

comparisonobjectoptional

Comparison result between two document versions

idintegeroptional

Proposal ID

400Can only propose from a fork

Error handling

A 400 is returned: Can only propose from a fork.

import (
	"context"
	"fmt"
	"log"
	"os"

	gristoctripreview "github.com/grist_octri_preview_sdk/sdk"
)

ctx := context.Background()
client := gristoctripreview.NewGristFullAPIOctriPreview(gristoctripreview.ClientConfig{
	BaseURL: "https://docs.getgrist.com/api",
	Auth: &gristoctripreview.ClientAuthConfig{ApiKey: os.Getenv("API_TOKEN")},
})

result, err := client.Docs.CreateProposal(
	ctx,
	gristoctripreview.CreateProposalParams{DocId: "3fa85f64-5717-4562-b3fc-2c963f66afa6"},
)
if err != nil {
	log.Fatal(err)
}
fmt.Println(result)

{
  "comparison": {
    "left": {
      "h": "example_value",
      "n": 1
    },
    "parent": {
      "h": "example_value",
      "n": 1
    },
    "right": {
      "h": "example_value",
      "n": 1
    },
    "summary": "same"
  },
  "id": "550e8400-e29b-41d4-a716-446655440000"
}

Request

Response

Errors