Skip to content

Update Editor HTTP API commands and responses for 1.13.2 - #680

Merged
AGulev merged 2 commits into
masterfrom
docs/1.13.2-editor-http-api
Sep 11, 2026
Merged

AGulev merged 2 commits into
masterfrom
docs/1.13.2-editor-http-api

Conversation

@AGulev

@AGulev AGulev commented Sep 11, 2026

Copy link
Copy Markdown
Contributor

The Editor HTTP API manual still discovers commands through /command/{command} and describes completed HTML5 builds as HTTP 202. Update the guidance for Defold 1.13.2 so integrations discover individual command paths, choose compile-only or compile-and-run, and handle completed build results correctly.

Technical changes

  • Discover documented command paths from OpenAPI and replace /command/build examples with /command/compile and /command/run.
  • Explain the deprecated build alias and structured HTTP 200/422 results for commands that wait for completion.
  • Keep HTTP 202 guidance for asynchronous commands and distinguish completed HTML5 builds from game readiness in the browser.

Validation

  • Full repository frontmatter validation and git diff --check passed.
  • Local documentation links and fragments passed.
  • Bash syntax checked for all 19 shell examples; both JSON examples parsed successfully.
  • Behavior checked against the 1.13.2 beta implementation at be31a20289817d06f568449dbc1463e2d000eaaf.

Based on the Defold 1.13.2 beta release notes.

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Sep 11, 2026

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review Completed 2026-09-11T09:09:27.515978Z 452c4e2 PR opened
🔒 Security Review Completed 2026-09-11T09:09:08.545607Z 452c4e2 PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 452c4e28d8

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread docs/en/manuals/editor-http-api.md Outdated
Comment on lines +215 to +218
curl -sS \
-X POST \
"$BASE_URL/command/build-html5"
"$BASE_URL/command/build-html5" |
jq

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Expose HTTP failures in the HTML5 command example

When the build returns the documented structured 422 response, this pipeline can still exit successfully: curl -sS does not fail on HTTP error statuses, and the final jq supplies the pipeline exit status. I checked curl --help all: -s is only “Silent mode,” while -f/--fail-with-body handles HTTP errors and -w exposes response metadata. Automation following this example therefore cannot perform the next paragraph's required HTTP-status check and may proceed to browser tests after a failed build; capture and test the status while preserving the response body.

Useful? React with 👍 / 👎.

@AGulev
AGulev requested a review from vlaaad September 11, 2026 09:30

@vlaaad vlaaad left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you!

@AGulev
AGulev merged commit 68fb0ed into master Sep 11, 2026
3 checks passed
@AGulev
AGulev deleted the docs/1.13.2-editor-http-api branch September 11, 2026 09:35
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.

2 participants