Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adds API docs for "POST /docs" #488

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

Adds API docs for "POST /docs" #488

wants to merge 1 commit into from

Conversation

Spoffy
Copy link
Contributor

@Spoffy Spoffy commented Mar 17, 2025

Adds API documentation for POSTing to the "/docs" endpoint.

The /docs endpoint has four behaviours:

  1. Copy an existing document
  2. Upload a new document from a file
  3. Create a new document in a specific workspace
  4. Create a new unsaved document

Each documented using its own schema.

Copy link

netlify bot commented Mar 17, 2025

Deploy Preview for grist-help-preview ready!

Name Link
🔨 Latest commit 0ef890f
🔍 Latest deploy log https://app.netlify.com/sites/grist-help-preview/deploys/67d8b85a6d737b00083f7485
😎 Deploy Preview https://deploy-preview-488--grist-help-preview.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@Spoffy
Copy link
Contributor Author

Spoffy commented Mar 18, 2025

This overlaps with this endpoint: /workspaces/{workspaceId}/docs, which creates a new, saved doc in the given workspace.

This means it looks odd in the API documentation, having two "Create new doc" endpoints:
image

My thinking is we avoid documenting use cases 3. and 4. (creating [un]saved documents), and document this purely as a Copy/Upload endpoint.

image

Any thoughts would be appreciated!

@Spoffy Spoffy force-pushed the spoffy/upload-doc branch from 1a78c99 to 0ef890f Compare March 18, 2025 00:03
@Spoffy
Copy link
Contributor Author

Spoffy commented Mar 18, 2025

On hold until the underlying API can be de-overloaded

@Spoffy Spoffy marked this pull request as draft March 18, 2025 15:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant