Skip to content

Add autorize api usage toturial#121

Merged
Corb3nik merged 2 commits into
mainfrom
ae-sdk-client-autorize-api
May 21, 2026
Merged

Add autorize api usage toturial#121
Corb3nik merged 2 commits into
mainfrom
ae-sdk-client-autorize-api

Conversation

@amrelsagaei
Copy link
Copy Markdown
Contributor

This closes #116

Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Adds a new Client SDK tutorial that teaches how to drive the Caido Autorize community plugin from an external Node/TypeScript script, and exposes it in the Tutorials sidebar (closing #116).

Changes:

  • Introduces a step-by-step tutorial for installing/configuring Autorize, creating a template, waiting for results, and interpreting authorization outcomes.
  • Adds the new tutorial page to the VitePress Tutorials sidebar under “Client SDK”.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.

File Description
src/tutorials/client/autorize.md New tutorial page covering end-to-end Autorize API usage via the Client SDK, including a full runnable script.
.vitepress/sidebars/tutorials.ts Adds “Using the Autorize API” to the Tutorials sidebar navigation.
Comments suppressed due to low confidence (2)

src/tutorials/client/autorize.md:345

  • Cleanup deletes the template and updates config without checking their APIResult envelopes. If either operation fails, the script will silently continue and may leave templates/user profiles behind. Handle { kind: "Error" } here (and consider putting cleanup in a finally block in the full script).
  // 8. Cleanup
  await pkg.deleteTemplate(templateId);
  await pkg.updateConfig({ userProfiles: [] });
}

src/tutorials/client/autorize.md:320

  • Same issue as earlier: expectedResults uses cfg.value.userProfiles.length rather than counting only enabled profiles. If disabled profiles exist, the combined script can hang in the results polling loop. Base the expected count on enabled profiles.
  // 6. Wait for all results
  let template = created.value;
  const expectedResults = 1 + cfg.value.userProfiles.length + (cfg.value.testNoAuth ? 1 : 0);
  while (template.results.length < expectedResults) {
    await new Promise((resolve) => setTimeout(resolve, 1500));

Comment thread src/tutorials/client/autorize.md Outdated
Comment thread src/tutorials/client/autorize.md
Comment thread src/tutorials/client/autorize.md Outdated
Copy link
Copy Markdown
Member

@Corb3nik Corb3nik left a comment

Choose a reason for hiding this comment

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

Another great tutorial. 🙇‍♂️

@Corb3nik Corb3nik merged commit 33b6e46 into main May 21, 2026
5 checks passed
@Corb3nik Corb3nik deleted the ae-sdk-client-autorize-api branch May 21, 2026 13:04
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.

Add Autorize tutorial in Client tutorials

4 participants