open-feature
/
cli
mirror of https://github.com/open-feature/cli.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs: Add initial flag manifest schema (#9) 

## This PR
Defines a new format for a flag manifest input to the codegen tool, as
defined in a JSON schema

### Related Issues

Fixes https://github.com/open-feature/codegen/issues/1

### Notes
Is based on
https://docs.google.com/document/d/19GQpSNcLnDEbzJRL6FpzKHFEQWVGNrgNK25lC4-JuE8/edit#heading=h.f1glu5dk43k9

---------

Signed-off-by: Florin-Mihai Anghel <fanghel@google.com>
This commit is contained in:
Florin-Mihai Anghel 2024-08-27 16:07:46 +02:00 committed by GitHub
parent 478123831b
commit 070adda00d
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 122 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

122
docs/schema/v0/flag_manifest.json Normal file
View File

@ -0,0 +1,122 @@
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Flag Manifest",
"description": "Describes a configuration of OpenFeature flags, including info such as their types and default values.",
"type": "object",
"properties": {
"flags": {
"description": "Object containing the flags in the config",
"type": "object",
"patternProperties": {
"^.{1,}$": {
"description": "The definition of one flag",
"$ref": "#/$defs/flag"
}
},
"additionalProperties": false
}
},
"required": ["flags"],
"$defs": {
"flag": {
"oneOf": [
{
"$ref": "#/$defs/booleanType"
},
{
"$ref": "#/$defs/stringType"
},
{
"$ref": "#/$defs/integerType"
},
{
"$ref": "#/$defs/numberType"
},
{
"$ref": "#/$defs/objectType"
}
],
"required": ["flag_type", "default_value"]
},
"booleanType": {
"type": "object",
"properties": {
"flag_type": {
"type": "string",
"enum": ["boolean"]
},
"default_value": {
"type": "boolean"
},
"description": {
"type": "string"
}
},
"additionalProperties": false
},
"stringType": {
"type": "object",
"properties": {
"flag_type": {
"type": "string",
"enum": ["string"]
},
"default_value": {
"type": "string"
},
"description": {
"type": "string"
}
},
"additionalProperties": false
},
"integerType": {
"type": "object",
"properties": {
"flag_type": {
"type": "string",
"enum": ["integer"]
},
"default_value": {
"type": "integer"
},
"description": {
"type": "string"
}
},
"additionalProperties": false
},
"numberType": {
"type": "object",
"properties": {
"flag_type": {
"type": "string",
"enum": ["number"]
},
"default_value": {
"type": "number"
},
"description": {
"type": "string"
}
},
"additionalProperties": false
},
"objectType": {
"type": "object",
"properties": {
"flag_type": {
"type": "string",
"enum": ["object"]
},
"default_value": {
"type": "object"
},
"description": {
"type": "string"
}
},
"additionalProperties": false
}
}
}