Skip to content

docs(specs): add PowerShellGallery v1 functional specification - #33

Draft
Marius Storhaug (MariusStorhaug) wants to merge 1 commit into
mainfrom
v1-spec
Draft

docs(specs): add PowerShellGallery v1 functional specification#33
Marius Storhaug (MariusStorhaug) wants to merge 1 commit into
mainfrom
v1-spec

Conversation

@MariusStorhaug

Copy link
Copy Markdown
Member

Summary

Adds the first functional specification for a v1 release of the PowerShellGallery module.

What’s in v1

  • Discovery (no auth required)
    • Get-PowerShellGalleryAPI
    • Find-PowerShellGalleryPackage
    • Get-PowerShellGalleryPackage
  • Listing management (requires package-owner API key)
    • Hide-PowerShellGalleryPackage (Unlist-PowerShellGalleryPackage)
    • Show-PowerShellGalleryPackage (List-PowerShellGalleryPackage)

The spec also covers naming conventions, private-helper responsibilities, error handling, authentication, testing approach, and migration from the current stubs.

Notes

  • Existing stub names Hide-PowerShellGalleryItem / Show-PowerShellGalleryItem are renamed to use the more precise noun Package; backward-compatible aliases are retained.
  • Read commands target the public PowerShell Gallery OData v2 endpoint.
  • Listing-management commands are scoped to package owners and use -WhatIf / -Confirm.

Related docs

Defines the initial public API for the PowerShellGallery module:
- API metadata discovery
- Package search and metadata retrieval
- Listing management (hide/show) for package owners
Includes naming conventions, parameter design, error handling,
testing strategy, and migration notes from current stubs.
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@github-actions

Copy link
Copy Markdown

No Significant Changes Detected

This PR does not contain changes to files that would trigger a new release:

PathDescription
src/**Module source code
README.mdDocumentation

Build, test, and publish stages will be skipped for this PR.

If you believe this is incorrect, please verify that your changes are in the correct locations.

@github-actions

Copy link
Copy Markdown

Super-linter summary

LanguageValidation result
CHECKOVPass ✅
GITHUB_ACTIONSPass ✅
GITLEAKSPass ✅
GIT_MERGE_CONFLICT_MARKERSPass ✅
MARKDOWNPass ✅
NATURAL_LANGUAGEPass ✅
POWERSHELLPass ✅
PRE_COMMITPass ✅
SPELL_CODESPELLPass ✅
TRIVYPass ✅
YAMLPass ✅

All files and directories linted successfully

For more information, see the GitHub Actions workflow run

Powered by Super-linter

Sign up for freeto 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.

1 participant

@MariusStorhaug