Skip to content

Comments

Document HTTP typekits import and experimental status#9564

Draft
Copilot wants to merge 5 commits intomainfrom
copilot/fix-http-typekits-documentation
Draft

Document HTTP typekits import and experimental status#9564
Copilot wants to merge 5 commits intomainfrom
copilot/fix-http-typekits-documentation

Conversation

Copy link
Contributor

Copilot AI commented Feb 2, 2026

  • Add usage section to HTTP typekits documentation with import instructions
  • Add experimental warning banner to HTTP typekits documentation
  • Verify the documentation follows established patterns in the codebase
  • Merge latest main branch to fix website build issues
  • Restore documentation changes that were accidentally removed
Original prompt

This section details on the original issue you should resolve

<issue_title>[Bug]: Http typekits are not exposed and documentation is missing info on how to use</issue_title>
<issue_description>### Describe the bug

I had to add

import "@typespec/http/experimental/typekit";

To make them work in a non Alloy environment. Otherwise typescript doesn't see merged typekit declaration and missing all http typekits.

This should be either documented or exposed and working with http module import.

Reproduction

import { getHttpOperation } from "@typespec/http";
import { $ } from "@typespec/compiler/typekit";
// import "@typespec/http/experimental/typekit"; // uncomment to make this work


const [httpOperation] = getHttpOperation(program, operation);
$(program).httpOperation.flattenResponses(httpOperation);

Checklist

<agent_instructions>Indicate in the documentation for http typekits how to import the typekits. Also ensure thatr the documentation indicates that the typekits are experimental and may have breaking changes without notice.</agent_instructions>

Comments on the Issue (you are @copilot in this section)

@markcowl @artsiommiksiuk The typekit for http is currently experimental, the API surface area is volatile, and it is not documented so that customers do not inadvertently take a dependency on it without understanding the risks. This is why it is both exported as experimental and undocumented.

If the ask is to get the API to move the API from experimental to part of the public exports, that is ongoing work, but we cna use this issue to track it, if you like</comment_new>


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

…mentation

Co-authored-by: markcowl <1054056+markcowl@users.noreply.github.com>
@microsoft-github-policy-service microsoft-github-policy-service bot added the meta:website TypeSpec.io updates label Feb 3, 2026
Copilot AI changed the title [WIP] Fix missing documentation for Http typekits Document HTTP typekits import and experimental status Feb 3, 2026
Copilot AI requested a review from markcowl February 3, 2026 00:03
@markcowl
Copy link
Contributor

@copilot please pull the latest from the main branch and fix any issues with website build

Copy link
Contributor Author

Copilot AI commented Feb 24, 2026

@copilot please pull the latest from the main branch and fix any issues with website build

Done. I've successfully merged the latest main branch (commit aa2b623). The website build completes without errors, and all astro checks pass with 0 errors, 0 warnings, and 0 hints.

The HTTP typekits documentation now includes:

  • ✅ Experimental warning banner
  • ✅ Clear import instructions
  • ✅ Practical usage example

The documentation is fully compatible with the latest main branch changes.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

  • telemetry.astro.build
    • Triggering command: /home/REDACTED/work/_temp/ghcca-node/node/bin/node node /home/REDACTED/work/typespec/typespec/website/node_modules/.bin/../astro/astro.js check --minimumFailingSeverity hint (dns block)
    • Triggering command: /home/REDACTED/work/_temp/ghcca-node/node/bin/node node /home/REDACTED/work/typespec/typespec/website/node_modules/.bin/../astro/astro.js build sh s/.b�� ../../website/src/content/docs/d--output-dir dotnet p/bin/sh perimental gen-esh bash (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

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

Labels

meta:website TypeSpec.io updates

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Bug]: Http typekits are not exposed and documentation is missing info on how to use

2 participants