Skip to content

Added AWS provider to features file schema and regex patterns to verify validity of strings #18

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.

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

Merged
merged 6 commits into from
Apr 17, 2025
Merged
Changes from all commits
Commits
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
47 changes: 33 additions & 14 deletions .github/features_schema.json
Original file line number Diff line number Diff line change
@@ -1,45 +1,62 @@
{
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"required": ["service", "name", "features"],
"required": ["service", "name", "aws_provider", "features", "emulation_level"],
"properties": {
"service": {
"type": "string",
"description": "Service's abbreviation in AWS"
"pattern": "^[A-Za-z0-9]+$",
"description": "Short service name"
},
"name": {
"type": "string",
"pattern": "^[A-Z][^.\n]*$",
"description": "The display name of the service from AWS"
},
"aws_provider": {
"type": "object",
"required": ["api"],
"properties": {
"api": {
"type": "string",
"pattern": "^[a-z0-9-_]+$",
"description": "Name of AWS API provider or method name"
},
"name": {
"type": "string",
"default": "default",
"pattern": "^[a-z0-9-_]+$",
"description": "Name of AWS provider implementation"
}
},
"additionalProperties": false
},
"emulation_level": {
"type": "string",
"enum": ["CRUD", "emulated"],
"description": "The level of emulation support on the service level"
},
"localstack_page": {
"type": "string",
"format": "uri",
"description": "URL to the LocalStack user guide documentation"
},
"features": {
"type": "array",
"description": "List of features supported by the service",
"items": {
"type": "object",
"required": ["name", "description", "documentation_page", "status"],
"required": ["name", "description", "aws_documentation_url", "status"],
"properties": {
"name": {
"type": "string",
"description": "Name of the feature"
"pattern": "^[A-Z][^.\n]*$",
"description": "Short name of the feature"
},
"description": {
"type": "string",
"pattern": "^[A-Z][^.\n]*$",
"description": "Description of the feature"
},
"documentation_page": {
"aws_documentation_url": {
"type": "string",
"format": "uri",
"description": "URL to the AWS feature's documentation"
"pattern": "^https://(docs\\.)?aws\\.amazon\\.com(/[^\\s]*)?$",
"description": "Link to the AWS feature documentation"
},
"status": {
"type": "string",
Expand All @@ -49,14 +66,16 @@
"api_methods": {
"type": "array",
"items": {
"type": "string"
"type": "string",
"pattern": "^([A-Z][a-z0-9]*)+$"
},
"description": "List of API methods associated with the feature"
},
"limitations": {
"type": "array",
"items": {
"type": "string"
"type": "string",
"pattern": "^[A-Z][^.\n]*$"
},
"description": "List of known limitations for the feature"
},
Expand Down