Skip to content

fix(orchestrator): fix broken bind and create-service API samples - #2574

Merged
bruno-andrade-azion merged 2 commits into
mainfrom
docs/mm-16225-orchestrator-broken-samples
Nov 12, 2026
Merged

bruno-andrade-azion merged 2 commits into
mainfrom
docs/mm-16225-orchestrator-broken-samples

Conversation

@bruno-andrade-azion

@bruno-andrade-azion bruno-andrade-azion commented Nov 5, 2026 •

Copy link
Copy Markdown
Contributor

Summary

  • run-scripts: the bind request body had "service_id": :id, which is not valid JSON, and reused :id for both the node and the service. The body now uses a numeric service ID (1196, matching the earlier response sample) and the URL uses :node_id (en and pt-br).
  • create-service: the POST creates the service with "active": false, but the page said it was ready to deploy. Only active services can be bound to an edge node. Added the PATCH step that sets "active": true, the matching note, and the Active step in the Console panel (en and pt-br).
  • create-service, after review: the API panel now shows the POST response the reader keeps the id from (the sample the run-scripts page already carries), the PATCH step leads with its purpose, and the note drops its contractions. The pt-br run-scripts bind sentence formats [TOKEN VALUE] as code.
  • Review finding about unlabeled tabs in work-with-variables: no change needed. Tabs.vue builds the Console/API strip for panel-only sharedStore="interface" blocks (since fix(docs): general technical fixes #2469); confirmed on production for work-with-variables and run-scripts.

How to test

  1. pnpm dev
  2. Open /en/documentation/guides/application-development/automation/create-edge-service/?interface=api and /pt-br/documentacao/guias/desenvolvimento-de-aplicacoes/automacao/criar-edge-service/?interface=api: the API panel shows the POST, then the PATCH with "active": true; the Console panel includes "Set the status as Active".
  3. Open /en/documentation/guides/application-development/automation/run-scripts/?interface=api and the pt-br twin /pt-br/documentacao/guias/desenvolvimento-de-aplicacoes/automacao/rodar-scripts/?interface=api: the bind request uses edge_nodes/:node_id/services and "service_id": 1196.

URL changes and redirects

None

Notes

  • Jira: MM-16225 (epic MM-16212, review cluster 8, findings 1, 2 and 6).
  • For the SME: confirm that the v3 PATCH /edge_services/:id accepts {"active": true} alone, that variables is optional on the bind endpoint, and that the Console form labels the status Active. The API reference could not be read during review.
  • Merge order: docs(orchestrator): split how-tos into API v4 and API v3 pages #2584 repeats this text in its -v3 copies. Merge this PR first, then merge main into docs(orchestrator): split how-tos into API v4 and API v3 pages #2584.
  • Out of scope, tracked elsewhere in the epic: migrating these pages off API v3, the diverging bind prerequisite (Add-On Services), and the pinned CLI 1.10.2 sample.

- run-scripts: replace the invalid "service_id": :id body with a numeric
  service ID and rename the URL placeholder to :node_id (en and pt-br).
- create-service: the API creates the service inactive, so add the PATCH
  step that sets "active": true and the Active step in the Console panel
  (en and pt-br).

Refs MM-16225

Co-Authored-By: Claude <[email protected]>
…ctivation step

Show the POST response the page asks the reader to keep the id from,
lead the PATCH step with its purpose, drop the contractions in the note,
and format [TOKEN VALUE] as code in the pt-br bind sentence.

Co-Authored-By: Claude <[email protected]>
@bruno-andrade-azion bruno-andrade-azion changed the title docs(orchestrator): fix broken bind and create-service API samples fix(orchestrator): fix broken bind and create-service API samples Nov 12, 2026
@bruno-andrade-azion
bruno-andrade-azion merged commit 9490e5f into main Nov 12, 2026
9 checks passed
@bruno-andrade-azion
bruno-andrade-azion deleted the docs/mm-16225-orchestrator-broken-samples branch November 12, 2026 14:51
bruno-andrade-azion pushed a commit that referenced this pull request Nov 12, 2026
* origin/main: (29 commits)
  fix(structure): tag bare code fences, fix heading skips, add pt-br meta_tags (#2629)
  docs(style-guide): drop the nonexistent GlossaryFilter from the glossary template (#2577)
  docs(release-notes): fix the October 14 anchor and merge the duplicate February 24 entry (#2572)
  fix(orchestrator): fix broken bind and create-service API samples (#2574)
  docs(readability): split the long sentences in the Runtime, CLI, Reference, and KV Store pages (#2635)
  chore(nav): count only visible rows toward the navcheck soft max (#2640)
  docs(nav): triage the pages outside the navigation (#2593)
  fix(guides): match the QStash variable and the Functions usage response to the code (#2571)
  feat(nav): give every breadcrumb crumb a page and make CLI commands runnable (#2636)
  fix(cli): drop azion update workload-deployment, which the CLI does not expose (#2639)
  docs(terminology): retire Edge Node, module, and add-on from current pages (#2618)
  docs(migration): share the repeated migration-guide procedures as partials (#2619)
  fix(marketplace): drop the Azion CLI prerequisite from firewall integration guides (#2612)
  docs(guides): replace the residual "These checks confirm" lines with use-case expect blocks (#2611)
  docs(guides): make the auth layer and vector search tutorials runnable (#2566)
  chore(scripts): add pnpm lint:terraform to validate Terraform samples (#2637)
  fix(firewall): correct the CLI binding, the WAF config sample, and the JWT paywall steps (#2565)
  docs(cli): document azion workload-deployment and fix pages that say the CLI cannot bind a deployment (#2567)
  docs(terraform): rewrite the samples for provider v2.10.0 (#2557)
  chore(deploy): promote docs-v2.4.4 to production (#2631)
  ...

# Conflicts:
#	apps/docs/src/content/docs/en/pages/observe/real-time-events/data-sources.mdx
#	apps/docs/src/content/docs/pt-br/pages/observe/real-time-events/fontes-de-dados.mdx
bruno-andrade-azion pushed a commit that referenced this pull request Nov 12, 2026
* origin/main: (39 commits)
  fix(terminology): replace desempenho and aplicativo in pt-br pages (#2621)
  docs(observe): fix dataset name, Data Stream filter, and Grafana Data path (#2573)
  fix(fundamentals): rewrite the Load Balancer steps in minimize-downtime from the reference (#2578)
  i18n(pt-br): label unlabelled asides and fix label casing (#2622)
  fix(links): point pt-br links to their existing pt-br pages (#2620)
  i18n(pt-br): resync the drifted release notes, punctuation, and Edge Services pairs (#2624)
  i18n(pt-br): pair three pages with their English versions by namespace (#2625)
  docs(style-guide): adopt the jsonl tag for JSON Lines samples (#2642)
  chore(lint): check the changelog entries a PR adds (#2634)
  [NO-ISSUE] ci: replace technote-space/assign-author (SO-5131) (#2591)
  fix(structure): tag bare code fences, fix heading skips, add pt-br meta_tags (#2629)
  docs(style-guide): drop the nonexistent GlossaryFilter from the glossary template (#2577)
  docs(release-notes): fix the October 14 anchor and merge the duplicate February 24 entry (#2572)
  fix(orchestrator): fix broken bind and create-service API samples (#2574)
  docs(readability): split the long sentences in the Runtime, CLI, Reference, and KV Store pages (#2635)
  chore(nav): count only visible rows toward the navcheck soft max (#2640)
  docs(nav): triage the pages outside the navigation (#2593)
  fix(guides): match the QStash variable and the Functions usage response to the code (#2571)
  feat(nav): give every breadcrumb crumb a page and make CLI commands runnable (#2636)
  fix(cli): drop azion update workload-deployment, which the CLI does not expose (#2639)
  ...

# Conflicts:
#	apps/docs/src/content/docs/en/pages/store/sql-database/glossary.mdx
#	apps/docs/src/content/docs/pt-br/pages/store/sql-database/glossario.mdx
bruno-andrade-azion pushed a commit that referenced this pull request Nov 12, 2026
* origin/main: (53 commits)
  docs(style-guide): standardize Azion Console click paths (#2596)
  docs(store): name the SQL and Storage libraries by their scoped packages (#2575)
  fix(terminology): replace desempenho and aplicativo in pt-br pages (#2621)
  docs(observe): fix dataset name, Data Stream filter, and Grafana Data path (#2573)
  fix(fundamentals): rewrite the Load Balancer steps in minimize-downtime from the reference (#2578)
  i18n(pt-br): label unlabelled asides and fix label casing (#2622)
  fix(links): point pt-br links to their existing pt-br pages (#2620)
  i18n(pt-br): resync the drifted release notes, punctuation, and Edge Services pairs (#2624)
  i18n(pt-br): pair three pages with their English versions by namespace (#2625)
  docs(style-guide): adopt the jsonl tag for JSON Lines samples (#2642)
  chore(lint): check the changelog entries a PR adds (#2634)
  [NO-ISSUE] ci: replace technote-space/assign-author (SO-5131) (#2591)
  fix(structure): tag bare code fences, fix heading skips, add pt-br meta_tags (#2629)
  docs(style-guide): drop the nonexistent GlossaryFilter from the glossary template (#2577)
  docs(release-notes): fix the October 14 anchor and merge the duplicate February 24 entry (#2572)
  fix(orchestrator): fix broken bind and create-service API samples (#2574)
  docs(readability): split the long sentences in the Runtime, CLI, Reference, and KV Store pages (#2635)
  chore(nav): count only visible rows toward the navcheck soft max (#2640)
  docs(nav): triage the pages outside the navigation (#2593)
  fix(guides): match the QStash variable and the Functions usage response to the code (#2571)
  ...

# Conflicts:
#	apps/docs/src/content/docs/en/pages/main-menu/reference/accounts/personal-tokens.mdx
#	apps/docs/src/content/docs/en/pages/main-menu/reference/services/support/http-error-status-codes.mdx
#	apps/docs/src/content/docs/pt-br/pages/menu-principal/referencia/contas/personal-tokens.mdx
bruno-andrade-azion pushed a commit that referenced this pull request Nov 12, 2026
Resolve the 16 conflicts in the current Orchestrator how-tos: keep the
PR's Console-only layout with main's Console steps (#2596) and the
authorize additions from #2588.

Rebuild the 16 -v3 pages from main's version of each page, so they carry
the Console click paths (#2596), the #2574 review fixes, the pt-br link
and aside fixes (#2620, #2622), and the authorize additions (#2588).

Also apply the PR review:
- en create-service: move the active-service note out of the step list
  and drop its contractions
- en descriptions: start with the verb instead of "Learn how to"
- pt-br run-scripts: replace the "borda" DocButton labels

Refs MM-16233
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants