Skip to content

fix(contacts): add fieldValue (preferred) + deprecate field_value in custom-field schemas #320

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
MCPVOT wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix(contacts): add fieldValue (preferred) + deprecate field_value in custom-field schemas #320

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
141 changes: 128 additions & 13 deletions apps/contacts.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1839,7 +1839,7 @@
}
}
},
"tags": [

Check warning on line 1842 in apps/contacts.json

View check run for this annotation

Orca Security (US) / Orca Security - Infrastructure as Code

[INFO] Object Without Required Property 

Details:
OpenAPI v3 specification objects lack required fields defined by the standard,
causing schema validation failures and potential client integration issues.
Missing required properties prevent proper API documentation parsing and code
generation. Include all mandatory fields as specified in the OpenAPI 3.0
specification.

Recommendation:
tags has all required fields
"Contacts"
],
"security": [
Expand Down Expand Up @@ -2706,7 +2706,7 @@
}
}
},
"tags": [

Check warning on line 2709 in apps/contacts.json

View check run for this annotation

Orca Security (US) / Orca Security - Infrastructure as Code

[INFO] Object Without Required Property 

Details:
OpenAPI v3 specification objects lack required fields defined by the standard,
causing schema validation failures and potential client integration issues.
Missing required properties prevent proper API documentation parsing and code
generation. Include all mandatory fields as specified in the OpenAPI 3.0
specification.

Recommendation:
tags has all required fields
"Contacts"
],
"security": [
Expand Down Expand Up @@ -2829,7 +2829,7 @@
}
}
},
"tags": [

Check warning on line 2832 in apps/contacts.json

View check run for this annotation

Orca Security (US) / Orca Security - Infrastructure as Code

[INFO] Object Without Required Property 

Details:
OpenAPI v3 specification objects lack required fields defined by the standard,
causing schema validation failures and potential client integration issues.
Missing required properties prevent proper API documentation parsing and code
generation. Include all mandatory fields as specified in the OpenAPI 3.0
specification.

Recommendation:
tags has all required fields
"Contacts"
],
"security": [
Expand Down Expand Up @@ -2905,7 +2905,7 @@
"description": "Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.",
"type": "http"
},
"Location-Access": {

Check warning on line 2908 in apps/contacts.json

View check run for this annotation

Orca Security (US) / Orca Security - Infrastructure as Code

[INFO] Components Object Fixed Field Key Improperly Named 

Details:
Component object field keys in OpenAPI specifications must follow naming
conventions allowing only alphanumeric characters, periods, hyphens, and
underscores. Non-compliant keys cause parsing errors and break tooling
compatibility. Use keys matching the pattern `^[a-zA-Z0-9\.\-_]+$`.

Recommendation:
components.{{securitySchemes}}.{{Location-Access}} is properly named
"scheme": "bearer",
"bearerFormat": "JWT",
"name": "Authorization",
Expand All @@ -2913,7 +2913,7 @@
"description": "Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.",
"type": "http"
},
"Location-Access-Only": {

Check warning on line 2916 in apps/contacts.json

View check run for this annotation

Orca Security (US) / Orca Security - Infrastructure as Code

[INFO] Components Object Fixed Field Key Improperly Named 

Details:
Component object field keys in OpenAPI specifications must follow naming
conventions allowing only alphanumeric characters, periods, hyphens, and
underscores. Non-compliant keys cause parsing errors and break tooling
compatibility. Use keys matching the pattern `^[a-zA-Z0-9\.\-_]+$`.

Recommendation:
components.{{securitySchemes}}.{{Location-Access-Only}} is properly named
"scheme": "bearer",
"bearerFormat": "JWT",
"name": "Authorization",
Expand All @@ -2921,7 +2921,7 @@
"description": "Use the Access Token generated with user type as Sub-Account.",
"type": "http"
},
"Agency-Access": {

Check warning on line 2924 in apps/contacts.json

View check run for this annotation

Orca Security (US) / Orca Security - Infrastructure as Code

[INFO] Components Object Fixed Field Key Improperly Named 

Details:
Component object field keys in OpenAPI specifications must follow naming
conventions allowing only alphanumeric characters, periods, hyphens, and
underscores. Non-compliant keys cause parsing errors and break tooling
compatibility. Use keys matching the pattern `^[a-zA-Z0-9\.\-_]+$`.

Recommendation:
components.{{securitySchemes}}.{{Agency-Access}} is properly named
"scheme": "bearer",
"bearerFormat": "JWT",
"name": "Authorization",
Expand All @@ -2929,7 +2929,7 @@
"description": "Use the Access Token generated with user type as Agency (OR) Private Integration Token of Agency.",
"type": "http"
},
"Agency-Access-Only": {

Check warning on line 2932 in apps/contacts.json

View check run for this annotation

Orca Security (US) / Orca Security - Infrastructure as Code

[INFO] Components Object Fixed Field Key Improperly Named 

Details:
Component object field keys in OpenAPI specifications must follow naming
conventions allowing only alphanumeric characters, periods, hyphens, and
underscores. Non-compliant keys cause parsing errors and break tooling
compatibility. Use keys matching the pattern `^[a-zA-Z0-9\.\-_]+$`.

Recommendation:
components.{{securitySchemes}}.{{Agency-Access-Only}} is properly named
"scheme": "bearer",
"bearerFormat": "JWT",
"name": "Authorization",
Expand Down Expand Up @@ -3349,7 +3349,7 @@
"type": "string"
}
},
"tags": {

Check warning on line 3352 in apps/contacts.json

View check run for this annotation

Orca Security (US) / Orca Security - Infrastructure as Code

[INFO] Object Without Required Property 

Details:
OpenAPI v3 specification objects lack required fields defined by the standard,
causing schema validation failures and potential client integration issues.
Missing required properties prevent proper API documentation parsing and code
generation. Include all mandatory fields as specified in the OpenAPI 3.0
specification.

Recommendation:
tags has all required fields
"description": "list of tags to be added or removed",
"example": [
"tag-1",
Expand Down Expand Up @@ -3392,7 +3392,7 @@
},
"responses": {
"description": "Responses for each contact processed",
"example": [

Check warning on line 3395 in apps/contacts.json

View check run for this annotation

Orca Security (US) / Orca Security - Infrastructure as Code

[INFO] Unknown Property 

Details:
OpenAPI v3.0 specifications contain properties not recognized by the standard
schema, indicating potential typos, deprecated fields, or custom extensions.
Unknown properties may cause validation failures or unexpected API behavior.
Review and remove unrecognized fields or properly namespace custom extensions
using 'x-' prefix.

Recommendation:
The field '%!s(int=2)' is known in the responses object

Check warning on line 3395 in apps/contacts.json

View check run for this annotation

Orca Security (US) / Orca Security - Infrastructure as Code

[INFO] Unknown Property 

Details:
OpenAPI v3.0 specifications contain properties not recognized by the standard
schema, indicating potential typos, deprecated fields, or custom extensions.
Unknown properties may cause validation failures or unexpected API behavior.
Review and remove unrecognized fields or properly namespace custom extensions
using 'x-' prefix.

Recommendation:
The field '%!s(int=3)' is known in the responses object

Check warning on line 3395 in apps/contacts.json

View check run for this annotation

Orca Security (US) / Orca Security - Infrastructure as Code

[INFO] Unknown Property 

Details:
OpenAPI v3.0 specifications contain properties not recognized by the standard
schema, indicating potential typos, deprecated fields, or custom extensions.
Unknown properties may cause validation failures or unexpected API behavior.
Review and remove unrecognized fields or properly namespace custom extensions
using 'x-' prefix.

Recommendation:
The field '%!s(int=1)' is known in the responses object

Check warning on line 3395 in apps/contacts.json

View check run for this annotation

Orca Security (US) / Orca Security - Infrastructure as Code

[INFO] Unknown Property 

Details:
OpenAPI v3.0 specifications contain properties not recognized by the standard
schema, indicating potential typos, deprecated fields, or custom extensions.
Unknown properties may cause validation failures or unexpected API behavior.
Review and remove unrecognized fields or properly namespace custom extensions
using 'x-' prefix.

Recommendation:
The field '%!s(int=0)' is known in the responses object

Check warning on line 3395 in apps/contacts.json

View check run for this annotation

Orca Security (US) / Orca Security - Infrastructure as Code

[INFO] Object Without Required Property 

Details:
OpenAPI v3 specification objects lack required fields defined by the standard,
causing schema validation failures and potential client integration issues.
Missing required properties prevent proper API documentation parsing and code
generation. Include all mandatory fields as specified in the OpenAPI 3.0
specification.

Recommendation:
responses has all required fields
{
"contactId": "qFSqySFkVvNzOSqgGqFi",
"message": "Tags updated",
Expand Down Expand Up @@ -3422,7 +3422,7 @@
],
"type": "array",
"items": {
"type": "string"

Check warning on line 3425 in apps/contacts.json

View check run for this annotation

Orca Security (US) / Orca Security - Infrastructure as Code

[INFO] Unknown Property 

Details:
OpenAPI v3.0 specifications contain properties not recognized by the standard
schema, indicating potential typos, deprecated fields, or custom extensions.
Unknown properties may cause validation failures or unexpected API behavior.
Review and remove unrecognized fields or properly namespace custom extensions
using 'x-' prefix.

Recommendation:
The field 'type' is known in the responses object
}
}
},
Expand Down Expand Up @@ -3791,7 +3791,7 @@
"type": "object",
"properties": {
"contact": {
"$ref": "#/components/schemas/GetContectByIdSchema"

Check warning on line 3794 in apps/contacts.json

View check run for this annotation

Orca Security (US) / Orca Security - Infrastructure as Code

[INFO] Unknown Property 

Details:
OpenAPI v3.0 specifications contain properties not recognized by the standard
schema, indicating potential typos, deprecated fields, or custom extensions.
Unknown properties may cause validation failures or unexpected API behavior.
Review and remove unrecognized fields or properly namespace custom extensions
using 'x-' prefix.

Recommendation:
The field '$ref' is known in the contact object
}
}
},
Expand All @@ -3806,6 +3806,17 @@
"type": "string",
"example": "my_custom_field"
},
"fieldValue": {
"example": [
"test",
"test2"
],
"type": "array",
"items": {
"type": "string"
},
"description": "Value for the custom field (preferred)."
},
"field_value": {
"example": [
"test",
Expand All @@ -3814,7 +3825,9 @@
"type": "array",
"items": {
"type": "string"
}
},
"deprecated": true,
"description": "Deprecated. Use `fieldValue` instead."
}
},
"required": [
Expand All @@ -3832,9 +3845,16 @@
"type": "string",
"example": "my_custom_field"
},
"fieldValue": {
"type": "object",
"example": {},
"description": "Value for the custom field (preferred)."
},
"field_value": {
"type": "object",
"example": {}
"example": {},
"deprecated": true,
"description": "Deprecated. Use `fieldValue` instead."
}
},
"required": [
Expand All @@ -3854,9 +3874,16 @@
"example": "my_custom_field",
"description": "Pass either `id` or `key` of custom field"
},
"fieldValue": {
"type": "string",
"example": "9039160788",
"description": "Value for the custom field (preferred)."
},
"field_value": {
"type": "string",
"example": "9039160788"
"example": "9039160788",
"deprecated": true,
"description": "Deprecated. Use `fieldValue` instead."
}
}
},
Expand All @@ -3871,9 +3898,16 @@
"type": "string",
"example": "my_custom_field"
},
"fieldValue": {
"type": "string",
"example": "My Text",
"description": "Value for the custom field (preferred)."
},
"field_value": {
"type": "string",
"example": "My Text"
"example": "My Text",
"deprecated": true,
"description": "Deprecated. Use `fieldValue` instead."
}
},
"required": [
Expand All @@ -3891,9 +3925,16 @@
"type": "string",
"example": "my_custom_field"
},
"fieldValue": {
"type": "string",
"example": "My Text",
"description": "Value for the custom field (preferred)."
},
"field_value": {
"type": "string",
"example": "My Text"
"example": "My Text",
"deprecated": true,
"description": "Deprecated. Use `fieldValue` instead."
}
},
"required": [
Expand All @@ -3911,9 +3952,16 @@
"type": "string",
"example": "my_custom_field"
},
"fieldValue": {
"type": "string",
"example": "My Selected Option",
"description": "Value for the custom field (preferred)."
},
"field_value": {
"type": "string",
"example": "My Selected Option"
"example": "My Selected Option",
"deprecated": true,
"description": "Deprecated. Use `fieldValue` instead."
}
},
"required": [
Expand All @@ -3931,9 +3979,16 @@
"type": "string",
"example": "my_custom_field"
},
"fieldValue": {
"type": "string",
"example": "My Selected Option",
"description": "Value for the custom field (preferred)."
},
"field_value": {
"type": "string",
"example": "My Selected Option"
"example": "My Selected Option",
"deprecated": true,
"description": "Deprecated. Use `fieldValue` instead."
}
},
"required": [
Expand All @@ -3951,9 +4006,16 @@
"type": "string",
"example": "my_custom_field"
},
"fieldValue": {
"type": "object",
"example": 100,
"description": "Value for the custom field (preferred)."
},
"field_value": {
"type": "object",
"example": 100
"example": 100,
"deprecated": true,
"description": "Deprecated. Use `fieldValue` instead."
}
},
"required": [
Expand All @@ -3971,9 +4033,16 @@
"type": "string",
"example": "my_custom_field"
},
"fieldValue": {
"type": "object",
"example": 100.5,
"description": "Value for the custom field (preferred)."
},
"field_value": {
"type": "object",
"example": 100.5
"example": 100.5,
"deprecated": true,
"description": "Deprecated. Use `fieldValue` instead."
}
},
"required": [
Expand All @@ -3991,6 +4060,17 @@
"type": "string",
"example": "my_custom_field"
},
"fieldValue": {
"example": [
"test",
"test2"
],
"type": "array",
"items": {
"type": "string"
},
"description": "Value for the custom field (preferred)."
},
"field_value": {
"example": [
"test",
Expand All @@ -3999,7 +4079,9 @@
"type": "array",
"items": {
"type": "string"
}
},
"deprecated": true,
"description": "Deprecated. Use `fieldValue` instead."
}
},
"required": [
Expand All @@ -4017,6 +4099,17 @@
"type": "string",
"example": "my_custom_field"
},
"fieldValue": {
"example": [
"test",
"test2"
],
"type": "array",
"items": {
"type": "string"
},
"description": "Value for the custom field (preferred)."
},
"field_value": {
"example": [
"test",
Expand All @@ -4025,7 +4118,9 @@
"type": "array",
"items": {
"type": "string"
}
},
"deprecated": true,
"description": "Deprecated. Use `fieldValue` instead."
}
},
"required": [
Expand All @@ -4043,6 +4138,24 @@
"type": "string",
"example": "my_custom_field"
},
"fieldValue": {
"type": "object",
"example": {
"f31175d4-2b06-4fc6-b7bc-74cd814c68cb": {
"meta": {
"fieldname": "1HeGizb13P0odwgOgKSs",
"originalname": "IMG_20231215_164412935.jpg",
"encoding": "7bit",
"mimetype": "image/jpeg",
"size": 1786611,
"uuid": "f31175d4-2b06-4fc6-b7bc-74cd814c68cb"
},
"url": "https://services.leadconnectorhq.com/documents/download/w2M9qTZ0ZJz8rGt02jdJ",
"documentId": "w2M9qTZ0ZJz8rGt02jdJ"
}
},
"description": "Value for the custom field (preferred)."
},
"field_value": {
"type": "object",
"example": {
Expand All @@ -4058,7 +4171,9 @@
"url": "https://services.leadconnectorhq.com/documents/download/w2M9qTZ0ZJz8rGt02jdJ",
"documentId": "w2M9qTZ0ZJz8rGt02jdJ"
}
}
},
"deprecated": true,
"description": "Deprecated. Use `fieldValue` instead."
}
},
"required": [
Expand Down Expand Up @@ -4406,7 +4521,7 @@
"type": "object",
"properties": {
"contact": {
"$ref": "#/components/schemas/CreateContactSchema"

Check warning on line 4524 in apps/contacts.json

View check run for this annotation

Orca Security (US) / Orca Security - Infrastructure as Code

[INFO] Unknown Property 

Details:
OpenAPI v3.0 specifications contain properties not recognized by the standard
schema, indicating potential typos, deprecated fields, or custom extensions.
Unknown properties may cause validation failures or unexpected API behavior.
Review and remove unrecognized fields or properly namespace custom extensions
using 'x-' prefix.

Recommendation:
The field '$ref' is known in the contact object
}
}
},
Expand Down Expand Up @@ -4477,7 +4592,7 @@
"inboundDndSettings": {
"$ref": "#/components/schemas/InboundDndSettingsSchema"
},
"tags": {

Check warning on line 4595 in apps/contacts.json

View check run for this annotation

Orca Security (US) / Orca Security - Infrastructure as Code

[INFO] Object Without Required Property 

Details:
OpenAPI v3 specification objects lack required fields defined by the standard,
causing schema validation failures and potential client integration issues.
Missing required properties prevent proper API documentation parsing and code
generation. Include all mandatory fields as specified in the OpenAPI 3.0
specification.

Recommendation:
tags has all required fields
"example": [
"nisi sint commodo amet",
"consequat"
Expand Down Expand Up @@ -4553,7 +4668,7 @@
"example": true
},
"contact": {
"$ref": "#/components/schemas/GetContectByIdSchema"

Check warning on line 4671 in apps/contacts.json

View check run for this annotation

Orca Security (US) / Orca Security - Infrastructure as Code

[INFO] Unknown Property 

Details:
OpenAPI v3.0 specifications contain properties not recognized by the standard
schema, indicating potential typos, deprecated fields, or custom extensions.
Unknown properties may cause validation failures or unexpected API behavior.
Review and remove unrecognized fields or properly namespace custom extensions
using 'x-' prefix.

Recommendation:
The field '$ref' is known in the contact object
}
}
},
Expand Down Expand Up @@ -4720,7 +4835,7 @@
"example": true
},
"contact": {
"$ref": "#/components/schemas/GetContectByIdSchema"

Check warning on line 4838 in apps/contacts.json

View check run for this annotation

Orca Security (US) / Orca Security - Infrastructure as Code

[INFO] Unknown Property 

Details:
OpenAPI v3.0 specifications contain properties not recognized by the standard
schema, indicating potential typos, deprecated fields, or custom extensions.
Unknown properties may cause validation failures or unexpected API behavior.
Review and remove unrecognized fields or properly namespace custom extensions
using 'x-' prefix.

Recommendation:
The field '$ref' is known in the contact object
},
"traceId": {
"type": "string"
Expand Down Expand Up @@ -4952,7 +5067,7 @@
}
}
},
"x-tagGroups": {

Check warning on line 5070 in apps/contacts.json

View check run for this annotation

Orca Security (US) / Orca Security - Infrastructure as Code

[INFO] Unknown Property 

Details:
OpenAPI v3.0 specifications contain properties not recognized by the standard
schema, indicating potential typos, deprecated fields, or custom extensions.
Unknown properties may cause validation failures or unexpected API behavior.
Review and remove unrecognized fields or properly namespace custom extensions
using 'x-' prefix.

Recommendation:
The field 'x-tagGroups' is known in the openapi object
"name": "Contacts",
"tags": [
"Contacts",
Expand All @@ -4967,4 +5082,4 @@
"Followers"
]
}
}
}