initial commit - RegexFlow Regular Expression (#1943)

* initial commit - RegexFlow Regular Expression

* fixed the issues highlighted in first review
This commit is contained in:
imreagocs-regexflow 2022-09-06 17:42:58 +02:00 коммит произвёл GitHub
Родитель c4354bd854
Коммит 68c6d1771f
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: 4AEE18F83AFDEB23
3 изменённых файлов: 194 добавлений и 0 удалений

Просмотреть файл

@ -0,0 +1,151 @@
{
"swagger": "2.0",
"info": {
"title": "RegexFlow Regular Expression",
"description": "The Regular Expression connector enables the use of regular expression. The connector uses the posted body and a regex pattern as inputs and returns the matched patterns and groups.",
"version": "1.0",
"contact": {
"name": "RegexFlow Support",
"url": "https://www.regexflow.com/",
"email": "support@regexflow.com"
}
},
"host": "publicapi.regexflow.com",
"basePath": "/RegexFlowSAS",
"schemes": [
"https"
],
"consumes": [
"text/plain"
],
"produces": [
"application/json"
],
"paths": {
"/RegexMultiGroup": {
"post": {
"parameters": [
{
"name": "pattern",
"in": "query",
"required": true,
"type": "string",
"x-ms-summary": "regular expression pattern",
"description": "regular expression pattern"
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"type": "string",
"x-ms-visibility": "important"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "Returned when the operation succeeds.",
"schema": {
"type": "object",
"properties": {
"isSuccess": {
"type": "boolean",
"description": "isSuccess"
},
"error": {
"type": "string",
"description": "Description of the error.",
"default": "null"
},
"matches": {
"type": "array",
"items": {
"type": "object",
"properties": {
"MatchId": {
"type": "string",
"description": "MatchId"
},
"Match": {
"type": "string",
"description": "Match"
},
"groups": {
"type": "array",
"items": {
"type": "object",
"properties": {
"group": {
"type": "string",
"description": "group"
},
"groupValue": {
"type": "string",
"description": "groupValue"
}
}
},
"description": "groups"
}
}
},
"description": "matches"
},
"caution": {
"type": "string",
"description": "caution"
}
}
}
},
"401": {
"description": "Access denied due to invalid subscription key."
},
"403": {
"description": "Out of volume quota."
},
"500": {
"description": "Internal server error."
}
},
"operationId": "RegexMultiGroup",
"summary": "Regex pattern matching in the posted text",
"description": "Finds regular expression matches in the posted body and returns the captured groups, groups can be named."
}
}
},
"definitions": {},
"parameters": {},
"responses": {},
"securityDefinitions": {
"API Key": {
"type": "apiKey",
"in": "header",
"name": "Ocp-Apim-Subscription-Key"
}
},
"security": [
{
"API Key": []
}
],
"tags": [],
"x-ms-connector-metadata": [
{
"propertyName": "Website",
"propertyValue": "https://www.regexflow.com"
},
{
"propertyName": "Privacy policy",
"propertyValue": "https://regexflow.com/privacy_policy"
},
{
"propertyName": "Categories",
"propertyValue": "Content and Files;Data"
}
]
}

Просмотреть файл

@ -0,0 +1,23 @@
{
"properties": {
"connectionParameters": {
"api_key": {
"type": "securestring",
"uiDefinition": {
"displayName": "API Key",
"description": "The API Key for this api",
"tooltip": "Provide your API Key (https://portal.publicapi.regexflow.com/)",
"constraints": {
"tabIndex": 2,
"clearText": false,
"required": "true"
}
}
}
},
"iconBrandColor": "#6C2C74",
"capabilities": [],
"publisher": "Epicycle",
"stackOwner": "Epicycle"
}
}

Просмотреть файл

@ -0,0 +1,20 @@
# RegexFlow Regular Expression
The Regular Expression connector enables the use of regular expression. The connector uses the posted body and a regex pattern as inputs and returns the matched patterns and groups.
## Publisher: Epicycle
## Prerequisites
You will need the following to proceed:
* A RegexFlow Regular Expression subscription
## Supported Operations
### RegexMultiGroup
Based on the pattern parameter and posted text returns the matched patterns and matched groups
## Known Issues and Limitations
* The usage usage quota is 1000 calls per month and there is a rate limit in place of 10 calls per minute. Please consider our private offerings which have no rate limits or monthly quotas, whilst also helping you meet your compliance obligations [RegexFlow](https://regexflow.com/).
* The '+' character in the pattern must be replaced with '%2B'
## Obtaining Credentials
You can get your own API key from the [RegexFlow Regular Expression Portal](https://portal.publicapi.regexflow.com/).