Skip to content
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.

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

Add schema for data extension property proposal responses #119

Merged
merged 2 commits into from
Mar 27, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"limit": 5,
"type": "DifferentiatedPerson"
}
43 changes: 43 additions & 0 deletions draft/schemas/data-extension-property-proposal.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
{
"$schema": "http://json-schema.org/schema#",
"$id": "https://reconciliation-api.github.io/specs/draft/schemas/data-extension-property-proposal.json",
"type": "object",
"description": "This schema can be used to validate the JSON response of a property proposal endpoint (part of the data extension feature).",
"properties": {
"properties": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Identifier of the suggested property"
},
"name": {
"type": "string",
"description": "Name of the suggested property"
},
"description": {
"type": "string",
"description": "An optional description which can be provided to disambiguate namesakes, providing more context."
}
},
"required": [
"id",
"name"
]
}
},
"type": {
"type": "string",
"description": "The identifier of the type for which those properties are suggested"
},
"limit": {
"type": "number",
"description": "The maximum number of results requested."
}
},
"required": [
"properties"
]
}