Datasets:
dataunitylab
/
json-schema-descriptions

Dataset card Data Studio Files Community
1
schema
stringclasses
471 values
key
stringlengths
0
203
description
stringlengths
0
4.37k
object
stringlengths
2
322k
cv.schema.json
Name
Name of the organization. If set can not be blank
{"type": "string"}
cv.schema.json
Type
Organization's type (NGO, educational, government, etc.). If set can not be blank
{}
cv.schema.json
Industry
Industry (financial, industry, etc.). If set can not be blank
{}
cv.schema.json
NullableOrganization
Organization data (can be used for companies, educational institutions, etc.)
{"type": ["object", "null"], "required": ["Name"], "additionalProperties": false, "properties": {"Name": {"type": "string"}, "Website": {}, "Type": {}, "Industry": {}}}
cv.schema.json
Name
Name of the organization. If set can not be blank
{"type": "string"}
cv.schema.json
Type
Organization's type (NGO, educational, government, etc.). If set can not be blank
{}
cv.schema.json
Industry
Industry (financial, industry, etc.). If set can not be blank
{}
cv.schema.json
Company
Permanent role company. If null, it means this is a contractor experience
{}
cv.schema.json
Title
Course title. Can not be blank
{"type": "string"}
cv.schema.json
From
Start date of the course. It must be a date before the end date
{}
cv.schema.json
To
End date of the course. Should be set to a date before today
{}
cv.schema.json
Website
URL with more information about the course. The URL must return a success code
{}
cv.schema.json
Area
Course subject. If set, it cannot be blank
{}
cv.schema.json
Summary
Brief description of the course. Blank values other than 'null' aren't allowed
{}
cv.schema.json
Hours
Number of effective hours of this course. If set, should be greater than zero
{}
cv.schema.json
Achievement
Professional achievement. Achievement accomplished at a given date. Publications must be owned by external parties in order to be an achievement, posts on social networks or personal blogs are listed in other CV sections
{"type": "object", "required": ["Type", "Title", "Date"], "additionalProperties": false, "properties": {"Type": {"type": "string", "enum": ["certification", "award", "publication", "presentation", "conference", "workshop", "other"]}, "Title": {"type": "string"}, "Date": {}, "Website": {}, "Summary": {}, "Issuer": {}}}
cv.schema.json
Title
Descriptive title of the achievement. Cannot be blank
{"type": "string"}
cv.schema.json
Date
Data in which the achievement was accomplished. Cannot be after today
{}
cv.schema.json
Website
Link with further information of the achievement, I.e.: the URL of a publication. The URL must exist and be readable
{}
cv.schema.json
Summary
Detailed description of the achievement. It cannot be blank
{}
cv.schema.json
Full Name
Referrer's name. Can not be blank
{"type": "string"}
cv.schema.json
Summary
Reference details in plain text. Can not be blank
{"type": "string"}
cv.schema.json
Cv
CV data grouped by topics. Most of the fields are optional. When the model is rendered, the fields are passed to the template context with the names in camel case. Read only properties are meant only for use in templates, and cannot be defined in the document
{"type": "object", "additionalProperties": false, "properties": {"$schema": {"type": "string", "format": "URI"}, "Job Status": {"type": ["null", "string"], "enum": ["active search", "open to challenges", "not moving"]}, "Locale": {}, "Last Update": {}, "Resources": {"type": "array", "uniqueItems": true, "items": {}}, "Templates": {"type": "array", "uniqueItems": true, "items": {}}, "Variables": {"type": "object"}, "Personal": {}, "Residence": {}, "Contact": {"type": "array", "uniqueItems": true, "items": {}}, "Target Job": {}, "Bio": {}, "Titles": {"type": "array", "uniqueItems": true, "items": {"type": "string"}}, "Labels": {"type": "array", "uniqueItems": true, "items": {"type": "string"}}, "Goals": {"type": "array", "uniqueItems": true, "items": {"type": "string"}}, "Top Skills": {"type": "array", "uniqueItems": true, "items": {"type": "string"}}, "Links": {"type": "array", "uniqueItems": true, "items": {}}, "Languages": {"type": "array", "uniqueItems": true, "items": {}}, "Personal Projects": {"type": "array", "items": {}}, "Volunteering": {"type": "array", "items": {}}, "Experience": {"type": "array", "items": {}}, "Education": {"type": "array", "items": {}}, "Courses": {"type": "array", "items": {}}, "Achievements": {"type": "array", "items": {}}, "References": {"type": "array", "items": {}}, "Technical Skills": {"type": "array", "items": {}}, "Common Skills": {"type": "array", "items": {}}, "Other Facts": {"type": "array", "uniqueItems": true, "items": {"type": "string"}}}}
cv.schema.json
$schema
Used to deal with different versions. It also eases the use on some editors
{"type": "string", "format": "URI"}
cv.schema.json
Locale
Locale representing the CV's content. If not set, it will be `en`
{}
cv.schema.json
Resources
List of resources to be included in this CV. Allows CV modularization. Resources' content will be overwritten with the CV document content
{"type": "array", "uniqueItems": true, "items": {}}
cv.schema.json
Templates
Templates used to render this CV. Templates for different media types are supported using the template extension to select the appropriate one
{"type": "array", "uniqueItems": true, "items": {}}
cv.schema.json
Variables
Configuration added to the context when the CV is rendered. Map keys must be in camel case
{"type": "object"}
cv.schema.json
Goals
Professional goals. It cannot contain any blank item
{"type": "array", "uniqueItems": true, "items": {"type": "string"}}
strmprivacy.api.entities.v1.BatchJob.json
strmprivacy.api.entities.v1.BatchJob
******************************** Batch Jobs Currently we only support: - CSV as DataFormat type - a clean database for every batch job - CSV files with a header row, because the header is needed to get the field names *******************************
{"type": "object", "properties": {"consent": {}, "derivedData": {}, "encryptedData": {}, "encryption": {}, "encryptionKeysData": {}, "eventContractRef": {}, "policyId": {}, "ref": {}, "sourceData": {}, "states": {}}, "patternProperties": {"^derived_data$": {}, "^encrypted_data$": {}, "^encryption_keys_data$": {}, "^event_contract_ref$": {}, "^policy_id$": {}, "^source_data$": {}}, "additionalProperties": {}, "definitions": {"consent": {"oneOf": [{}, {"type": "null"}], "default": {}}, "derived_data": {"oneOf": [{"type": "array", "items": {"default": {}}}, {"type": "null"}], "default": [{}]}, "encrypted_data": {"oneOf": [{}, {"type": "null"}], "default": {}}, "encryption": {"oneOf": [{}, {"type": "null"}], "default": {}}, "encryption_keys_data": {"oneOf": [{}, {"type": "null"}], "default": {}}, "event_contract_ref": {"oneOf": [{}, {"type": "null"}], "default": {}}, "policy_id": {"oneOf": [{"type": "string"}, {"type": "null"}], "default": ""}, "ref": {"oneOf": [{}, {"type": "null"}], "default": {}}, "source_data": {"oneOf": [{}, {"type": "null"}], "default": {}}, "states": {"oneOf": [{"type": "array", "items": {"default": {}}}, {"type": "null"}], "default": [{}]}}}
strmprivacy.api.entities.v1.BatchJob.json
id
the UUIDv4 of the job, generated upon creation
{"oneOf": [{"type": "string"}, {"type": "null"}], "default": ""}
strmprivacy.api.entities.v1.BatchJob.json
project_id
the UUIDv4 of the STRM Privacy project
{"oneOf": [{"type": "string"}, {"type": "null"}], "default": ""}
strmprivacy.api.entities.v1.BatchJob.json
handle
constraint: handle should already exist
{"oneOf": [{"type": "string"}, {"type": "null"}], "default": ""}
strmprivacy.api.entities.v1.BatchJob.json
name
constraints: generic name constraint, unique within handle
{"oneOf": [{"type": "string"}, {"type": "null"}], "default": ""}
strmprivacy.api.entities.v1.BatchJob.json
version
constraints: semantic version, e.g. 1.12.3
{"oneOf": [{"type": "string"}, {"type": "null"}], "default": ""}
strmprivacy.api.entities.v1.BatchJob.json
strmprivacy.api.entities.v1.ConsentLevelType
Consent level is meant to interpret the consent-levels of an event for decryption purposes only. Cumulative means that the highest consent-level in an event must be greater than or equal to the single requested level for the decrypted stream. Granular means that the set of consent-levels in an event must enclose the set of requested event levels for the decrypted stream.
{"enum": ["CONSENT_LEVEL_TYPE_UNSPECIFIED", 0, "CUMULATIVE", 1, "GRANULAR", 2], "markdownEnumDescriptions": ["(or 0) ", "(or \"CONSENT_LEVEL_TYPE_UNSPECIFIED\") ", "(or 1) ", "(or \"CUMULATIVE\") ", "(or 2) ", "(or \"GRANULAR\") "]}
strmprivacy.api.entities.v1.BatchJob.json
file_name
(-- api-linter: core::0122::name-suffix=disabled aip.dev/not-precedent: We think file_name is a better name. --)
{"oneOf": [{"type": "string"}, {"type": "null"}], "default": ""}
strmprivacy.api.entities.v1.BatchJob.json
path_prefix
If omitted, files are read from the root of the bucket.
{"oneOf": [{"type": "string"}, {"type": "null"}], "default": ""}
strmprivacy.api.entities.v1.BatchJob.json
field_patterns
map of event-contract-ref vs field patterns constraints: data-contract-refs should be existing data contracts field_patterns should be valid values (checked by events-core) the field_patterns list should have no duplicates.
{"oneOf": [{"type": "object", "additionalProperties": {"oneOf": [{}, {"type": "null"}], "default": {}}}, {"type": "null"}], "default": {}}
strmprivacy.api.entities.v1.BatchJob.json
hash_type
Default Murmurhash3 if empty
{"oneOf": [{"type": "string"}, {"type": "null"}], "default": ""}
strmprivacy.api.entities.v1.BatchJob.json
seed
hashing seed
{"oneOf": [{"type": "string"}, {"type": "null"}], "default": ""}
strmprivacy.api.entities.v1.BatchJob.json
field
generic field name
{"oneOf": [{"type": "string"}, {"type": "null"}], "default": ""}
strmprivacy.api.entities.v1.BatchJob.json
format
Java Time Format template, see https://docs.oracle.com/javase/8/docs/api/java/time/format/DateTimeFormatter.html
{"oneOf": [{"type": "string"}, {"type": "null"}], "default": ""}
strmprivacy.api.entities.v1.BatchJob.json
google.type.TimeZone
Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones).
{"type": "object", "properties": {"id": {}, "version": {}}, "additionalProperties": {}, "definitions": {"id": {"oneOf": [{"type": "string"}, {"type": "null"}], "default": ""}, "version": {"oneOf": [{"type": "string"}, {"type": "null"}], "default": ""}}}
strmprivacy.api.entities.v1.BatchJob.json
id
IANA Time Zone Database time zone, e.g. "America/New_York".
{"oneOf": [{"type": "string"}, {"type": "null"}], "default": ""}
strmprivacy.api.entities.v1.BatchJob.json
version
Optional. IANA Time Zone Database version number, e.g. "2019a".
{"oneOf": [{"type": "string"}, {"type": "null"}], "default": ""}
portman-config-schema.json
Portman by Apideck allows you to port your OpenApi Spec to a Postman Collection, inject a powerful test suite, and run your tests with Newman. Details about all configuration options can be found at http://getportman.com.
{"$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": {}, "properties": {"assignVariables": {"items": {"additionalProperties": false, "properties": {"collectionVariables": {"items": {"additionalProperties": false, "properties": {"name": {"type": "string"}, "requestBodyProp": {"type": "string"}, "responseBodyProp": {"type": "string"}, "responseHeaderProp": {"type": "string"}, "value": {}}, "type": "object"}, "type": "array"}, "excludeForOperations": {"items": {"type": "string"}, "type": "array"}, "openApiOperation": {"type": "string"}, "openApiOperationId": {"type": "string"}, "openApiOperationIds": {"items": {"type": "string"}, "type": "array"}}, "required": ["collectionVariables"], "type": "object"}, "type": "array"}, "globals": {"additionalProperties": false, "properties": {"collectionPreRequestScripts": {"items": {"type": "string"}, "type": "array"}, "collectionTestScripts": {"items": {"type": "string"}, "type": "array"}, "keyValueReplacements": {"additionalProperties": {}, "type": "object"}, "orderOfOperations": {"items": {"type": "string"}, "type": "array"}, "portmanReplacements": {"items": {"additionalProperties": false, "properties": {"replaceWith": {"type": "string"}, "searchFor": {"type": "string"}}, "required": ["searchFor", "replaceWith"], "type": "object"}, "type": "array"}, "rawReplacements": {"items": {"additionalProperties": false, "properties": {"replaceWith": {"type": "string"}, "searchFor": {"type": "string"}}, "required": ["searchFor", "replaceWith"], "type": "object"}, "type": "array"}, "securityOverwrites": {"additionalProperties": false, "properties": {"apiKey": {"additionalProperties": false, "properties": {"in": {"type": "string"}, "key": {"type": "string"}, "value": {"type": "string"}}, "required": ["value"], "type": "object"}, "awsv4": {"items": {"additionalProperties": false, "properties": {"key": {"type": "string"}, "type": {"type": "string"}, "value": {}}, "required": ["key"], "type": "object"}, "type": "array"}, "basic": {"additionalProperties": false, "properties": {"password": {"type": "string"}, "username": {"type": "string"}}, "required": ["username", "password"], "type": "object"}, "bearer": {"additionalProperties": false, "properties": {"token": {"type": "string"}}, "required": ["token"], "type": "object"}, "digest": {"items": {"additionalProperties": false, "properties": {"key": {"type": "string"}, "type": {"type": "string"}, "value": {}}, "required": ["key"], "type": "object"}, "type": "array"}, "edgegrid": {"items": {"additionalProperties": false, "properties": {"key": {"type": "string"}, "type": {"type": "string"}, "value": {}}, "required": ["key"], "type": "object"}, "type": "array"}, "hawk": {"items": {"additionalProperties": false, "properties": {"key": {"type": "string"}, "type": {"type": "string"}, "value": {}}, "required": ["key"], "type": "object"}, "type": "array"}, "ntlm": {"items": {"additionalProperties": false, "properties": {"key": {"type": "string"}, "type": {"type": "string"}, "value": {}}, "required": ["key"], "type": "object"}, "type": "array"}, "oauth1": {"items": {"additionalProperties": false, "properties": {"key": {"type": "string"}, "type": {"type": "string"}, "value": {}}, "required": ["key"], "type": "object"}, "type": "array"}, "oauth2": {"items": {"additionalProperties": false, "properties": {"key": {"type": "string"}, "type": {"type": "string"}, "value": {}}, "required": ["key"], "type": "object"}, "type": "array"}, "other": {"additionalProperties": {"anyOf": [{}, {"items": {}, "type": "array"}]}, "properties": {"type": {"type": "string"}}, "required": ["type"], "type": "object"}}, "type": "object"}, "stripResponseExamples": {"type": "boolean"}, "valueReplacements": {"additionalProperties": {}, "type": "object"}}, "type": "object"}, "operationPreRequestScripts": {"items": {"additionalProperties": false, "properties": {"excludeForOperations": {"items": {"type": "string"}, "type": "array"}, "openApiOperation": {"type": "string"}, "openApiOperationId": {"type": "string"}, "openApiOperationIds": {"items": {"type": "string"}, "type": "array"}, "scripts": {"items": {"type": "string"}, "type": "array"}}, "required": ["scripts"], "type": "object"}, "type": "array"}, "overwrites": {"items": {"additionalProperties": false, "properties": {"excludeForOperations": {"items": {"type": "string"}, "type": "array"}, "openApiOperation": {"type": "string"}, "openApiOperationId": {"type": "string"}, "openApiOperationIds": {"items": {"type": "string"}, "type": "array"}, "overwriteRequestBaseUrl": {"additionalProperties": false, "properties": {"overwrite": {"type": "boolean"}, "remove": {"type": "boolean"}, "value": {"type": "string"}}, "type": "object"}, "overwriteRequestBody": {"items": {"additionalProperties": false, "properties": {"disable": {"type": "boolean"}, "insert": {"type": "boolean"}, "key": {"type": "string"}, "overwrite": {"type": "boolean"}, "remove": {"type": "boolean"}, "value": {}}, "required": ["key"], "type": "object"}, "type": "array"}, "overwriteRequestHeaders": {"items": {"additionalProperties": false, "properties": {"disable": {"type": "boolean"}, "insert": {"type": "boolean"}, "key": {"type": "string"}, "overwrite": {"type": "boolean"}, "remove": {"type": "boolean"}, "value": {"type": "string"}}, "required": ["key"], "type": "object"}, "type": "array"}, "overwriteRequestPathIdVariables": {"items": {"additionalProperties": false, "properties": {"enabled": {"type": "boolean"}}, "required": ["enabled"], "type": "object"}, "type": "array"}, "overwriteRequestPathVariables": {"items": {"additionalProperties": false, "properties": {"disable": {"type": "boolean"}, "insert": {"type": "boolean"}, "key": {"type": "string"}, "overwrite": {"type": "boolean"}, "remove": {"type": "boolean"}, "value": {"type": "string"}}, "required": ["key"], "type": "object"}, "type": "array"}, "overwriteRequestQueryParams": {"items": {"additionalProperties": false, "properties": {"disable": {"type": "boolean"}, "insert": {"type": "boolean"}, "key": {"type": "string"}, "overwrite": {"type": "boolean"}, "remove": {"type": "boolean"}, "value": {"type": "string"}}, "required": ["key"], "type": "object"}, "type": "array"}, "overwriteRequestSecurity": {"additionalProperties": false, "properties": {"apiKey": {"additionalProperties": false, "properties": {"in": {"type": "string"}, "key": {"type": "string"}, "value": {"type": "string"}}, "required": ["value"], "type": "object"}, "awsv4": {"items": {"additionalProperties": false, "properties": {"key": {"type": "string"}, "type": {"type": "string"}, "value": {}}, "required": ["key"], "type": "object"}, "type": "array"}, "basic": {"additionalProperties": false, "properties": {"password": {"type": "string"}, "username": {"type": "string"}}, "required": ["username", "password"], "type": "object"}, "bearer": {"additionalProperties": false, "properties": {"token": {"type": "string"}}, "required": ["token"], "type": "object"}, "digest": {"items": {"additionalProperties": false, "properties": {"key": {"type": "string"}, "type": {"type": "string"}, "value": {}}, "required": ["key"], "type": "object"}, "type": "array"}, "edgegrid": {"items": {"additionalProperties": false, "properties": {"key": {"type": "string"}, "type": {"type": "string"}, "value": {}}, "required": ["key"], "type": "object"}, "type": "array"}, "hawk": {"items": {"additionalProperties": false, "properties": {"key": {"type": "string"}, "type": {"type": "string"}, "value": {}}, "required": ["key"], "type": "object"}, "type": "array"}, "ntlm": {"items": {"additionalProperties": false, "properties": {"key": {"type": "string"}, "type": {"type": "string"}, "value": {}}, "required": ["key"], "type": "object"}, "type": "array"}, "oauth1": {"items": {"additionalProperties": false, "properties": {"key": {"type": "string"}, "type": {"type": "string"}, "value": {}}, "required": ["key"], "type": "object"}, "type": "array"}, "oauth2": {"items": {"additionalProperties": false, "properties": {"key": {"type": "string"}, "type": {"type": "string"}, "value": {}}, "required": ["key"], "type": "object"}, "type": "array"}, "other": {"additionalProperties": {"anyOf": [{}, {"items": {}, "type": "array"}]}, "properties": {"type": {"type": "string"}}, "required": ["type"], "type": "object"}}, "type": "object"}}, "type": "object"}, "type": "array"}, "tests": {"additionalProperties": false, "properties": {"contentTests": {"items": {"additionalProperties": false, "properties": {"excludeForOperations": {"items": {"type": "string"}, "type": "array"}, "openApiOperation": {"type": "string"}, "openApiOperationId": {"type": "string"}, "openApiOperationIds": {"items": {"type": "string"}, "type": "array"}, "responseBodyTests": {"items": {"additionalProperties": false, "properties": {"assert": {"type": "string"}, "contains": {"type": "string"}, "key": {"type": "string"}, "length": {"type": ["string", "number"]}, "maxLength": {"type": ["string", "number"]}, "minLength": {"type": ["string", "number"]}, "notExist": {"type": "boolean"}, "oneOf": {"anyOf": [{"items": {"type": "string"}, "type": "array"}, {"items": {"type": "number"}, "type": "array"}, {"items": {"type": "boolean"}, "type": "array"}]}, "value": {"type": ["string", "number", "boolean", "null"]}}, "required": ["key"], "type": "object"}, "type": "array"}, "responseHeaderTests": {"items": {"additionalProperties": false, "properties": {"assert": {"type": "string"}, "contains": {"type": "string"}, "key": {"type": "string"}, "length": {"type": ["string", "number"]}, "maxLength": {"type": ["string", "number"]}, "minLength": {"type": ["string", "number"]}, "notExist": {"type": "boolean"}, "oneOf": {"items": {"type": "string"}, "type": "array"}, "value": {"type": ["string", "number", "boolean"]}}, "required": ["key"], "type": "object"}, "type": "array"}}, "type": "object"}, "type": "array"}, "contractTests": {"items": {"additionalProperties": false, "properties": {"additionalProperties": {"additionalProperties": false, "properties": {"additionalProperties": {"type": "boolean"}, "enabled": {"type": "boolean"}, "excludeForOperations": {"items": {"type": "string"}, "type": "array"}}, "required": ["enabled"], "type": "object"}, "contentType": {"additionalProperties": false, "properties": {"enabled": {"type": "boolean"}, "excludeForOperations": {"items": {"type": "string"}, "type": "array"}}, "required": ["enabled"], "type": "object"}, "excludeForOperations": {"items": {"type": "string"}, "type": "array"}, "headersPresent": {"additionalProperties": false, "properties": {"enabled": {"type": "boolean"}, "excludeForOperations": {"items": {"type": "string"}, "type": "array"}}, "required": ["enabled"], "type": "object"}, "jsonBody": {"additionalProperties": false, "properties": {"enabled": {"type": "boolean"}, "excludeForOperations": {"items": {"type": "string"}, "type": "array"}}, "required": ["enabled"], "type": "object"}, "openApiOperation": {"type": "string"}, "openApiOperationId": {"type": "string"}, "openApiOperationIds": {"items": {"type": "string"}, "type": "array"}, "responseTime": {"additionalProperties": false, "properties": {"enabled": {"type": "boolean"}, "excludeForOperations": {"items": {"type": "string"}, "type": "array"}, "maxMs": {"type": "number"}}, "required": ["enabled", "maxMs"], "type": "object"}, "schemaValidation": {"additionalProperties": false, "properties": {"enabled": {"type": "boolean"}, "excludeForOperations": {"items": {"type": "string"}, "type": "array"}, "additionalProperties": {"type": "boolean"}}, "required": ["enabled"], "type": "object"}, "statusCode": {"additionalProperties": false, "properties": {"code": {"type": "number"}, "enabled": {"type": "boolean"}, "excludeForOperations": {"items": {"type": "string"}, "type": "array"}}, "required": ["enabled"], "type": "object"}, "statusSuccess": {"additionalProperties": false, "properties": {"enabled": {"type": "boolean"}, "excludeForOperations": {"items": {"type": "string"}, "type": "array"}}, "required": ["enabled"], "type": "object"}}, "type": "object"}, "type": "array"}, "extendTests": {"items": {"additionalProperties": false, "properties": {"append": {"type": "boolean"}, "excludeForOperations": {"items": {"type": "string"}, "type": "array"}, "openApiOperation": {"type": "string"}, "openApiOperationId": {"type": "string"}, "openApiOperationIds": {"items": {"type": "string"}, "type": "array"}, "overwrite": {"type": "boolean"}, "tests": {"items": {"type": "string"}, "type": "array"}}, "required": ["tests"], "type": "object"}, "type": "array"}, "integrationTests": {"items": {"additionalProperties": false, "properties": {"name": {"type": "string"}, "operations": {"items": {"additionalProperties": false, "properties": {"openApiOperationId": {"type": "string"}, "openApiResponse": {"type": "string"}, "variations": {"items": {"additionalProperties": false, "properties": {"assignVariables": {"items": {"additionalProperties": false, "properties": {"collectionVariables": {"items": {"additionalProperties": false, "properties": {"name": {"type": "string"}, "requestBodyProp": {"type": "string"}, "responseBodyProp": {"type": "string"}, "responseHeaderProp": {"type": "string"}, "value": {}}, "type": "object"}, "type": "array"}, "excludeForOperations": {"items": {"type": "string"}, "type": "array"}, "openApiOperation": {"type": "string"}, "openApiOperationId": {"type": "string"}, "openApiOperationIds": {"items": {"type": "string"}, "type": "array"}}, "required": ["collectionVariables"], "type": "object"}, "type": "array"}, "extendTests": {"items": {"additionalProperties": false, "properties": {"append": {"type": "boolean"}, "excludeForOperations": {"items": {"type": "string"}, "type": "array"}, "openApiOperation": {"type": "string"}, "openApiOperationId": {"type": "string"}, "openApiOperationIds": {"items": {"type": "string"}, "type": "array"}, "overwrite": {"type": "boolean"}, "tests": {"items": {"type": "string"}, "type": "array"}}, "required": ["tests"], "type": "object"}, "type": "array"}, "fuzzing": {"items": {"additionalProperties": false, "properties": {"requestBody": {"items": {"additionalProperties": false, "properties": {"maxLengthFields": {"additionalProperties": false, "properties": {"enabled": {"type": "boolean"}}, "required": ["enabled"], "type": "object"}, "maximumNumberFields": {"additionalProperties": false, "properties": {"enabled": {"type": "boolean"}}, "required": ["enabled"], "type": "object"}, "minLengthFields": {"additionalProperties": false, "properties": {"enabled": {"type": "boolean"}}, "required": ["enabled"], "type": "object"}, "minimumNumberFields": {"additionalProperties": false, "properties": {"enabled": {"type": "boolean"}}, "required": ["enabled"], "type": "object"}, "requiredFields": {"additionalProperties": false, "properties": {"enabled": {"type": "boolean"}}, "required": ["enabled"], "type": "object"}}, "type": "object"}, "type": "array"}, "requestHeaders": {"items": {"additionalProperties": false, "properties": {"maxLengthFields": {"additionalProperties": false, "properties": {"enabled": {"type": "boolean"}}, "required": ["enabled"], "type": "object"}, "maximumNumberFields": {"additionalProperties": false, "properties": {"enabled": {"type": "boolean"}}, "required": ["enabled"], "type": "object"}, "minLengthFields": {"additionalProperties": false, "properties": {"enabled": {"type": "boolean"}}, "required": ["enabled"], "type": "object"}, "minimumNumberFields": {"additionalProperties": false, "properties": {"enabled": {"type": "boolean"}}, "required": ["enabled"], "type": "object"}, "requiredFields": {"additionalProperties": false, "properties": {"enabled": {"type": "boolean"}}, "required": ["enabled"], "type": "object"}}, "type": "object"}, "type": "array"}, "requestQueryParams": {"items": {"additionalProperties": false, "properties": {"maxLengthFields": {"additionalProperties": false, "properties": {"enabled": {"type": "boolean"}}, "required": ["enabled"], "type": "object"}, "maximumNumberFields": {"additionalProperties": false, "properties": {"enabled": {"type": "boolean"}}, "required": ["enabled"], "type": "object"}, "minLengthFields": {"additionalProperties": false, "properties": {"enabled": {"type": "boolean"}}, "required": ["enabled"], "type": "object"}, "minimumNumberFields": {"additionalProperties": false, "properties": {"enabled": {"type": "boolean"}}, "required": ["enabled"], "type": "object"}, "requiredFields": {"additionalProperties": false, "properties": {"enabled": {"type": "boolean"}}, "required": ["enabled"], "type": "object"}}, "type": "object"}, "type": "array"}}, "type": "object"}, "type": "array"}, "name": {"type": "string"}, "openApiResponse": {"type": "string"}, "operationPreRequestScripts": {"items": {"additionalProperties": false, "properties": {"excludeForOperations": {"items": {"type": "string"}, "type": "array"}, "openApiOperation": {"type": "string"}, "openApiOperationId": {"type": "string"}, "openApiOperationIds": {"items": {"type": "string"}, "type": "array"}, "scripts": {"items": {"type": "string"}, "type": "array"}}, "required": ["scripts"], "type": "object"}, "type": "array"}, "overwrites": {}, "tests": {}}, "required": ["name", "tests"], "type": "object"}, "type": "array"}}, "required": ["openApiOperationId", "variations"], "type": "object"}, "type": "array"}}, "required": ["name", "operations"], "type": "object"}, "type": "array"}, "variationTests": {"items": {"additionalProperties": false, "properties": {"excludeForOperations": {"items": {"type": "string"}, "type": "array"}, "openApiOperation": {"type": "string"}, "openApiOperationId": {"type": "string"}, "openApiOperationIds": {"items": {"type": "string"}, "type": "array"}, "openApiResponse": {"type": "string"}, "variations": {"items": {"additionalProperties": false, "properties": {"assignVariables": {"items": {"additionalProperties": false, "properties": {"collectionVariables": {"items": {"additionalProperties": false, "properties": {"name": {"type": "string"}, "requestBodyProp": {"type": "string"}, "responseBodyProp": {"type": "string"}, "responseHeaderProp": {"type": "string"}, "value": {}}, "type": "object"}, "type": "array"}, "excludeForOperations": {"items": {"type": "string"}, "type": "array"}, "openApiOperation": {"type": "string"}, "openApiOperationId": {"type": "string"}, "openApiOperationIds": {"items": {"type": "string"}, "type": "array"}}, "required": ["collectionVariables"], "type": "object"}, "type": "array"}, "extendTests": {"items": {"additionalProperties": false, "properties": {"append": {"type": "boolean"}, "excludeForOperations": {"items": {"type": "string"}, "type": "array"}, "openApiOperation": {"type": "string"}, "openApiOperationId": {"type": "string"}, "openApiOperationIds": {"items": {"type": "string"}, "type": "array"}, "overwrite": {"type": "boolean"}, "tests": {"items": {"type": "string"}, "type": "array"}}, "required": ["tests"], "type": "object"}, "type": "array"}, "fuzzing": {"items": {"additionalProperties": false, "properties": {"requestBody": {"items": {"additionalProperties": false, "properties": {"maxLengthFields": {"additionalProperties": false, "properties": {"enabled": {"type": "boolean"}}, "required": ["enabled"], "type": "object"}, "maximumNumberFields": {"additionalProperties": false, "properties": {"enabled": {"type": "boolean"}}, "required": ["enabled"], "type": "object"}, "minLengthFields": {"additionalProperties": false, "properties": {"enabled": {"type": "boolean"}}, "required": ["enabled"], "type": "object"}, "minimumNumberFields": {"additionalProperties": false, "properties": {"enabled": {"type": "boolean"}}, "required": ["enabled"], "type": "object"}, "requiredFields": {"additionalProperties": false, "properties": {"enabled": {"type": "boolean"}}, "required": ["enabled"], "type": "object"}}, "type": "object"}, "type": "array"}, "requestHeaders": {"items": {"additionalProperties": false, "properties": {"maxLengthFields": {"additionalProperties": false, "properties": {"enabled": {"type": "boolean"}}, "required": ["enabled"], "type": "object"}, "maximumNumberFields": {"additionalProperties": false, "properties": {"enabled": {"type": "boolean"}}, "required": ["enabled"], "type": "object"}, "minLengthFields": {"additionalProperties": false, "properties": {"enabled": {"type": "boolean"}}, "required": ["enabled"], "type": "object"}, "minimumNumberFields": {"additionalProperties": false, "properties": {"enabled": {"type": "boolean"}}, "required": ["enabled"], "type": "object"}, "requiredFields": {"additionalProperties": false, "properties": {"enabled": {"type": "boolean"}}, "required": ["enabled"], "type": "object"}}, "type": "object"}, "type": "array"}, "requestQueryParams": {"items": {"additionalProperties": false, "properties": {"maxLengthFields": {"additionalProperties": false, "properties": {"enabled": {"type": "boolean"}}, "required": ["enabled"], "type": "object"}, "maximumNumberFields": {"additionalProperties": false, "properties": {"enabled": {"type": "boolean"}}, "required": ["enabled"], "type": "object"}, "minLengthFields": {"additionalProperties": false, "properties": {"enabled": {"type": "boolean"}}, "required": ["enabled"], "type": "object"}, "minimumNumberFields": {"additionalProperties": false, "properties": {"enabled": {"type": "boolean"}}, "required": ["enabled"], "type": "object"}, "requiredFields": {"additionalProperties": false, "properties": {"enabled": {"type": "boolean"}}, "required": ["enabled"], "type": "object"}}, "type": "object"}, "type": "array"}}, "type": "object"}, "type": "array"}, "name": {"type": "string"}, "openApiResponse": {"type": "string"}, "operationPreRequestScripts": {"items": {"additionalProperties": false, "properties": {"excludeForOperations": {"items": {"type": "string"}, "type": "array"}, "openApiOperation": {"type": "string"}, "openApiOperationId": {"type": "string"}, "openApiOperationIds": {"items": {"type": "string"}, "type": "array"}, "scripts": {"items": {"type": "string"}, "type": "array"}}, "required": ["scripts"], "type": "object"}, "type": "array"}, "overwrites": {}, "tests": {}}, "required": ["name", "tests"], "type": "object"}, "type": "array"}}, "required": ["variations"], "type": "object"}, "type": "array"}}, "type": "object"}, "version": {"type": "number"}}, "type": "object"}
ffizer.schema.json
ignores
list of path from the current template to ignore
{"default": [], "type": "array", "items": {"type": "string"}}
ffizer.schema.json
imports
list of template to import and to apply as part of this template
{"default": [], "type": "array", "items": {}}
ffizer.schema.json
scripts
list of the scripts to apply at end of generation
{"default": [], "type": "array", "items": {}}
ffizer.schema.json
use_template_dir
set to true if the template content is under a `template` folder (not mixed with metadata)
{"default": false, "type": "boolean"}
ffizer.schema.json
variables
list of variables/parameters of the template
{"default": [], "type": "array", "items": {}}
ffizer.schema.json
ImportCfg
define a template layer to import
{"type": "object", "required": ["uri"], "properties": {"rev": {"type": ["string", "null"]}, "subfolder": {"type": ["string", "null"]}, "uri": {"type": "string"}}}
ffizer.schema.json
label
display of the value (in select)
{"type": "string"}
ffizer.schema.json
value
the value
{"allOf": [{}]}
ffizer.schema.json
cmd
command to execute
{"type": ["string", "null"]}
ffizer.schema.json
default_confirm_answer
default answer for confirmation of execution
{"type": ["string", "null"]}
ffizer.schema.json
message
message to display
{"type": ["string", "null"]}
ffizer.schema.json
ask
sentence to ask the value (default to the name on variable)
{"type": ["string", "null"]}
ffizer.schema.json
default_value
optionnal default value
{"anyOf": [{}, {"type": "null"}]}
ffizer.schema.json
hidden
is the variable hidden to the user (could be usefull to cache shared variable/data)
{"type": ["string", "null"]}
ffizer.schema.json
name
name of variable used in the template
{"type": "string"}
ffizer.schema.json
select_in_values
if non-empty then the value should selected into the list of value
{"anyOf": [{}, {"type": "null"}]}
up.json
name
A machine-friendly project name.
{"type": "string", "examples": ["apex-site", "apex-api", "ping-app"]}
up.json
description
An optional project description.
{"type": "string", "examples": ["Marketing site", "Public API"]}
up.json
type
The type of project.
{"type": "string", "default": "server", "enum": ["static", "server"], "examples": ["static"]}
up.json
profile
AWS credentials profile name, these are stored in ~/.aws/credentials.
{"type": "string", "examples": ["apex-prod", "apex-dev", "personal"]}
up.json
regions
List of target AWS regions for deployment.
{"type": "array", "minItems": 1, "items": {"type": "string", "enum": ["us-east-2", "us-east-1", "us-west-1", "us-west-2", "ap-south-1", "ap-northeast-2", "ap-southeast-1", "ap-southeast-2", "ap-northeast-1", "ca-central-1", "eu-central-1", "eu-west-1", "eu-west-2", "eu-west-3", "sa-east-1"], "examples": ["us-west-2", "us-*", "eu-*", "*"]}}
up.json
items
AWS region.
{"type": "string", "enum": ["us-east-2", "us-east-1", "us-west-1", "us-west-2", "ap-south-1", "ap-northeast-2", "ap-southeast-1", "ap-southeast-2", "ap-northeast-1", "ca-central-1", "eu-central-1", "eu-west-1", "eu-west-2", "eu-west-3", "sa-east-1"], "examples": ["us-west-2", "us-*", "eu-*", "*"]}
up.json
accelerate
Enable S3 acceleration for faster uploads via the CloudFront CDN.
{"type": "boolean", "default": false}
up.json
warm
Active warming mitigates cold starts when enabled.
{"type": "boolean", "default": false}
up.json
warm_rate
Active warming sends requests to your application at this interval.
{"type": "string", "default": "15m", "examples": ["5m", "30m"]}
up.json
warm_count
Number of concurrent containers to warm.
{"type": "integer", "default": "15"}
up.json
memory
Lambda memory size.
{"type": "integer", "default": 512, "enum": [128, 192, 256, 320, 384, 448, 512, 576, 640, 704, 768, 832, 896, 960, 1024, 1088, 1152, 1216, 1280, 1344, 1408, 1472, 1536, 1600, 1664, 1728, 1792, 1856, 1920, 1984, 2048, 2112, 2176, 2240, 2304, 2368, 2432, 2496, 2560, 2624, 2688, 2752, 2816, 2880, 2944, 3008]}
up.json
domain
Domain hostname for the stage.
{"type": "string", "default": "", "examples": ["gh-polls.com", "api.gh-polls.com"]}
up.json
domain
Domain hostname for the stage.
{"type": "string", "default": "", "examples": ["stage.gh-polls.com", "gh-polls-staging.com"]}
up.json
domain
Domain hostname for the stage.
{"type": "string", "default": "", "examples": ["dev.gh-polls.com"]}
up.json
build
Hook command(s) to run.
{"type": "string"}
up.json
clean
Hook command(s) to run.
{"type": "string"}
up.json
prebuild
Hook command(s) to run.
{"type": "string"}
up.json
postbuild
Hook command(s) to run.
{"type": "string"}
up.json
predeploy
Hook command(s) to run.
{"type": "string"}
up.json
postdeploy
Hook command(s) to run.
{"type": "string"}
up.json
dir
Path to directory from which assets are served.
{"type": "string", "default": ".", "examples": ["public", "./dist"]}
up.json
prefix
Optional URL path prefix.
{"type": "string", "examples": ["/public/", "/static/"]}
up.json
command
Command run to start your application.
{"type": "string", "default": "./server", "examples": ["node app.js"]}
up.json
timeout
Timeout in seconds per request.
{"type": "integer", "default": 15}
up.json
listen_timeout
Timeout in seconds Up will wait for your app to boot and listen on `PORT`.
{"type": "integer", "default": 15}
up.json
shutdown_timeout
Timeout in seconds Up will wait after sending a SIGINT to your server, before sending a SIGKILL.
{"type": "integer", "default": 15}
up.json
min
Minimum time in milliseconds before retrying.
{"type": "integer", "default": 500}
up.json
max
Maximum time in milliseconds before retrying.
{"type": "integer", "default": 1500}
up.json
factor
Factor applied to each attempt.
{"type": "number", "default": 1.5}
up.json
attempts
Attempts made before failing.
{"type": "integer", "default": 5}
up.json
jitter
Apply jitter.
{"type": "boolean", "default": false}
up.json
disable
Disable default error pages.
{"type": "boolean", "default": false}
up.json
dir
Path to directory from which error pages are served.
{"type": "string", "default": ".", "examples": ["public", "./dist"]}
up.json
support_email
Support email for contact link.
{"type": "string", "examples": ["[email protected]"]}
up.json
color
Theme color.
{"type": "string", "examples": ["#228ae6"]}
up.json
enable
Enable Cross-Origin Resource Sharing.
{"type": "boolean", "default": false}
up.json
items
A list of origins a cross-domain request can be executed from. Use `*` to allow any origin, or a wildcard such as `http://*.domain.com`.
{"type": "string", "default": "*", "examples": ["https://*.myapp.com", "https://myapp.com"]}