sillsdev / sillsdev/languageforge-lexbox
verification test openapi schema for lexbox public api
Nobody has claimed this yet.
- Dominant language
- C#
- Stars
- 9
- Forks
- 8
- Avg merge
- 2d 13h
- Merged PRs (30d)
- 49
Description
Describe the feature
We don't want our api surface area to change without us knowing either on purpose or accidentally. A good way to handle that would be with a verification test (examples in DataModelSnapshotTests) of our openapi schema. I'm not quite sure how to get the schema in a test but I don't think it should be difficult.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by examining the DataModelSnapshotTests examples and the existing OpenAPI schema generation used by the public API. Determine how the schema can be obtained in a test, then add verification coverage that detects unintended schema changes and confirms the expected schema remains stable.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- csharp, openapi
- Domain
- api, testing
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100