This repository was archived by the owner on Dec 18, 2025. It is now read-only.
Conversation
There was a problem hiding this comment.
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
ProjectRequestArgsand per-operationProject*Args - Renamed/optionalized fields (e.g.,
private_assets→private_source_assets, addedwebsite,image_url,tags) - Defined placeholder
Project*Responsetypes
Comments suppressed due to low confidence (4)
src/rest/projects.ts:58
- The
tagsfield inProjectRequestArgsis required but many operations may not need tags. Consider making it optional (tags?: string[]) or moving it into the specificCreateandUpdateargs where it's needed.
tags: string[];
src/rest/projects.ts:13
- The
ownerfield was originally a numeric ID. If this now represents a username, clarify the name (e.g.,ownerUsername) or revert tonumberto match API expectations.
owner?: string;
src/rest/projects.ts:84
- The doc comment for
ProjectImportArgsreads "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
argsobject, the JSDoc parameters and return tags were removed. Update each doc block to include@param argsand@returnsfor clarity.
* Creates a new project
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.