microsoft/kiota

In-Context HTTP Snippet generation

Open

#5,546 opened on Oct 7, 2024

View on GitHub
 (1 comment) (1 reaction) (0 assignees)C# (326 forks)auto 404
enhancementhelp wantedtype:enhancementvscode-extension

Repository metrics

Stars
 (3,783 stars)
PR merge metrics
 (PR metrics pending)

Description

As part of the HTTP Snippet generation, we want to allow developers to generate HTTP snippets as they are browsing the API Explorer. We want them to be able to explorer but also test an API as they move along their discoverability journey.

  • Developers needs to be able to select an endpoint and generate an http snippet in the current active http file. If not active http file, it should create a temporary file.
  • When a developer is using a temporary file, at save time, it should ask the user to save it as part of their project
  • When a developer is generating another http snippet, it should append it to the active http file.

@maisarissi can you work with design on getting the right interaction with API Explorer?

Contributor guide

Research direction
Implement the core logic to generate HTTP snippets based on the selected endpoint and integrate it with the API Explorer UI. Handle temporary and active HTTP files, and prompt user on save for temporary files.
Tech stack
csharp
Domain
backenddeveloper experience
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
C#Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50