Skip to content

Commit 707df47

Browse files
committed
feat: add API Response types
1 parent a26d38d commit 707df47

File tree

1 file changed

+114
-0
lines changed

1 file changed

+114
-0
lines changed

src/types.ts

Lines changed: 114 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,120 @@ export interface APIHealthResponse {
1212
name: string
1313
}
1414

15+
/**
16+
* Project endpoint response
17+
*/
18+
export interface APIGithubOrgDetails {
19+
id: number
20+
login: string
21+
github_org_id: number | null
22+
node_id: string | null
23+
url: string | null
24+
avatar_url: string | null
25+
description: string | null
26+
name: string | null
27+
company: string | null
28+
blog: string | null
29+
location: string | null
30+
twitter_username: string | null
31+
is_verified: boolean | null
32+
has_organization_projects: boolean | null
33+
has_repository_projects: boolean | null
34+
public_repos: number | null
35+
public_gists: number | null
36+
followers: number | null
37+
following: number | null
38+
html_url: string
39+
total_private_repos: number | null
40+
owned_private_repos: number | null
41+
private_gists: number | null
42+
disk_usage: number | null
43+
collaborators: number | null
44+
default_repository_permission: string | null
45+
members_can_create_repositories: boolean | null
46+
two_factor_requirement_enabled: boolean | null
47+
members_allowed_repository_creation_type: string | null
48+
members_can_create_public_repositories: boolean | null
49+
members_can_create_private_repositories: boolean | null
50+
members_can_create_internal_repositories: boolean | null
51+
members_can_create_pages: boolean | null
52+
members_can_create_public_pages: boolean | null
53+
members_can_create_private_pages: boolean | null
54+
members_can_fork_private_repositories: boolean | null
55+
web_commit_signoff_required: boolean | null
56+
deploy_keys_enabled_for_repositories: boolean | null
57+
dependency_graph_enabled_for_new_repositories: boolean | null
58+
dependabot_alerts_enabled_for_new_repositories: boolean | null
59+
dependabot_security_updates_enabled_for_new_repositories: boolean | null
60+
advanced_security_enabled_for_new_repositories: boolean | null
61+
secret_scanning_enabled_for_new_repositories: boolean | null
62+
secret_scanning_push_protection_enabled_for_new_repositories: boolean | null
63+
secret_scanning_push_protection_custom_link: string | null
64+
secret_scanning_push_protection_custom_link_enabled: boolean | null
65+
github_created_at: string | null
66+
github_updated_at: string | null
67+
github_archived_at: string | null
68+
created_at: string
69+
updated_at: string
70+
project_id: number
71+
}
72+
73+
/**
74+
* Project details
75+
*/
76+
export interface APIProjectDetails {
77+
id: number
78+
name: string
79+
created_at: string
80+
updated_at: string
81+
has_defineFunctionalRoles_policy: boolean | null
82+
has_orgToolingMFA_policy: boolean | null
83+
has_softwareArchitectureDocs_policy: boolean | null
84+
has_MFAImpersonationDefense_policy: boolean | null
85+
has_includeCVEInReleaseNotes_policy: boolean | null
86+
has_assignCVEForKnownVulns_policy: boolean | null
87+
has_incidentResponsePlan_policy: boolean | null
88+
has_regressionTestsForVulns_policy: boolean | null
89+
has_vulnResponse14Days_policy: boolean | null
90+
has_useCVDToolForVulns_policy: boolean | null
91+
has_securityMdMeetsOpenJSCVD_policy: boolean | null
92+
has_consistentBuildProcessDocs_policy: boolean | null
93+
has_machineReadableDependencies_policy: boolean | null
94+
has_identifyModifiedDependencies_policy: boolean | null
95+
has_ciAndCdPipelineAsCode_policy: boolean | null
96+
has_npmOrgMFA_policy: boolean | null
97+
has_npmPublicationMFA_policy: boolean | null
98+
has_upgradePathDocs_policy: boolean | null
99+
has_patchNonCriticalVulns90Days_policy: boolean | null
100+
has_patchCriticalVulns30Days_policy: boolean | null
101+
has_twoOrMoreOwnersForAccess_policy: boolean | null
102+
has_injectedSecretsAtRuntime_policy: boolean | null
103+
has_preventScriptInjection_policy: boolean | null
104+
has_resolveLinterWarnings_policy: boolean | null
105+
has_annualDependencyRefresh_policy: boolean | null
106+
}
107+
108+
/**
109+
* Error object as defined in the OpenAPI schema
110+
*/
111+
export interface APIErrorObject {
112+
message: string
113+
errorCode?: string
114+
path?: string
115+
[key: string]: any
116+
}
117+
118+
/**
119+
* Error response as defined in the OpenAPI schema
120+
*/
121+
export interface APIErrorResponse {
122+
errors: APIErrorObject[]
123+
name?: string
124+
path?: string
125+
status?: number
126+
[key: string]: any
127+
}
128+
15129
/**
16130
* Configuration interface for visionBoard CLI
17131
*/

0 commit comments

Comments
 (0)