Add summary and descriptions to Files and Dossiers endpoints - Githubissues

muchdogesec / stixify

Extract machine readable cyber threat intelligence from unstructured data (inc. PDFs, Word docs, and HTML pages)

https://www.stixify.com

Apache License 2.0

2 stars 0 forks source link

Add summary and descriptions to Files and Dossiers endpoints #8

Closed himynamesdave closed 1 month ago

himynamesdave commented 1 month ago

Files

`GET /api/v1/files/`

Summary: Search and retrieve a list of uploaded Files
Description: This endpoint allows you to search for Files you've uploaded. This endpoint is paticularly useful if you want to download the original File uploaded or find the Report object created for the uploaded File so you can retrieve the objects created for it.

`POST /api/v1/files/`

Upload a new File to be processed into STIX object
Description: Upload a file to be processed by Stixify. IMPORTANT: files cannot be modified once uploaded. If you need to reprocess a file, you must upload it again.

`GET /api/v1/files/:id`

Get a File by ID
This endpoint will return information for a specific File using its ID.

`DELETE /api/v1/files/:id`

Delete a File by ID
This endpoint will delete a File using its ID. BEWARE: this request will also delete all SROs and SDOs created for this file. SCOs will remain because they often have relationships to other objects.

Dossiers

`GET /api/v1/dossiers/`

Summary: Search and retrieve a list of created Dossiers
Description: This endpoint will return a list of all Dossiers created and information about them.

`POST /api/v1/dossiers/`

Create a New Dossier
This endpoint allows you create a Dossier you can use to group Reports together.

`PATCH /api/v1/dossiers/`

Update a Dossier
This endpoint allows you update a Dossier. Use this endpoint to add or remove reports from a Dossier

`GET /api/v1/dossiers/:id`

Get a Dossier by ID
This endpoint will return information for a specific Dossier using its ID.

`DELETE /api/v1/dossiers/:id`

Delete a Dossier by ID
This endpoint will delete a Dossier using its ID. This request will not affect any Report objects linked to it, except for removing any link to this Dossier from them.