Skip to content

Commit

Permalink
fix typo
Browse files Browse the repository at this point in the history
  • Loading branch information
agostof committed Apr 13, 2024
1 parent e306009 commit 44423d5
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ These redundant Pydantic models occur because the BrAPI OpenAPI spec files were

The V2.1 model was an attempt to automate a lot of the code-gen cleanup so future BrAPI spec updates could be easily integrated.

Josh L.S. (jdl232 at cornell.edu) tried to merge all the duplicates that were functionally identical via script. The script however missed quite a few instances of duplicate classes. The *auto-deduplication code* differentiated classes by adding a sequential numerical suffix e.g `ClassName1`, `ClassName2`, to the class names. The code may still have several objects where `ClassName#m` and `ClassName#n` are identical, but were separated as different classes by the *autogenerator*. The fix to this is to delete `ClassName#m` and replace its mentions with `ClassName#n`, which is what the [auto-deduplication tools](modelgen_utils/dedup_tools) in the v_2.1_autogen folder attempt to do automatically.
Josh L.S. (jdl232 at cornell.edu) tried to merge all the duplicates that were functionally identical via script. The script however missed quite a few instances of duplicate classes. The *auto-deduplication code* differentiated classes by adding a sequential numerical suffix to the class names e.g `ClassName1`, `ClassName2`. The code may still have several objects where `ClassName#m` and `ClassName#n` are identical, but were separated as different classes by the *autogenerator*. The fix to this is to delete `ClassName#m` and replace its mentions with `ClassName#n`, which is what the [auto-deduplication tools](modelgen_utils/dedup_tools) in the v_2.1_autogen folder attempt to do automatically.

There were also changes in how Pydantic models are specified when this work was underway. The models provided can be used as a start, but changes might be needed for your specific usecase.

0 comments on commit 44423d5

Please sign in to comment.