Skip to content

Commit

Permalink
Merge pull request #15 from ekoindia/dev
Browse files Browse the repository at this point in the history
Release from Dev
  • Loading branch information
manustays authored Dec 15, 2024
2 parents 1105721 + fbb67f8 commit 955416d
Show file tree
Hide file tree
Showing 52 changed files with 3,527 additions and 3,008 deletions.
34 changes: 34 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,37 @@
# Dir for bundles
dist
node_modules

### VisualStudioCode ###
.vscode/*
!.vscode/settings.json
!.vscode/tasks.json
!.vscode/launch.json
!.vscode/extensions.json
.vscode/settings.json

### System Files ###
*.DS_Store

# Windows thumbnail cache files
Thumbs.db
ehthumbs.db
ehthumbs_vista.db

# Folder config file
Desktop.ini

# Recycle Bin used on file shares
$RECYCLE.BIN/

# Thumbnails
._*

# Files that might appear in the root of a volume
.DocumentRevisions-V100
.fseventsd
.Spotlight-V100
.TemporaryItems
.Trashes
.VolumeIcon.icns
.com.apple.timemachine.donotpresent
127 changes: 115 additions & 12 deletions .redocly.yaml
Original file line number Diff line number Diff line change
@@ -1,12 +1,115 @@
# See https://docs.redoc.ly/cli/configuration/ for more information.
apiDefinitions:
main: openapi/openapi.yaml
lint:
rules:
no-unused-schemas: warning
referenceDocs:
htmlTemplate: ./docs/auto/index.html
theme:
colors:
primary:
main: "#32329f"
# See https://redocly.com/docs/cli/configuration/ for more information.
# See https://github.com/Redocly/redocly-cli-cookbook for examples.

extends:
- recommended

apis:
main:
root: openapi/openapi.yaml

theme:
openapi:
htmlTemplate: ./docs/auto/index.html
theme:
colors:
primary:
main: "#32329f"
generateCodeSamples:
languages: # Array of language config objects; indicates in which languages to generate code samples.
- lang: curl
- lang: Node.js
- lang: JavaScript
- lang: PHP
- lang: Python
- lang: Java
- lang: C#
- lang: Go

rules:
spec-strict-refs: warn

rule/post-should-define-requestBody:
severity: error
message: '"POST" SHOULD define a "requestBody" schema unless using an "actions" pattern'
subject:
type: Operation
where:
- subject:
type: PathItem
# Here you can define your own URI pattern to ignore if providing a requestBody is not required.
# The negation happens in this portion of the regex `(?<!/actions)`.
# The regex takes the entire URI pattern string and then uses a "negative lookbehind" from the end of the string to find the pattern to be negated.
matchParentKeys: /^([\w-\{\}/.](?<!/actions))*$/
assertions:
defined: true
- subject:
type: Operation
filterInParentKeys:
- post
assertions:
disallowed:
- deprecated
assertions:
required:
- requestBody

rule/get-should-not-define-requestBody:
severity: error
message: '"GET" SHOULD NOT define a "requestBody" schema'
subject:
type: Operation
filterInParentKeys:
- get
assertions:
disallowed:
- requestBody

rule/info-description:
subject:
type: Info
property: description
assertions:
defined: true

rule/no-script-tags-in-markdown:
subject:
type: any
property: description
assertions:
notPattern: '<script'
severity: warn
message: Markdown descriptions should not contain script tags.

# rule/string-schemas-length-defined:
# severity: warn
# subject:
# type: Schema
# where:
# - subject:
# type: Schema
# property: type
# assertions:
# const: string
# assertions:
# requireAny:
# - minLength
# - maxLength
# - enum
# mutuallyRequired:
# - minLength
# - maxLength

rule/json-schema-string-misconfiguration:
subject:
type: Schema
where:
- subject:
type: Schema
property: type
assertions:
const: string
assertions:
disallowed:
- minimum
- maximum
Loading

0 comments on commit 955416d

Please sign in to comment.