Skip to content

Update AttachmentCreateRequest schema properties #57

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
ramiro51 wants to merge 1 commit into
base: v2
Choose a base branch
from
Open

Update AttachmentCreateRequest schema properties #57

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
72 changes: 32 additions & 40 deletions reference/rest-api.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -550,56 +550,48 @@
}
},
"AttachmentCreateRequest": {
"type": "object",
"required": [
"attachment"
],
"additionalProperties": false,
"properties": {
"attachment": {
"type": "object",
"required": [
"owners"
],
"additionalProperties": false,
"properties": {
Comment on lines 552 to +558
Copy link

Copilot AI Apr 17, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The indentation for AttachmentCreateRequest (e.g., the "type"/"required" lines) is inconsistent with surrounding schemas, which makes the OpenAPI file harder to maintain and produces noisy diffs. Please reformat this block to match the existing indentation pattern in components.schemas.

Copilot uses AI. Check for mistakes.
Copy link
Copy Markdown
Contributor

@chrisworkmode chrisworkmode Apr 17, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@copilot apply changes based on this feedback

Copy link
Copy Markdown
Contributor

@chrisworkmode chrisworkmode Apr 21, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ramiro51 it looks like copilot does not work here (maybe because it's a public repo?) in any case, can you please take a look at these comments and make changes as you see fit?

"owners": {
"type": "array",
Copy link

Copilot AI Apr 17, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

owners is required but the endpoint description says you must specify at least one owner. Add minItems: 1 to the owners array schema so the OpenAPI schema matches the documented/expected request validation.

Suggested change
"type": "array",
"type": "array",
"minItems": 1,

Copilot uses AI. Check for mistakes.
"description": "Array of owner objects for the attachment",
"items": {
"type": "object",
"required": [
"owners"
"type",
"id"
],
"properties": {
"owners": {
"type": "array",
"description": "Array of owner objects for the attachment",
"items": {
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"type": {
"type": "string",
"description": "Type of the owner (e.g., 'record', 'form')"
},
"id": {
"type": "string",
"description": "Identifier of the owner"
}
}
}
},
"name": {
"type": {
"type": "string",
"description": "Name of the attachment"
},
"file_size": {
"type": "integer",
"description": "Size of the file in bytes"
"description": "Type of the owner (e.g., 'record', 'form')"
},
"metadata": {
"type": "object",
"description": "Optional metadata for the attachment",
"additionalProperties": true
"id": {
"type": "string",
"description": "Identifier of the owner"
}
}
}
},
"name": {
"type": "string",
"description": "Name of the attachment"
},
"file_size": {
"type": "integer",
"description": "Size of the file in bytes"
},
"metadata": {
"type": "object",
"description": "Optional metadata for the attachment",
"additionalProperties": true
}
},
}
},
"AttachmentTrackRequest": {
"type": "object",
"required": [
Expand Down
Loading