Skip to content

docs: remove retired Sheet.REST references #34

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.

Sign up for GitHub

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

Merged
musketyr merged 1 commit into from
Jun 10, 2026
+0 −70
Merged

docs: remove retired Sheet.REST references #34

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
70 changes: 0 additions & 70 deletions docs/guide/src/docs/asciidoc/index.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,76 +51,6 @@ dependencies {
</dependency>
----

== REST API
New experimental REST API is available at `https://api.sheet.rest/v1`:

[source,indent=0,role="primary"]
.cURL
----
curl --request POST \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Api-Key: jYXipZWOlU18gqyogkRSG4GgKdymodDY4Hj5BkfO" \
--data '{"sheets": [{"name": "Hello Excel","rows": [{"cells": [{"value": "Hello"}]}]}]}' \
https://api.sheet.rest/v1/build/excel
----

[source,indent=0,role="secondary"]
.IntelliJ HTTP Client JSON
----
POST https://api.sheet.rest/v1/build/excel
Content-Type: application/json
Accept: application/json
X-Api-Key: jYXipZWOlU18gqyogkRSG4GgKdymodDY4Hj5BkfO

{
"sheets": [
{
"name": "Hello Excel",
"rows": [
{
"cells": [
{
"value": "Hello"
}
]
}
]
}
]
}
----

[source,indent=0,role="secondary"]
.IntelliJ HTTP Client YAML
----
POST https://api.sheet.rest/v1/build/excel
Content-Type: text/vnd.yaml
Accept: application/json
X-Api-Key: jYXipZWOlU18gqyogkRSG4GgKdymodDY4Hj5BkfO

sheets:
- name: Hello Excel
rows:
- cells:
- value: Hello

----

Sucessfull response will contain single property URL with the link to the generated file which will be available for download
within next one hour:

[source,json]
----
{
"url": "<download url>"
}

----


Feel free to use provided API Key `jYXipZWOlU18gqyogkRSG4GgKdymodDY4Hj5BkfO` for testing or mailto:vladimir+sheet.rest@orany.cz?subject=Sheet.REST+API+Key&body=Hello,+I+would+like+an+dedicated+access+for+Sheet.REST+because+...[ask for a dedicated one].
Use the JSON and YAML sections of the examples for syntax details. Sheet.REST is currently in public beta.

== Writing Spreadsheets

Expand Down
Loading