Skip to content
This repository has been archived by the owner on Dec 25, 2024. It is now read-only.

Replace misspell with codespell #3

Merged
merged 1 commit into from
Feb 27, 2024
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
2 changes: 2 additions & 0 deletions .codespellrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
[codespell]
skip = .git
21 changes: 21 additions & 0 deletions .github/workflows/codespell.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
name: Codespell

on:
push:
branches: [main]
pull_request:
branches: [main]

permissions:
contents: read

jobs:
codespell:
name: Check for spelling errors
runs-on: ubuntu-latest

steps:
- name: Checkout
uses: actions/checkout@v4
- name: Codespell
uses: codespell-project/actions-codespell@v2
20 changes: 0 additions & 20 deletions .github/workflows/misspell.yml

This file was deleted.

4 changes: 2 additions & 2 deletions specs/openapi.json
Original file line number Diff line number Diff line change
Expand Up @@ -6610,7 +6610,7 @@
"Files"
],
"summary": "Redact the contents of a file.",
"description": "Redact a file to remove all collected information from Falu.\nThis will redact the File and all objects related to it,\nincluding Events, request logs, etc.\n\nRedacting a file is also done when related objects such as identity verifications are redacted.\nAs such, you do not need to redact each file created in the process.\nRedacting a file is useful if you uploaded a file that you have not used and have\nno intension of doing so, such as one that was uploaded by mistake.\n\nWhen the redaction process completes a `file.redacted` event will be emitted.\n\nRedaction is irreversible. Redacted objects are still accessible in the API,\nbut all the fields that contain personal data will be replaced by the string\n`[redacted]` or a similar placeholder. The metadata field will also be erased.\nRedacted objects cannot be updated or used for any purpose.",
"description": "Redact a file to remove all collected information from Falu.\nThis will redact the File and all objects related to it,\nincluding Events, request logs, etc.\n\nRedacting a file is also done when related objects such as identity verifications are redacted.\nAs such, you do not need to redact each file created in the process.\nRedacting a file is useful if you uploaded a file that you have not used and have\nno intention of doing so, such as one that was uploaded by mistake.\n\nWhen the redaction process completes a `file.redacted` event will be emitted.\n\nRedaction is irreversible. Redacted objects are still accessible in the API,\nbut all the fields that contain personal data will be replaced by the string\n`[redacted]` or a similar placeholder. The metadata field will also be erased.\nRedacted objects cannot be updated or used for any purpose.",
"operationId": "files-redact",
"parameters": [
{
Expand Down Expand Up @@ -15272,7 +15272,7 @@
"message.sent": "Occurs whenever a message is sent.",
"message.failed": "Occurs whenever a message fails to send.",
"message.delivered": "Occurs whenever a message is delivered successfully.",
"message.read": "Occurs whenever a message is read by the recepient.",
"message.read": "Occurs whenever a message is read by the recipient.",
"message.cancelled": "Occurs whenever the message has been cancelled and future\nupdate attempts have been disabled.",
"message.redacted": "Occurs whenever a message has been redacted.",
"message.received": "Occurs whenever an incoming message is received.",
Expand Down
4 changes: 2 additions & 2 deletions specs/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4380,7 +4380,7 @@ paths:
Redacting a file is also done when related objects such as identity verifications are redacted.
As such, you do not need to redact each file created in the process.
Redacting a file is useful if you uploaded a file that you have not used and have
no intension of doing so, such as one that was uploaded by mistake.
no intention of doing so, such as one that was uploaded by mistake.

When the redaction process completes a `file.redacted` event will be emitted.

Expand Down Expand Up @@ -10437,7 +10437,7 @@ components:
message.sent: Occurs whenever a message is sent.
message.failed: Occurs whenever a message fails to send.
message.delivered: Occurs whenever a message is delivered successfully.
message.read: Occurs whenever a message is read by the recepient.
message.read: Occurs whenever a message is read by the recipient.
message.cancelled: |-
Occurs whenever the message has been cancelled and future
update attempts have been disabled.
Expand Down