PowerShell / PowerShell/DSC

REST API resource

Open
#293 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Issue-Enhancement
Dominant language
Rust
Stars
523
Forks
75
Avg merge
3d 16h
Merged PRs (30d)
24

Description

Summary of the new feature / enhancement

Would it make sense to have a resource that simply performs REST calls? get would be GET, set would be POST, and test wouldn't be implemented (so synthesized).

Proposed technical implementation details (optional)

The resource would need these properties:

  • url
  • authType
  • authToken
  • contentType
  • content

For the returned payload, it would be useful to have access to the headers, so the response would be wrapped in a response object that includes header, body, etc... rather than the raw response from the REST call.

Idempotency can't be enforced other than trying a get before set.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue names no files, tests, or entry points. Start by reviewing existing DSC resource conventions, then clarify how get, set, synthesized test behavior, request properties, response headers, and idempotency should work; done means the design and implementation scope are agreed.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
api
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.