Favorites / TS API structures #99
Open
Conversation
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
smar-ben-feigin
commented
Mar 21, 2025
lib/utils/apis.ts
Outdated
| webhooks : 'webhooks/', | ||
| workspaces : 'workspaces/' | ||
| }; | ||
| export enum ApiSection { |
Contributor
Author
There was a problem hiding this comment.
Do we want to land these objects in types.ts?
smar-ben-feigin
commented
Mar 21, 2025
| pageSize?: number; | ||
| }; | ||
|
|
||
| export type PaginationResponse = { |
Contributor
Author
There was a problem hiding this comment.
How frequently are these types used (everywhere?)
smar-ben-feigin
commented
Mar 21, 2025
| totalCount: number; | ||
| }; | ||
|
|
||
| export enum FavoritableResource { |
Contributor
Author
There was a problem hiding this comment.
Is this a standard set of resources?
smar-ben-feigin
changed the title
smar-ben-feigin
commented
Mar 21, 2025
| @@ -1,22 +1,41 @@ | |||
| import {ApiUrls} from "../types"; | |||
| export const apiUrls: ApiUrls = { | |||
Contributor
Author
There was a problem hiding this comment.
This could be a breaking change (conceptually even through deep-imports if not explicitly exported)
smar-ben-feigin
commented
Mar 21, 2025
| @@ -1,22 +1,41 @@ | |||
| import {ApiUrls} from "../types"; | |||
| export const apiUrls: ApiUrls = { | |||
Contributor
Author
There was a problem hiding this comment.
Re-export apiUrlByResource as apiUrls with a @depricated tag on it
smar-ben-feigin
commented
Mar 21, 2025
| type IncludeOptions = string; | ||
|
|
||
| type ListFavoritesParamsNonPaginated = { | ||
| includeAll: true; |
Contributor
Author
There was a problem hiding this comment.
Let's change this to avoid stronger restrictions than exactly in the api spec.
# Conflicts: # index.ts # lib/events/index.ts # lib/types/ApiUrls.ts # lib/types/CreateOptions.ts # lib/utils/apis.ts
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
No description provided.