Skip to content

Commit 9618c91

Browse files
committed
Fix naming conventions and optional/required fields
1 parent ca7690b commit 9618c91

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

design-documents/graph-ql/coverage/b2b/company.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ type Company @doc(description: "Company entity output data schema.") {
2424
name: String @doc(description: "Company name.")
2525
email: String @doc(description: "Company email address.")
2626
legal_name: String @doc(description: "Company legal name.")
27-
vat_id: String @doc(description: "Company VAT/TAX id.")
27+
vat_tax_id: String @doc(description: "Company VAT/TAX id.")
2828
reseller_id: String @doc(description: "Company re-seller id.")
2929
legal_address: CompanyLegalAddress @doc(description: "Company legal address.")
3030
company_admin: Customer @doc(description: "An object containing information about Company Administrator.")
@@ -74,14 +74,14 @@ type CompanySalesRepresentative @doc(description: "Company sales representative
7474
}
7575

7676
type CompanyUsers @doc(description: "Output data schema for an object returned by a Company users search query.") {
77-
items: [Customer] @doc(description: "An array of 'CompanyUser' objects that match the specified search criteria.")
78-
total_count: Int @doc(description: "The number of objects returned.")
77+
items: [Customer]! @doc(description: "An array of 'CompanyUser' objects that match the specified search criteria.")
78+
total_count: Int! @doc(description: "The number of objects returned.")
7979
page_info: SearchResultPageInfo @doc(description: "Pagination meta data.")
8080
}
8181

8282
type CompanyRoles @doc(description: "Output data schema for an object returned by a Company roles search query.") {
83-
items: [CompanyRole] @doc(description: "A list of company roles that match the specified search criteria.")
84-
total_count: Int @doc(description: "The total number of objects matching the specified filter.")
83+
items: [CompanyRole]! @doc(description: "A list of company roles that match the specified search criteria.")
84+
total_count: Int! @doc(description: "The total number of objects matching the specified filter.")
8585
page_info: SearchResultPageInfo @doc(description: "Pagination meta data.")
8686
}
8787

@@ -95,24 +95,24 @@ type CompanyRole @doc(description: "Company role output data schema returned in
9595
type CompanyAclResource @doc(description: "Output data schema for an object with Role permission resource information.") {
9696
uid: ID! @doc(description: "ACL resource id.")
9797
text: String @doc(description: "ACL resource label.")
98-
sortOrder: Int @doc(description: "ACL resource sort order.")
98+
sort_order: Int @doc(description: "ACL resource sort order.")
9999
children: [CompanyAclResource!] @doc(description: "An array of sub-resources.")
100100
}
101101

102102
type CompanyRoleNameCheckResponse @doc(description: "Response object schema for a role name validation query.") {
103-
isNameValid: Boolean @doc(description: "Role name validation result")
103+
is_name_valid: Boolean @doc(description: "Role name validation result")
104104
}
105105

106106
type CompanyUserEmailCheckResponse @doc(description: "Response object schema for a Company User email validation query.") {
107-
isEmailValid: Boolean @doc(description: "Email validation result")
107+
is_email_valid: Boolean @doc(description: "Email validation result")
108108
}
109109

110110
type CompanyAdminEmailCheckResponse @doc(description: "Response object schema for a Company Admin email validation query.") {
111-
isEmailValid: Boolean @doc(description: "Email validation result")
111+
is_email_valid: Boolean @doc(description: "Email validation result")
112112
}
113113

114114
type CompanyEmailCheckResponse @doc(description: "Response object schema for a Company email validation query.") {
115-
isEmailValid: Boolean @doc(description: "Email validation result")
115+
is_email_valid: Boolean @doc(description: "Email validation result")
116116
}
117117

118118
union CompanyStructureEntity = CompanyTeam | Customer

0 commit comments

Comments
 (0)