Skip to content
This repository was archived by the owner on Dec 18, 2025. It is now read-only.

Comments

Project REST types (create/update/get/delete/import/export)#98

Merged
kpal81xd merged 2 commits intomainfrom
projects
Jul 16, 2025
Merged

Project REST types (create/update/get/delete/import/export)#98
kpal81xd merged 2 commits intomainfrom
projects

Conversation

@kpal81xd
Copy link
Contributor

@kpal81xd kpal81xd commented Jul 16, 2025

  • Updated arguments and responses for specified project REST types (reponses narrowed in future)

@kpal81xd kpal81xd requested a review from Copilot July 16, 2025 11:22
@kpal81xd kpal81xd self-assigned this Jul 16, 2025
@kpal81xd kpal81xd added the enhancement New feature or request label Jul 16, 2025
Copy link

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

This PR refactors the project REST client by centralizing request argument definitions into ProjectRequestArgs and specialized Project*Args types, adjusts field names and optionality, and updates each API function to accept a single args object. It also adds placeholder response types for all project endpoints.

  • Consolidated request payloads into ProjectRequestArgs and per-operation Project*Args
  • Renamed/optionalized fields (e.g., private_assetsprivate_source_assets, added website, image_url, tags)
  • Defined placeholder Project*Response types
Comments suppressed due to low confidence (4)

src/rest/projects.ts:58

  • The tags field in ProjectRequestArgs is required but many operations may not need tags. Consider making it optional (tags?: string[]) or moving it into the specific Create and Update args where it's needed.
    tags: string[];

src/rest/projects.ts:13

  • The owner field was originally a numeric ID. If this now represents a username, clarify the name (e.g., ownerUsername) or revert to number to match API expectations.
    owner?: string;

src/rest/projects.ts:84

  • The doc comment for ProjectImportArgs reads "URL to export" but this type is for import. Update to "The URL to import the project from."
     */

src/rest/projects.ts:171

  • After changing to an args object, the JSDoc parameters and return tags were removed. Update each doc block to include @param args and @returns for clarity.
 * Creates a new project

@kpal81xd kpal81xd requested a review from a team July 16, 2025 12:24
@kpal81xd kpal81xd merged commit 4160474 into main Jul 16, 2025
3 checks passed
@kpal81xd kpal81xd deleted the projects branch July 16, 2025 12:27
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant