DEV: Update API documentation to include file scanning info and error messages

[yaelberger-commits]

Update API documentation to include file scanning info and error messages

Description

As a Notify API user sending file attachments in an email, I need to be able to understand from the API documentation that my files will be automatically scanned for malware and that my emails will fail if a virus is detected, so that I can monitor my email failures and fix my corrupted files.

WHY are we building? We have implemented malicious content monitoring and scanning for file attachments with the API and we need to let users know about this new feature in our documentation

WHAT are we building? Content update to our API documentation for file attachments and error codes

VALUE created by our solution Senders are able to understand from the API documentation that their files will be automatically scanned for malware and that my emails will fail if a virus is detected, so that they can monitor their email failures and fix any corrupted files.

Acceptance Criteria** (Definition of done)

Given an API user intends to send file attachments with an email using the API, when they read the API documentation, then they know their file attachments will be scanned automatically for malware and they understand what error codes will appear if their file has a virus.

• [ ] Generate appropriate log messages so that executions of this feature can be tracked

• [ ] Can misuse of this feature cause harm? If yes, create an alert

• [ ] @YedidaZalik does a content review before this gets sent to translation

• A11y

• Bilingualism

• Privacy considerations

• Security controls in place

• Measuring success and metrics

QA Steps

• [ ] Tested in both EN and FR in staging and production

[yaelberger-commits]

Hey team! Please add your planning poker estimate with Zenhub @YedidaZalik @andrewleith

[YedidaZalik]

@EliseKa created this list of content that could be added in the formatting guide or API documentation:https://docs.google.com/document/d/1r9z4XWHjyzCakhMewJuj2ZfCuwcdlP_aD6lvWqBeHHc/edit#