Skip to content

Commit

Permalink
This commit signifies a MAJOR reorganization of this project.
Browse files Browse the repository at this point in the history
Spectral proper and Stoplight.io's integration of it currrently have significant functional gaps in regards to supported
rules formats (.js vs .json vs .yml), abilities to split files, and use of remote (http) rulesets.

Due to this as well as our need to leverage both Stoplight.io AND Spectral separately the ruleset has been re-created to meet
the lowest common denominatior (Stoplight.io).

Overview of the changes are:

- Conversion and consolidation of rulesets into a single YAML file with spectral/stoplight default naming: .spectral.yml
- Above change rendered existing test suites invalid and have been removed. Replacements tests to be considered in the future.
- Current Testing now exists of linting a 'valid' OAS3.1 file against the ruleset.
- Dev Dependencies have been updated.
- npm test script has been updated to run spectral against the examples/valid folder

Note-worthy Section Rules Added:

- Document Structure:
	- Resource Objects
		- Attributes
		- Relationsihps
		- Related Resource Links
		- Resource Linkage
		- Resource Links
	- Compound Document
- Fetching Data
	- Fetching Resources
		- Responses
	- Fetching Relationships
	- Inclusion of Related Resources
	- Sparse Fieldsets
	- Sorting
	- Pagination
	- Filtering
- Creating/Updating/Deleting
	- Creating Resources
	- Updating Resources
	- Deleting Resources
  • Loading branch information
Jeff Marquez committed Jan 24, 2024
1 parent 33c432d commit 39a7132
Show file tree
Hide file tree
Showing 151 changed files with 2,880 additions and 68,941 deletions.
2 changes: 1 addition & 1 deletion .editorconfig
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@ end_of_line = lf
insert_final_newline = true
indent_style = space
indent_size = 2
quote_type = single
quote_type = double
309 changes: 0 additions & 309 deletions .eslintrc.yml

This file was deleted.

Loading

0 comments on commit 39a7132

Please sign in to comment.