OpenAPI_Spellchecker

A spellchecking tool and a word analyzer for OpenAPI files.

Introduction

OpenAPI_Spellchecker is a word analyzer. It seperates all the contents of an OpenAPI into individual words. The word list can be further refined by removing words that are all numbers, have numbers in them, and camel cased words. Camel cased words are those with capital letters in a position other than the first letter. Those are typically field or variable names. What's left are sorted and have duplicates removed. Misspelled words are identifed. That list is also automatically copied to the clipboard for pasting into other documents as wanted.

Prerequisites

• OpenAPI_Spellchecker runs under Windows only. The plans for a Mac version are uncertain.
• The OpenAPI file must be less than version 3.1.0. If this is a problem, in many cases, the OpenAPI files's version number can be changed to 3.0.3 safely.
• The OpenAPI file must be well-formed and conform to the OpenAPI specification.
• Files can be either JSON or YAML.
• For best results I recommend using a fully deferenced OpenAPI file. That is, a file with no $ref statements. In most cases $ref statements are accurately handled but due to OpenAPI coding differences, I can't assure accurate reporting.

Downloading OpenAPI_Spellchecker

To download OpenAPI_Spellchecker,

1. Navigate to: https://download-directory.github.io
2. Paste this URL into the text box: https://github.com/robert-delwood/OpenAPI_Spellchecker/tree/main/OpenAPI_Spellchecker/OpenAPI_Spellchecker_Project
3. Click Enter. This displays a save file dialog.
4. Navigate to the download location of your choice.
5. You muight want to change the download name to something like OpenAPI_Spellchecker.zip. This download application makes up it's own names.
6. Select Save. This saves the file to that location.
7. Double click OpenAPI_Spellchecker.zip, or whatever you just named it. This will unzip the file to the selected location. This will create a folder at the location named OpenAPI_Spellchecker. The extracted contents will be loaded into that folder. There are no other dependencies.

Running OpenAPI_Spellchecker

To run OpenAPI_Spellchecker,

1. Double click the application OpenAPI_Spellchecker.exe. It opens to the OpenAPI_Spellchecker window. By default, it is set to Show misspellings.
2. Select Open OpenAPI file. This shows the file open dialog. Navigate to, and then select, the target OpenAPI file. It may either JSON or YAML. Processing should be automatic.
3. Select Process file should it not process automatically when an OpenAPI file is first selected It may also be selected to force processing an additional time, if needed.

The View criterion may be changed. The View criterion determines the kind of word list to display. If so, select Process file again.

Processed word lists are automatically copied to the clipboard. Individual words may be copied to the clipboard by either double clicking the word, or selecting Copy selected word clipboard. Without any additional involvement with the application, you can paste the clipboard into another document. For example, this may be in Microsoft Word or as any text file.

View criterion

The following options are available. In each case, the list removes duplications and is sorted in ascending alphabetic order.

Show misspellings. This shows words that are considered to be misspellings misspellings. A misspelled word is one that does not appear in the dictonary file. It will also display words that are not techncially misspelled but rather custom words used in the application. This is the default selection.
Show all words. This shows all the words.
Show words with midfix numbers. This shows only words that have the letters and numbers.
Show words with numbers only. This shows words that are only numbers.
Show words with upper- and lower-case letters. This show words that have both upper- and lower-case letters other than as the first character. This typically includes field names. It excludes words that are only uppercase.
Show words with uppercase only. This shows words that are only uppercase. The intent is to show acronym-like words. In practice, it also shows words that people just like to see as uppercase.

Copy controls

The following controls influence the copying of text.

Copy complete list to clipboard. This copies the entire list to the clipboard. This list is automatically copied to the clipboard by default each time a different View criterion is selected. However, the clipboard may change after the list is initially run. This allows users to re-copy the list.
Copy selected word clipboard. this selects an individual word. Highlight the intended word and select this button.
Allow copy to clipboard. This check box controls copying to the clipboard.
If selected, lists or words will be copied to the clipboard according the behavior outline earlier.
If not selected, no list or word is copied to the clipboard.

Dictionary

To identify misspellings, a dictionary file is attached to the application. The file is included during the installation., It is in the same directory location as the application. It is named words.txt. This is a plain text file and is one word on each line.

You may choose to use another dictionary file, as long as it's plain text, in the same location as the application, and is named named words.txt. The application can run without a dictionary file. In that case, the misspelling option will be not available to select. All the other view crition options can still be selected.

Caveats

OpenAPI_Spellchecker is offered and used as is. While I did test it, you may find limitations and problems. Feel free to report any comments, questions, and concerns, including bugs, to me. My email isrobert@writeonce.org I will look into them.