Skip to content

Upgrade to SmartAPI schema extension #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: OpenAPI.next
Choose a base branch
from
Open

Upgrade to SmartAPI schema extension #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2abcfae
adding smartapi extension upgrade
NikkiBytes Aug 22, 2024
633bb4b
added README with summarized upgrades
NikkiBytes Aug 22, 2024
5a1ed4e
removed extra brackets, working file added
NikkiBytes Aug 22, 2024
9cd9ff8
update of location of files
NikkiBytes Aug 22, 2024
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
24 changes: 24 additions & 0 deletions schemas/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
### **Summary of Key Upgrades**
Date: 08/22/2024
Original version located: `v3.0/smartapi_schema.json`

1. **Schema Version**
- **Upgraded** from JSON Schema Draft-04 to Draft 2020-12 for better compatibility with modern standards.

2. **Definitions Location**
- **Changed** from `#/definitions/...` to `#/$defs/...` to align with the latest JSON Schema conventions.

3. **Contact Roles**
- **Added** a new role `"document creator"` to better document contributors.

4. **Server Maturity Levels**
- **Added** `"testing"` as a new maturity level for better server environment categorization.

5. **Paths Object Flexibility**
- **Removed** the requirement for the `summary` field, providing more flexibility in operation documentation.

6. **Response Value Type Validation**
- **Enhanced** validation logic to allow flexibility with `path`/`x-path` and `valueType`/`x-valueType`.

7. **Improved Flexibility**
- **Introduced** more flexible validation using `allOf` and `anyOf` constructs, allowing for adaptable data structures.
Loading