From a3f086ef0f4e8b47ec14e9287ec7ebc29a09ea33 Mon Sep 17 00:00:00 2001 From: Troy Taylor <44444967+troystaylor@users.noreply.github.com> Date: Mon, 6 Jun 2022 17:50:31 -0400 Subject: [PATCH 01/21] Revert "Merge branch 'microsoft:dev' into dev" This reverts commit 096a7c31993f909c3ee2ccacb4d6a206a1a2b2a3, reversing changes made to cb0948670feda35e9fc2a43241de68bc50e06812. --- .../apiDefinition.swagger.json | 59 ++++++++----------- .../SmartCOMM On Demand Doc-Gen/script.csx | 19 ------ 2 files changed, 24 insertions(+), 54 deletions(-) delete mode 100644 certified-connectors/SmartCOMM On Demand Doc-Gen/script.csx diff --git a/certified-connectors/SmartCOMM On Demand Doc-Gen/apiDefinition.swagger.json b/certified-connectors/SmartCOMM On Demand Doc-Gen/apiDefinition.swagger.json index d1a6fecbf7..df16750498 100644 --- a/certified-connectors/SmartCOMM On Demand Doc-Gen/apiDefinition.swagger.json +++ b/certified-connectors/SmartCOMM On Demand Doc-Gen/apiDefinition.swagger.json @@ -10,7 +10,7 @@ "email": "support@smartcommunications.com" } }, - "host": "eu10-sb.smartcommunications.cloud", + "host": "ap10-sb.smartcommunications.cloud", "basePath": "/", "schemes": [ "https" @@ -22,7 +22,7 @@ "application/json" ], "paths": { - "/one/oauth2/api/v11/job/generateDocument": { + "/one/oauth2/api/v10/job/generateDocument": { "post": { "summary": "Generate Document", "description": "This function generates a document.", @@ -47,9 +47,8 @@ "required": true, "type": "string", "default": "application/json", - "description": "The API accepts both XML and JSON requests. The request type is determined by the 'Content-Type' HTTP header in the request.", - "x-ms-summary": "Content-Type", - "x-ms-visibility": "internal" + "description": "The API accepts both XML and JSON requests. The request type is determined by the \u2018Content-Type\u2019 HTTP header in the request.", + "x-ms-summary": "Content-Type" }, { "name": "Accept", @@ -57,9 +56,8 @@ "required": true, "type": "string", "default": "application/json", - "description": "The API accepts both XML and JSON responses. The response type is determined by the 'Accept' HTTP header in the request.", - "x-ms-summary": "Accept", - "x-ms-visibility": "internal" + "description": "The API accepts both XML and JSON responses. The response type is determined by the \u2018Accept\u2019 HTTP header in the request.", + "x-ms-summary": "Accept" }, { "name": "body", @@ -70,19 +68,18 @@ "properties": { "projectId": { "type": "integer", - "format": "int64", + "format": "int32", "description": "The CMS project ID used to scope the request execution. If this value is not specified then the job will execute in production mode.", - "title": "projectId", - "x-ms-summary": "Project ID" + "title": "projectId" }, "transactionData": { "type": "string", - "description": "The sample data.", + "description": "The sample data. The data is encoded as Base64.", "title": "transactionData" }, "batchConfigResId": { "type": "integer", - "format": "int64", + "format": "int32", "description": "The CMS ID of the Template Selector resource. The Template Selector is used to map the transaction data to the Template and Data Model.", "title": "batchConfigResId" }, @@ -97,11 +94,7 @@ "type": "string", "description": "The content type of the transaction data. Can be 'application/xml' or 'application/json'. Defaults to 'application/xml'.", "title": "transactionDataType", - "default": "application/xml", - "enum": [ - "application/xml", - "application/json" - ] + "default": "application/xml" }, "properties": { "type": "array", @@ -143,13 +136,13 @@ "properties": { "classId": { "type": "integer", - "format": "int64", + "format": "int32", "description": "The code of the business exception.", "title": "classId" }, "id": { "type": "integer", - "format": "int64", + "format": "int32", "description": "The unique ID of the business exception.", "title": "id" }, @@ -192,20 +185,18 @@ "type": "object", "properties": { "startPage": { - "type": "integer", - "format": "int32", + "type": "string", "description": "The start page number of an enclosed document in the primary merged print document.", "title": "startPage" }, "pageCount": { - "type": "integer", - "format": "int32", + "type": "string", "description": "The number of pages in the document generated.", "title": "pageCount" }, "channelType": { "type": "integer", - "format": "int64", + "format": "int32", "description": "The type of the channel. Possible types are: '1' TYPE_HTML '2' TYPE_PRINT '3' TYPE_SMS '4' TYPE_TEXT '5' TYPE_TML '6' TYPE_XML '7' TYPE_WORDML '8' TYPE_XSLFO.", "title": "channelType" }, @@ -248,7 +239,7 @@ }, "channelId": { "type": "integer", - "format": "int64", + "format": "int32", "description": "The channel Id of the document.", "title": "channelId" }, @@ -266,18 +257,16 @@ "type": "object", "properties": { "startPage": { - "type": "integer", - "format": "int32", + "type": "string", "description": "startPage" }, "pageCount": { - "type": "integer", - "format": "int32", + "type": "string", "description": "pageCount" }, "channelType": { "type": "integer", - "format": "int64", + "format": "int32", "description": "channelType" }, "channelName": { @@ -315,7 +304,7 @@ }, "channelId": { "type": "integer", - "format": "int64", + "format": "int32", "description": "channelId" }, "partLocation": { @@ -350,7 +339,7 @@ }, "destID": { "type": "integer", - "format": "int64", + "format": "int32", "description": "The ID of the destination.", "title": "destID" }, @@ -431,8 +420,8 @@ "oauth2_auth": { "type": "oauth2", "flow": "accessCode", - "authorizationUrl": "https://eu10-sb.smartcommunications.cloud/one/oauth2Server/authorize", - "tokenUrl": "https://eu10-sb.smartcommunications.cloud/one/oauth2Server/token", + "authorizationUrl": "https://ap10-sb.smartcommunications.cloud/one/oauth2Server/authorize", + "tokenUrl": "https://ap10-sb.smartcommunications.cloud/one/oauth2Server/token", "scopes": {} } }, diff --git a/certified-connectors/SmartCOMM On Demand Doc-Gen/script.csx b/certified-connectors/SmartCOMM On Demand Doc-Gen/script.csx deleted file mode 100644 index 0cde3c14f7..0000000000 --- a/certified-connectors/SmartCOMM On Demand Doc-Gen/script.csx +++ /dev/null @@ -1,19 +0,0 @@ -public class Script : ScriptBase -{ - public override async Task ExecuteAsync() - { - await this.UpdateRequest().ConfigureAwait(false); - var response = await this.Context.SendAsync(this.Context.Request, this.CancellationToken).ConfigureAwait(false); - return response; - } - - private async Task UpdateRequest() - { - var contentAsString = await this.Context.Request.Content.ReadAsStringAsync().ConfigureAwait(false); - var contentAsJson = JObject.Parse(contentAsString); - var transactionData = (string)contentAsJson["transactionData"]; - var transactionDataBytes = System.Text.Encoding.UTF8.GetBytes(transactionData); - contentAsJson["transactionData"] = System.Convert.ToBase64String(transactionDataBytes); - this.Context.Request.Content = CreateJsonContent(contentAsJson.ToString()); - } -} \ No newline at end of file From 01764d0a6d9e3afa849a6a4159d751aee6108580 Mon Sep 17 00:00:00 2001 From: Troy Taylor <44444967+troystaylor@users.noreply.github.com> Date: Mon, 6 Jun 2022 17:51:37 -0400 Subject: [PATCH 02/21] Revert "Merge branch 'microsoft:dev' into dev" This reverts commit cb0948670feda35e9fc2a43241de68bc50e06812, reversing changes made to dc26e8a0268f26bc2f38bf3a66e8c90e98df9404. --- .../apiProperties.json | 123 ++----- .../Converter/apiDefinition.swagger.json | 2 +- .../Converter/apiProperties.json | 4 +- .../IronDefense/apiDefinition.swagger.json | 1 - .../Power Textor/apiProperties.json | 4 +- .../RecordedFutureIdentity/apiProperties.json | 2 +- .../sms77io/apiDefinition.swagger.json | 36 +- .../Finnish BIS/apiDefinition.swagger.json | 320 ++++++++++++------ .../Finnish BIS/apiProperties.json | 2 +- .../Star Wars/apiDefinition.swagger.json | 54 ++- .../haveibeenpwned/apiDefinition.swagger.json | 2 +- 11 files changed, 292 insertions(+), 258 deletions(-) diff --git a/certified-connectors/CognitiveServicesQuestionAnswering/apiProperties.json b/certified-connectors/CognitiveServicesQuestionAnswering/apiProperties.json index e0c17a1094..695a60ad7d 100644 --- a/certified-connectors/CognitiveServicesQuestionAnswering/apiProperties.json +++ b/certified-connectors/CognitiveServicesQuestionAnswering/apiProperties.json @@ -1,105 +1,32 @@ { "properties": { - "connectionParameterSets": { - "uiDefinition": { - "displayName": "Authentication Type", - "description": "Type of authentication to be used" - }, - "values": [ - { - "name": "keyBasedAuth", - "uiDefinition": { - "displayName": "Api Key", - "description": "ApiKey" - }, - "metadata": { - "allowSharing": true - }, - "parameters": { - "apiKey": { - "type": "securestring", - "uiDefinition": { - "displayName": "Account Key", - "description": "The endpoint key for your language resource to be copied from Azure portal", - "tooltip": "Provide your Language Endpoint Key", - "constraints": { - "required": "true" - } - } - }, - "siteUrl": { - "type": "string", - "uiDefinition": { - "displayName": "Site URL", - "description": "Hostname of your language resource to be copied from Azure portal", - "tooltip": "Provide Your Language Endpoint HostName", - "constraints": { - "required": "true" - } - } - } + "connectionParameters": { + "apiKey": { + "type": "securestring", + "uiDefinition": { + "displayName": "Account Key", + "description": "The endpoint key for your language resource to be copied from Azure portal", + "tooltip": "Provide your Language Endpoint Key", + "constraints": { + "tabIndex": 2, + "clearText": false, + "required": "true" } - }, - { - "name": "tokenBasedAuth", - "uiDefinition": { - "displayName": "Azure AD Integrated", - "description": "Use Azure Active Directory to access your Azure Blob Storage.", - "constraints": { - "hidden": "false" - } - }, - "metadata": { - "allowSharing": false - }, - "parameters": { - "token": { - "type": "oauthSetting", - "oAuthSettings": { - "identityProvider": "aad", - "clientId": "<>", - "redirectMode": "Global", - "redirectUrl": "https://global.consent.azure-apim.net/redirect", - "scopes": [], - "customParameters": { - "grantType": { - "value": "code" - }, - "resourceUri": { - "value": "https://cognitiveservices.azure.com" - }, - "loginUri": { - "value": "https://login.microsoftonline.com" - }, - "tenantId": { - "value": "common" - } - } - }, - "uiDefinition": { - "displayName": "Login your Credentials", - "description": "Sign in with your Azure Active Directory credentials", - "tooltip": "Provide Azure Active Directory credentials", - "constraints": { - "required": "true", - "hidden": "false" - } - } - }, - "siteUrl": { - "type": "string", - "uiDefinition": { - "displayName": "Site URL", - "description": "Hostname of your language resource to be copied from Azure portal", - "tooltip": "Provide Your Language Endpoint HostName", - "constraints": { - "required": "true" - } - } - } + } + }, + "siteUrl": { + "type": "string", + "uiDefinition": { + "displayName": "Site URL", + "description": "Hostname of your language resource (Example: https://.cognitiveservices.azure.com)", + "tooltip": "Provide Your Language Endpoint HostName", + "constraints": { + "tabIndex": 2, + "clearText": false, + "required": "true" } } - ] + } }, "iconBrandColor": "#1267AE", "policyTemplateInstances": [ @@ -118,7 +45,7 @@ { "parameters": { "x-ms-apimTemplateParameter.name": "Ocp-Apim-Subscription-Key", - "x-ms-apimTemplateParameter.value": "@connectionParameters('apiKey','')", + "x-ms-apimTemplateParameter.value": "@connectionParameters('apiKey')", "x-ms-apimTemplate-policySection": "Request" }, "templateId": "setheader", diff --git a/certified-connectors/Converter/apiDefinition.swagger.json b/certified-connectors/Converter/apiDefinition.swagger.json index 143b5a2cfd..bce6026542 100644 --- a/certified-connectors/Converter/apiDefinition.swagger.json +++ b/certified-connectors/Converter/apiDefinition.swagger.json @@ -36,7 +36,7 @@ "200": { "description": "OK", "schema": { - "type": "object" + "type": "string" } } }, diff --git a/certified-connectors/Converter/apiProperties.json b/certified-connectors/Converter/apiProperties.json index 200bfa036d..330dc618b4 100644 --- a/certified-connectors/Converter/apiProperties.json +++ b/certified-connectors/Converter/apiProperties.json @@ -15,9 +15,9 @@ } } }, - "iconBrandColor": "#000000", + "iconBrandColor": "#da3b01", "capabilities": [], - "publisher": "Power2Apps P2A GmbH", + "publisher": "Power2Apps P2A GmbH", "stackOwner": "Power2Apps P2A GmbH" } } \ No newline at end of file diff --git a/certified-connectors/IronDefense/apiDefinition.swagger.json b/certified-connectors/IronDefense/apiDefinition.swagger.json index f97f9581f8..3b2c73f90e 100644 --- a/certified-connectors/IronDefense/apiDefinition.swagger.json +++ b/certified-connectors/IronDefense/apiDefinition.swagger.json @@ -10,7 +10,6 @@ } ], "swagger": "2.0", - "host": "example.ironnetcybercloud.com", "info": { "title": "IronDefense", "description": "IronNet allows clients to interface with the IronDefense backend through a curated set of endpoints. This provides customers with the capability to triage alerts outside of IronVue.", diff --git a/certified-connectors/Power Textor/apiProperties.json b/certified-connectors/Power Textor/apiProperties.json index 81e51fe8f2..7d76a7dcb4 100644 --- a/certified-connectors/Power Textor/apiProperties.json +++ b/certified-connectors/Power Textor/apiProperties.json @@ -15,9 +15,9 @@ } } }, - "iconBrandColor": "#F3F3FF", + "iconBrandColor": "#953efc", "capabilities": [], "publisher": "Imperium Dynamics", "stackOwner": "Imperium Dynamics" } -} +} \ No newline at end of file diff --git a/certified-connectors/RecordedFutureIdentity/apiProperties.json b/certified-connectors/RecordedFutureIdentity/apiProperties.json index c64856fc37..0c867d027a 100644 --- a/certified-connectors/RecordedFutureIdentity/apiProperties.json +++ b/certified-connectors/RecordedFutureIdentity/apiProperties.json @@ -16,7 +16,7 @@ } } }, - "iconBrandColor": "#065283", + "iconBrandColor": "#0071CE", "publisher": "Recorded Future", "stackOwner": "Recorded Future" } diff --git a/certified-connectors/sms77io/apiDefinition.swagger.json b/certified-connectors/sms77io/apiDefinition.swagger.json index 0cf9faec8d..0c9d883990 100644 --- a/certified-connectors/sms77io/apiDefinition.swagger.json +++ b/certified-connectors/sms77io/apiDefinition.swagger.json @@ -771,8 +771,7 @@ "status" ], "produces": [ - "text/plain; charset=utf-8", - "application/json" + "text/plain" ], "parameters": [ { @@ -786,10 +785,7 @@ ], "responses": { "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/StatusJsonResponse" - } + "description": "Success" } }, "summary": "Get SMS Status", @@ -1038,34 +1034,6 @@ } }, "type": "object" - }, - "StatusJsonResponse": { - "items": { - "properties": { - "id": { - "type": "string" - }, - "status": { - "enum": [ - "DELIVERED", - "NOTDELIVERED", - "BUFFERED", - "TRANSMITTED", - "ACCEPTED", - "EXPIRED", - "REJECTED", - "FAILED", - "UNKNOWN" - ], - "type": "string" - }, - "status_time": { - "type": "string" - } - }, - "type": "object" - }, - "type": "array" } }, "parameters": {}, diff --git a/independent-publisher-connectors/Finnish BIS/apiDefinition.swagger.json b/independent-publisher-connectors/Finnish BIS/apiDefinition.swagger.json index f313edc3bc..4e1623e630 100644 --- a/independent-publisher-connectors/Finnish BIS/apiDefinition.swagger.json +++ b/independent-publisher-connectors/Finnish BIS/apiDefinition.swagger.json @@ -1,11 +1,11 @@ { - "swagger": "2.0", + "swagger": "2.0", "info": { "title": "Finnish BIS", "description": "Get data from the Finnish Business Information System (BIS) maintained by the PRH and the Finnish Tax Administration. \n\nIn addition to basic details of businesses or companies registered at the Finnish Trade Register, the service also provides information on other registers they have been added to: the Prepayment Register, the Employer Register, the VAT Register, the register of bodies liable for tax on insurance premiums, and the Client Register of the Tax Administration.", "version": "1.0", "contact": { - "name": "Timo Pertila", + "name": "Timo Pertilä", "url": "https://timopertila.com", "email": "timo.pertila@gmail.com" } @@ -42,32 +42,39 @@ "properties": { "type": { "type": "string", + "description": "", "title": "Type" }, "version": { "type": "string", + "description": "", "title": "Version" }, "totalResults": { "type": "integer", "format": "int32", + "description": "", "title": "Total results" }, "resultsFrom": { "type": "integer", "format": "int32", + "description": "resultsFrom", "title": "Results form" }, "previousResultsUri": { "type": "string", + "description": "", "title": "Previous results URL" }, "nextResultsUri": { "type": "string", + "description": "nextResultsUri", "title": "Next results URL" }, "exceptionNoticeUri": { "type": "string", + "description": "", "title": "Exception notice URL" }, "results": { @@ -77,22 +84,27 @@ "properties": { "businessId": { "type": "string", + "description": "", "title": "Business Id" }, "name": { "type": "string", + "description": "", "title": "Company name" }, "registrationDate": { "type": "string", + "description": "", "title": "Registration date" }, "companyForm": { "type": "string", + "description": "", "title": "Company form" }, "detailsUri": { "type": "string", + "description": "", "title": "Details URL" }, "liquidations": { @@ -102,29 +114,37 @@ "properties": { "version": { "type": "integer", - "format": "int32" + "format": "int32", + "description": "version" }, "name": { - "type": "string" + "type": "string", + "description": "name" }, "type": { - "type": "string" + "type": "string", + "description": "type" }, "registrationDate": { - "type": "string" + "type": "string", + "description": "registrationDate" }, "endDate": { - "type": "string" + "type": "string", + "description": "endDate" }, "language": { - "type": "string" + "type": "string", + "description": "language" }, "source": { "type": "integer", - "format": "int32" + "format": "int32", + "description": "source" } } - } + }, + "description": "liquidations" }, "names": { "type": "array", @@ -133,30 +153,38 @@ "properties": { "order": { "type": "integer", - "format": "int32" + "format": "int32", + "description": "order" }, "version": { "type": "integer", - "format": "int32" + "format": "int32", + "description": "version" }, "name": { - "type": "string" + "type": "string", + "description": "name" }, "registrationDate": { - "type": "string" + "type": "string", + "description": "registrationDate" }, "endDate": { - "type": "string" + "type": "string", + "description": "endDate" }, "source": { "type": "integer", - "format": "int32" + "format": "int32", + "description": "source" }, "language": { - "type": "string" + "type": "string", + "description": "language" } } - } + }, + "description": "names" }, "auxiliaryNames": { "type": "array", @@ -165,30 +193,38 @@ "properties": { "order": { "type": "integer", - "format": "int32" + "format": "int32", + "description": "order" }, "version": { "type": "integer", - "format": "int32" + "format": "int32", + "description": "version" }, "name": { - "type": "string" + "type": "string", + "description": "name" }, "registrationDate": { - "type": "string" + "type": "string", + "description": "registrationDate" }, "endDate": { - "type": "string" + "type": "string", + "description": "endDate" }, "source": { "type": "integer", - "format": "int32" + "format": "int32", + "description": "source" }, "language": { - "type": "string" + "type": "string", + "description": "language" } } - } + }, + "description": "auxiliaryNames" }, "addresses": { "type": "array", @@ -196,43 +232,55 @@ "type": "object", "properties": { "careOf": { - "type": "string" + "type": "string", + "description": "careOf" }, "street": { - "type": "string" + "type": "string", + "description": "street" }, "postCode": { - "type": "string" + "type": "string", + "description": "postCode" }, "type": { "type": "integer", - "format": "int32" + "format": "int32", + "description": "type" }, "version": { "type": "integer", - "format": "int32" + "format": "int32", + "description": "version" }, "city": { - "type": "string" + "type": "string", + "description": "city" }, "country": { - "type": "string" + "type": "string", + "description": "country" }, "registrationDate": { - "type": "string" + "type": "string", + "description": "registrationDate" }, "endDate": { - "type": "string" + "type": "string", + "description": "endDate" }, "language": { - "type": "string" + "type": "string", + "description": "language" }, "source": { "type": "integer", - "format": "int32" + "format": "int32", + "description": "source" } } - } + }, + "description": "addresses" }, "companyForms": { "type": "array", @@ -241,29 +289,37 @@ "properties": { "version": { "type": "integer", - "format": "int32" + "format": "int32", + "description": "version" }, "name": { - "type": "string" + "type": "string", + "description": "name" }, "type": { - "type": "string" + "type": "string", + "description": "type" }, "registrationDate": { - "type": "string" + "type": "string", + "description": "registrationDate" }, "endDate": { - "type": "string" + "type": "string", + "description": "endDate" }, "language": { - "type": "string" + "type": "string", + "description": "language" }, "source": { "type": "integer", - "format": "int32" + "format": "int32", + "description": "source" } } - } + }, + "description": "companyForms" }, "businessLines": { "type": "array", @@ -272,33 +328,42 @@ "properties": { "order": { "type": "integer", - "format": "int32" + "format": "int32", + "description": "order" }, "version": { "type": "integer", - "format": "int32" + "format": "int32", + "description": "version" }, "code": { - "type": "string" + "type": "string", + "description": "code" }, "name": { - "type": "string" + "type": "string", + "description": "name" }, "registrationDate": { - "type": "string" + "type": "string", + "description": "registrationDate" }, "endDate": { - "type": "string" + "type": "string", + "description": "endDate" }, "language": { - "type": "string" + "type": "string", + "description": "language" }, "source": { "type": "integer", - "format": "int32" + "format": "int32", + "description": "source" } } - } + }, + "description": "businessLines" }, "languages": { "type": "array", @@ -307,26 +372,33 @@ "properties": { "version": { "type": "integer", - "format": "int32" + "format": "int32", + "description": "version" }, "name": { - "type": "string" + "type": "string", + "description": "name" }, "registrationDate": { - "type": "string" + "type": "string", + "description": "registrationDate" }, "endDate": { - "type": "string" + "type": "string", + "description": "endDate" }, "language": { - "type": "string" + "type": "string", + "description": "language" }, "source": { "type": "integer", - "format": "int32" + "format": "int32", + "description": "source" } } - } + }, + "description": "languages" }, "registedOffices": { "type": "array", @@ -335,30 +407,38 @@ "properties": { "order": { "type": "integer", - "format": "int32" + "format": "int32", + "description": "order" }, "version": { "type": "integer", - "format": "int32" + "format": "int32", + "description": "version" }, "name": { - "type": "string" + "type": "string", + "description": "name" }, "registrationDate": { - "type": "string" + "type": "string", + "description": "registrationDate" }, "endDate": { - "type": "string" + "type": "string", + "description": "endDate" }, "language": { - "type": "string" + "type": "string", + "description": "language" }, "source": { "type": "integer", - "format": "int32" + "format": "int32", + "description": "source" } } - } + }, + "description": "registedOffices" }, "contactDetails": { "type": "array", @@ -366,30 +446,39 @@ "type": "object", "properties": { "value": { - "type": "string" + "type": "integer", + "format": "int32", + "description": "value" }, "version": { "type": "integer", - "format": "int32" + "format": "int32", + "description": "version" }, "name": { - "type": "string" + "type": "string", + "description": "name" }, "registrationDate": { - "type": "string" + "type": "string", + "description": "registrationDate" }, "endDate": { - "type": "string" + "type": "string", + "description": "endDate" }, "language": { - "type": "string" + "type": "string", + "description": "language" }, "source": { "type": "integer", - "format": "int32" + "format": "int32", + "description": "source" } } - } + }, + "description": "contactDetails" }, "registeredEntries": { "type": "array", @@ -398,33 +487,42 @@ "properties": { "authority": { "type": "integer", - "format": "int32" + "format": "int32", + "description": "authority" }, "register": { "type": "integer", - "format": "int32" + "format": "int32", + "description": "register" }, "status": { "type": "integer", - "format": "int32" + "format": "int32", + "description": "status" }, "registrationDate": { - "type": "string" + "type": "string", + "description": "registrationDate" }, "endDate": { - "type": "string" + "type": "string", + "description": "endDate" }, "statusDate": { - "type": "string" + "type": "string", + "description": "statusDate" }, "language": { - "type": "string" + "type": "string", + "description": "language" }, "description": { - "type": "string" + "type": "string", + "description": "description" } } - } + }, + "description": "registeredEntries" }, "businessIdChanges": { "type": "array", @@ -433,35 +531,45 @@ "properties": { "source": { "type": "integer", - "format": "int32" + "format": "int32", + "description": "source" }, "description": { - "type": "string" + "type": "string", + "description": "description" }, "reason": { - "type": "string" + "type": "string", + "description": "reason" }, "changeDate": { - "type": "string" + "type": "string", + "description": "changeDate" }, "change": { "type": "integer", - "format": "int32" + "format": "int32", + "description": "change" }, "oldBusinessId": { - "type": "string" + "type": "string", + "description": "oldBusinessId" }, "newBusinessId": { - "type": "string" + "type": "string", + "description": "newBusinessId" }, - "language": { - "type": "string" + "language ": { + "type": "string", + "description": "language " } } - } + }, + "description": "businessIdChanges" } } - } + }, + "description": "results" } } } @@ -493,32 +601,39 @@ "properties": { "type": { "type": "string", + "description": "", "title": "Type" }, "version": { "type": "string", + "description": "", "title": "Version" }, "totalResults": { "type": "integer", "format": "int32", + "description": "", "title": "Total results" }, "resultsFrom": { "type": "integer", "format": "int32", + "description": "", "title": "Results from" }, "previousResultsUri": { "type": "string", + "description": "", "title": "Previous results URI" }, "nextResultsUri": { "type": "string", + "description": "", "title": "Next results URI" }, "exceptionNoticeUri": { "type": "string", + "description": "", "title": "Exception notice URL" }, "results": { @@ -528,27 +643,32 @@ "properties": { "businessId": { "type": "string", + "description": "", "title": "Business Id" }, "name": { "type": "string", + "description": "", "title": "Company name" }, "registrationDate": { "type": "string", + "description": "", "title": "Registration date" }, "companyForm": { "type": "string", + "description": "", "title": "Company form" }, "detailsUri": { "type": "string", + "description": "", "title": "Details URL" } } - } - + }, + "description": "results" } } } diff --git a/independent-publisher-connectors/Finnish BIS/apiProperties.json b/independent-publisher-connectors/Finnish BIS/apiProperties.json index 1f640bf16d..36c6976840 100644 --- a/independent-publisher-connectors/Finnish BIS/apiProperties.json +++ b/independent-publisher-connectors/Finnish BIS/apiProperties.json @@ -3,7 +3,7 @@ "connectionParameters": {}, "iconBrandColor": "#da3b01", "capabilities": [], - "publisher": "Timo Pertila", + "publisher": "Timo Pertilä", "stackOwner": "https://www.ytj.fi/en" } } \ No newline at end of file diff --git a/independent-publisher-connectors/Star Wars/apiDefinition.swagger.json b/independent-publisher-connectors/Star Wars/apiDefinition.swagger.json index 3b9cc7ce77..9459684256 100644 --- a/independent-publisher-connectors/Star Wars/apiDefinition.swagger.json +++ b/independent-publisher-connectors/Star Wars/apiDefinition.swagger.json @@ -56,7 +56,7 @@ } }, "parameters": [{ - "name": "search", + "name": "Search", "in": "query", "required": false, "type": "string", @@ -64,7 +64,13 @@ "x-ms-summary": "Search string", "description": "Search species by name" }, { - "$ref": "#/parameters/Page" + "name": "Page", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Page number", + "x-ms-summary": "Page number" } ], "summary": "Get All Species" @@ -94,7 +100,13 @@ "x-ms-summary": "Search string", "description": "Search sharships by name" }, { - "$ref": "#/parameters/Page" + "name": "Page", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Page number", + "x-ms-summary": "Page number" } ], "summary": "Get all starships" @@ -146,7 +158,13 @@ "x-ms-summary": "Search string", "description": "Search films by name" }, { - "$ref": "#/parameters/Page" + "name": "Page", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Page number", + "x-ms-summary": "Page number" } ], "summary": "Get all films" @@ -221,7 +239,13 @@ "x-ms-summary": "Search string", "description": "Search planets by name" }, { - "$ref": "#/parameters/Page" + "name": "Page", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Page number", + "x-ms-summary": "Page number" } ] } @@ -245,7 +269,13 @@ "x-ms-summary": "Search string", "description": "Search people by name" }, { - "$ref": "#/parameters/Page" + "name": "Page", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Page number", + "x-ms-summary": "Page number" } ], "summary": "Get People", @@ -822,17 +852,7 @@ "propertyValue": "Lifestyle and Entertainment" } ], - "parameters": { - "Page": { - "name": "page", - "in": "query", - "required": false, - "type": "integer", - "format": "int32", - "description": "Page number", - "x-ms-summary": "Page number" - } - }, + "parameters": {}, "responses": {}, "securityDefinitions": {}, "security": [], diff --git a/independent-publisher-connectors/haveibeenpwned/apiDefinition.swagger.json b/independent-publisher-connectors/haveibeenpwned/apiDefinition.swagger.json index 462a6bb90c..2b98bd5484 100644 --- a/independent-publisher-connectors/haveibeenpwned/apiDefinition.swagger.json +++ b/independent-publisher-connectors/haveibeenpwned/apiDefinition.swagger.json @@ -333,7 +333,7 @@ } }, "summary": "Getting all breached sites in the system", - "description": "A breach is an instance of a system having been compromised by an attacker and the data disclosed.", + "description": "A breach is an instance of a system having been compromised by an attacker and the data disclosed. For example, Adobe was a breach, Gawker was a breach etc. It is possible to return the details of each of breach in the system.", "operationId": "AllBreaches", "parameters": [] } From 4bb6689714de50fe0a6e205c977aa0ba48a84781 Mon Sep 17 00:00:00 2001 From: Troy Taylor <44444967+troystaylor@users.noreply.github.com> Date: Mon, 6 Jun 2022 17:57:00 -0400 Subject: [PATCH 03/21] Revert "Revert "Merge branch 'microsoft:dev' into dev"" This reverts commit 01764d0a6d9e3afa849a6a4159d751aee6108580. --- .../apiProperties.json | 123 +++++-- .../Converter/apiDefinition.swagger.json | 2 +- .../Converter/apiProperties.json | 4 +- .../IronDefense/apiDefinition.swagger.json | 1 + .../Power Textor/apiProperties.json | 4 +- .../RecordedFutureIdentity/apiProperties.json | 2 +- .../sms77io/apiDefinition.swagger.json | 36 +- .../Finnish BIS/apiDefinition.swagger.json | 320 ++++++------------ .../Finnish BIS/apiProperties.json | 2 +- .../Star Wars/apiDefinition.swagger.json | 54 +-- .../haveibeenpwned/apiDefinition.swagger.json | 2 +- 11 files changed, 258 insertions(+), 292 deletions(-) diff --git a/certified-connectors/CognitiveServicesQuestionAnswering/apiProperties.json b/certified-connectors/CognitiveServicesQuestionAnswering/apiProperties.json index 695a60ad7d..e0c17a1094 100644 --- a/certified-connectors/CognitiveServicesQuestionAnswering/apiProperties.json +++ b/certified-connectors/CognitiveServicesQuestionAnswering/apiProperties.json @@ -1,32 +1,105 @@ { "properties": { - "connectionParameters": { - "apiKey": { - "type": "securestring", - "uiDefinition": { - "displayName": "Account Key", - "description": "The endpoint key for your language resource to be copied from Azure portal", - "tooltip": "Provide your Language Endpoint Key", - "constraints": { - "tabIndex": 2, - "clearText": false, - "required": "true" - } - } + "connectionParameterSets": { + "uiDefinition": { + "displayName": "Authentication Type", + "description": "Type of authentication to be used" }, - "siteUrl": { - "type": "string", - "uiDefinition": { - "displayName": "Site URL", - "description": "Hostname of your language resource (Example: https://.cognitiveservices.azure.com)", - "tooltip": "Provide Your Language Endpoint HostName", - "constraints": { - "tabIndex": 2, - "clearText": false, - "required": "true" + "values": [ + { + "name": "keyBasedAuth", + "uiDefinition": { + "displayName": "Api Key", + "description": "ApiKey" + }, + "metadata": { + "allowSharing": true + }, + "parameters": { + "apiKey": { + "type": "securestring", + "uiDefinition": { + "displayName": "Account Key", + "description": "The endpoint key for your language resource to be copied from Azure portal", + "tooltip": "Provide your Language Endpoint Key", + "constraints": { + "required": "true" + } + } + }, + "siteUrl": { + "type": "string", + "uiDefinition": { + "displayName": "Site URL", + "description": "Hostname of your language resource to be copied from Azure portal", + "tooltip": "Provide Your Language Endpoint HostName", + "constraints": { + "required": "true" + } + } + } + } + }, + { + "name": "tokenBasedAuth", + "uiDefinition": { + "displayName": "Azure AD Integrated", + "description": "Use Azure Active Directory to access your Azure Blob Storage.", + "constraints": { + "hidden": "false" + } + }, + "metadata": { + "allowSharing": false + }, + "parameters": { + "token": { + "type": "oauthSetting", + "oAuthSettings": { + "identityProvider": "aad", + "clientId": "<>", + "redirectMode": "Global", + "redirectUrl": "https://global.consent.azure-apim.net/redirect", + "scopes": [], + "customParameters": { + "grantType": { + "value": "code" + }, + "resourceUri": { + "value": "https://cognitiveservices.azure.com" + }, + "loginUri": { + "value": "https://login.microsoftonline.com" + }, + "tenantId": { + "value": "common" + } + } + }, + "uiDefinition": { + "displayName": "Login your Credentials", + "description": "Sign in with your Azure Active Directory credentials", + "tooltip": "Provide Azure Active Directory credentials", + "constraints": { + "required": "true", + "hidden": "false" + } + } + }, + "siteUrl": { + "type": "string", + "uiDefinition": { + "displayName": "Site URL", + "description": "Hostname of your language resource to be copied from Azure portal", + "tooltip": "Provide Your Language Endpoint HostName", + "constraints": { + "required": "true" + } + } + } } } - } + ] }, "iconBrandColor": "#1267AE", "policyTemplateInstances": [ @@ -45,7 +118,7 @@ { "parameters": { "x-ms-apimTemplateParameter.name": "Ocp-Apim-Subscription-Key", - "x-ms-apimTemplateParameter.value": "@connectionParameters('apiKey')", + "x-ms-apimTemplateParameter.value": "@connectionParameters('apiKey','')", "x-ms-apimTemplate-policySection": "Request" }, "templateId": "setheader", diff --git a/certified-connectors/Converter/apiDefinition.swagger.json b/certified-connectors/Converter/apiDefinition.swagger.json index bce6026542..143b5a2cfd 100644 --- a/certified-connectors/Converter/apiDefinition.swagger.json +++ b/certified-connectors/Converter/apiDefinition.swagger.json @@ -36,7 +36,7 @@ "200": { "description": "OK", "schema": { - "type": "string" + "type": "object" } } }, diff --git a/certified-connectors/Converter/apiProperties.json b/certified-connectors/Converter/apiProperties.json index 330dc618b4..200bfa036d 100644 --- a/certified-connectors/Converter/apiProperties.json +++ b/certified-connectors/Converter/apiProperties.json @@ -15,9 +15,9 @@ } } }, - "iconBrandColor": "#da3b01", + "iconBrandColor": "#000000", "capabilities": [], - "publisher": "Power2Apps P2A GmbH", + "publisher": "Power2Apps P2A GmbH", "stackOwner": "Power2Apps P2A GmbH" } } \ No newline at end of file diff --git a/certified-connectors/IronDefense/apiDefinition.swagger.json b/certified-connectors/IronDefense/apiDefinition.swagger.json index 3b2c73f90e..f97f9581f8 100644 --- a/certified-connectors/IronDefense/apiDefinition.swagger.json +++ b/certified-connectors/IronDefense/apiDefinition.swagger.json @@ -10,6 +10,7 @@ } ], "swagger": "2.0", + "host": "example.ironnetcybercloud.com", "info": { "title": "IronDefense", "description": "IronNet allows clients to interface with the IronDefense backend through a curated set of endpoints. This provides customers with the capability to triage alerts outside of IronVue.", diff --git a/certified-connectors/Power Textor/apiProperties.json b/certified-connectors/Power Textor/apiProperties.json index 7d76a7dcb4..81e51fe8f2 100644 --- a/certified-connectors/Power Textor/apiProperties.json +++ b/certified-connectors/Power Textor/apiProperties.json @@ -15,9 +15,9 @@ } } }, - "iconBrandColor": "#953efc", + "iconBrandColor": "#F3F3FF", "capabilities": [], "publisher": "Imperium Dynamics", "stackOwner": "Imperium Dynamics" } -} \ No newline at end of file +} diff --git a/certified-connectors/RecordedFutureIdentity/apiProperties.json b/certified-connectors/RecordedFutureIdentity/apiProperties.json index 0c867d027a..c64856fc37 100644 --- a/certified-connectors/RecordedFutureIdentity/apiProperties.json +++ b/certified-connectors/RecordedFutureIdentity/apiProperties.json @@ -16,7 +16,7 @@ } } }, - "iconBrandColor": "#0071CE", + "iconBrandColor": "#065283", "publisher": "Recorded Future", "stackOwner": "Recorded Future" } diff --git a/certified-connectors/sms77io/apiDefinition.swagger.json b/certified-connectors/sms77io/apiDefinition.swagger.json index 0c9d883990..0cf9faec8d 100644 --- a/certified-connectors/sms77io/apiDefinition.swagger.json +++ b/certified-connectors/sms77io/apiDefinition.swagger.json @@ -771,7 +771,8 @@ "status" ], "produces": [ - "text/plain" + "text/plain; charset=utf-8", + "application/json" ], "parameters": [ { @@ -785,7 +786,10 @@ ], "responses": { "200": { - "description": "Success" + "description": "Success", + "schema": { + "$ref": "#/definitions/StatusJsonResponse" + } } }, "summary": "Get SMS Status", @@ -1034,6 +1038,34 @@ } }, "type": "object" + }, + "StatusJsonResponse": { + "items": { + "properties": { + "id": { + "type": "string" + }, + "status": { + "enum": [ + "DELIVERED", + "NOTDELIVERED", + "BUFFERED", + "TRANSMITTED", + "ACCEPTED", + "EXPIRED", + "REJECTED", + "FAILED", + "UNKNOWN" + ], + "type": "string" + }, + "status_time": { + "type": "string" + } + }, + "type": "object" + }, + "type": "array" } }, "parameters": {}, diff --git a/independent-publisher-connectors/Finnish BIS/apiDefinition.swagger.json b/independent-publisher-connectors/Finnish BIS/apiDefinition.swagger.json index 4e1623e630..f313edc3bc 100644 --- a/independent-publisher-connectors/Finnish BIS/apiDefinition.swagger.json +++ b/independent-publisher-connectors/Finnish BIS/apiDefinition.swagger.json @@ -1,11 +1,11 @@ { - "swagger": "2.0", + "swagger": "2.0", "info": { "title": "Finnish BIS", "description": "Get data from the Finnish Business Information System (BIS) maintained by the PRH and the Finnish Tax Administration. \n\nIn addition to basic details of businesses or companies registered at the Finnish Trade Register, the service also provides information on other registers they have been added to: the Prepayment Register, the Employer Register, the VAT Register, the register of bodies liable for tax on insurance premiums, and the Client Register of the Tax Administration.", "version": "1.0", "contact": { - "name": "Timo Pertilä", + "name": "Timo Pertila", "url": "https://timopertila.com", "email": "timo.pertila@gmail.com" } @@ -42,39 +42,32 @@ "properties": { "type": { "type": "string", - "description": "", "title": "Type" }, "version": { "type": "string", - "description": "", "title": "Version" }, "totalResults": { "type": "integer", "format": "int32", - "description": "", "title": "Total results" }, "resultsFrom": { "type": "integer", "format": "int32", - "description": "resultsFrom", "title": "Results form" }, "previousResultsUri": { "type": "string", - "description": "", "title": "Previous results URL" }, "nextResultsUri": { "type": "string", - "description": "nextResultsUri", "title": "Next results URL" }, "exceptionNoticeUri": { "type": "string", - "description": "", "title": "Exception notice URL" }, "results": { @@ -84,27 +77,22 @@ "properties": { "businessId": { "type": "string", - "description": "", "title": "Business Id" }, "name": { "type": "string", - "description": "", "title": "Company name" }, "registrationDate": { "type": "string", - "description": "", "title": "Registration date" }, "companyForm": { "type": "string", - "description": "", "title": "Company form" }, "detailsUri": { "type": "string", - "description": "", "title": "Details URL" }, "liquidations": { @@ -114,37 +102,29 @@ "properties": { "version": { "type": "integer", - "format": "int32", - "description": "version" + "format": "int32" }, "name": { - "type": "string", - "description": "name" + "type": "string" }, "type": { - "type": "string", - "description": "type" + "type": "string" }, "registrationDate": { - "type": "string", - "description": "registrationDate" + "type": "string" }, "endDate": { - "type": "string", - "description": "endDate" + "type": "string" }, "language": { - "type": "string", - "description": "language" + "type": "string" }, "source": { "type": "integer", - "format": "int32", - "description": "source" + "format": "int32" } } - }, - "description": "liquidations" + } }, "names": { "type": "array", @@ -153,38 +133,30 @@ "properties": { "order": { "type": "integer", - "format": "int32", - "description": "order" + "format": "int32" }, "version": { "type": "integer", - "format": "int32", - "description": "version" + "format": "int32" }, "name": { - "type": "string", - "description": "name" + "type": "string" }, "registrationDate": { - "type": "string", - "description": "registrationDate" + "type": "string" }, "endDate": { - "type": "string", - "description": "endDate" + "type": "string" }, "source": { "type": "integer", - "format": "int32", - "description": "source" + "format": "int32" }, "language": { - "type": "string", - "description": "language" + "type": "string" } } - }, - "description": "names" + } }, "auxiliaryNames": { "type": "array", @@ -193,38 +165,30 @@ "properties": { "order": { "type": "integer", - "format": "int32", - "description": "order" + "format": "int32" }, "version": { "type": "integer", - "format": "int32", - "description": "version" + "format": "int32" }, "name": { - "type": "string", - "description": "name" + "type": "string" }, "registrationDate": { - "type": "string", - "description": "registrationDate" + "type": "string" }, "endDate": { - "type": "string", - "description": "endDate" + "type": "string" }, "source": { "type": "integer", - "format": "int32", - "description": "source" + "format": "int32" }, "language": { - "type": "string", - "description": "language" + "type": "string" } } - }, - "description": "auxiliaryNames" + } }, "addresses": { "type": "array", @@ -232,55 +196,43 @@ "type": "object", "properties": { "careOf": { - "type": "string", - "description": "careOf" + "type": "string" }, "street": { - "type": "string", - "description": "street" + "type": "string" }, "postCode": { - "type": "string", - "description": "postCode" + "type": "string" }, "type": { "type": "integer", - "format": "int32", - "description": "type" + "format": "int32" }, "version": { "type": "integer", - "format": "int32", - "description": "version" + "format": "int32" }, "city": { - "type": "string", - "description": "city" + "type": "string" }, "country": { - "type": "string", - "description": "country" + "type": "string" }, "registrationDate": { - "type": "string", - "description": "registrationDate" + "type": "string" }, "endDate": { - "type": "string", - "description": "endDate" + "type": "string" }, "language": { - "type": "string", - "description": "language" + "type": "string" }, "source": { "type": "integer", - "format": "int32", - "description": "source" + "format": "int32" } } - }, - "description": "addresses" + } }, "companyForms": { "type": "array", @@ -289,37 +241,29 @@ "properties": { "version": { "type": "integer", - "format": "int32", - "description": "version" + "format": "int32" }, "name": { - "type": "string", - "description": "name" + "type": "string" }, "type": { - "type": "string", - "description": "type" + "type": "string" }, "registrationDate": { - "type": "string", - "description": "registrationDate" + "type": "string" }, "endDate": { - "type": "string", - "description": "endDate" + "type": "string" }, "language": { - "type": "string", - "description": "language" + "type": "string" }, "source": { "type": "integer", - "format": "int32", - "description": "source" + "format": "int32" } } - }, - "description": "companyForms" + } }, "businessLines": { "type": "array", @@ -328,42 +272,33 @@ "properties": { "order": { "type": "integer", - "format": "int32", - "description": "order" + "format": "int32" }, "version": { "type": "integer", - "format": "int32", - "description": "version" + "format": "int32" }, "code": { - "type": "string", - "description": "code" + "type": "string" }, "name": { - "type": "string", - "description": "name" + "type": "string" }, "registrationDate": { - "type": "string", - "description": "registrationDate" + "type": "string" }, "endDate": { - "type": "string", - "description": "endDate" + "type": "string" }, "language": { - "type": "string", - "description": "language" + "type": "string" }, "source": { "type": "integer", - "format": "int32", - "description": "source" + "format": "int32" } } - }, - "description": "businessLines" + } }, "languages": { "type": "array", @@ -372,33 +307,26 @@ "properties": { "version": { "type": "integer", - "format": "int32", - "description": "version" + "format": "int32" }, "name": { - "type": "string", - "description": "name" + "type": "string" }, "registrationDate": { - "type": "string", - "description": "registrationDate" + "type": "string" }, "endDate": { - "type": "string", - "description": "endDate" + "type": "string" }, "language": { - "type": "string", - "description": "language" + "type": "string" }, "source": { "type": "integer", - "format": "int32", - "description": "source" + "format": "int32" } } - }, - "description": "languages" + } }, "registedOffices": { "type": "array", @@ -407,38 +335,30 @@ "properties": { "order": { "type": "integer", - "format": "int32", - "description": "order" + "format": "int32" }, "version": { "type": "integer", - "format": "int32", - "description": "version" + "format": "int32" }, "name": { - "type": "string", - "description": "name" + "type": "string" }, "registrationDate": { - "type": "string", - "description": "registrationDate" + "type": "string" }, "endDate": { - "type": "string", - "description": "endDate" + "type": "string" }, "language": { - "type": "string", - "description": "language" + "type": "string" }, "source": { "type": "integer", - "format": "int32", - "description": "source" + "format": "int32" } } - }, - "description": "registedOffices" + } }, "contactDetails": { "type": "array", @@ -446,39 +366,30 @@ "type": "object", "properties": { "value": { - "type": "integer", - "format": "int32", - "description": "value" + "type": "string" }, "version": { "type": "integer", - "format": "int32", - "description": "version" + "format": "int32" }, "name": { - "type": "string", - "description": "name" + "type": "string" }, "registrationDate": { - "type": "string", - "description": "registrationDate" + "type": "string" }, "endDate": { - "type": "string", - "description": "endDate" + "type": "string" }, "language": { - "type": "string", - "description": "language" + "type": "string" }, "source": { "type": "integer", - "format": "int32", - "description": "source" + "format": "int32" } } - }, - "description": "contactDetails" + } }, "registeredEntries": { "type": "array", @@ -487,42 +398,33 @@ "properties": { "authority": { "type": "integer", - "format": "int32", - "description": "authority" + "format": "int32" }, "register": { "type": "integer", - "format": "int32", - "description": "register" + "format": "int32" }, "status": { "type": "integer", - "format": "int32", - "description": "status" + "format": "int32" }, "registrationDate": { - "type": "string", - "description": "registrationDate" + "type": "string" }, "endDate": { - "type": "string", - "description": "endDate" + "type": "string" }, "statusDate": { - "type": "string", - "description": "statusDate" + "type": "string" }, "language": { - "type": "string", - "description": "language" + "type": "string" }, "description": { - "type": "string", - "description": "description" + "type": "string" } } - }, - "description": "registeredEntries" + } }, "businessIdChanges": { "type": "array", @@ -531,45 +433,35 @@ "properties": { "source": { "type": "integer", - "format": "int32", - "description": "source" + "format": "int32" }, "description": { - "type": "string", - "description": "description" + "type": "string" }, "reason": { - "type": "string", - "description": "reason" + "type": "string" }, "changeDate": { - "type": "string", - "description": "changeDate" + "type": "string" }, "change": { "type": "integer", - "format": "int32", - "description": "change" + "format": "int32" }, "oldBusinessId": { - "type": "string", - "description": "oldBusinessId" + "type": "string" }, "newBusinessId": { - "type": "string", - "description": "newBusinessId" + "type": "string" }, - "language ": { - "type": "string", - "description": "language " + "language": { + "type": "string" } } - }, - "description": "businessIdChanges" + } } } - }, - "description": "results" + } } } } @@ -601,39 +493,32 @@ "properties": { "type": { "type": "string", - "description": "", "title": "Type" }, "version": { "type": "string", - "description": "", "title": "Version" }, "totalResults": { "type": "integer", "format": "int32", - "description": "", "title": "Total results" }, "resultsFrom": { "type": "integer", "format": "int32", - "description": "", "title": "Results from" }, "previousResultsUri": { "type": "string", - "description": "", "title": "Previous results URI" }, "nextResultsUri": { "type": "string", - "description": "", "title": "Next results URI" }, "exceptionNoticeUri": { "type": "string", - "description": "", "title": "Exception notice URL" }, "results": { @@ -643,32 +528,27 @@ "properties": { "businessId": { "type": "string", - "description": "", "title": "Business Id" }, "name": { "type": "string", - "description": "", "title": "Company name" }, "registrationDate": { "type": "string", - "description": "", "title": "Registration date" }, "companyForm": { "type": "string", - "description": "", "title": "Company form" }, "detailsUri": { "type": "string", - "description": "", "title": "Details URL" } } - }, - "description": "results" + } + } } } diff --git a/independent-publisher-connectors/Finnish BIS/apiProperties.json b/independent-publisher-connectors/Finnish BIS/apiProperties.json index 36c6976840..1f640bf16d 100644 --- a/independent-publisher-connectors/Finnish BIS/apiProperties.json +++ b/independent-publisher-connectors/Finnish BIS/apiProperties.json @@ -3,7 +3,7 @@ "connectionParameters": {}, "iconBrandColor": "#da3b01", "capabilities": [], - "publisher": "Timo Pertilä", + "publisher": "Timo Pertila", "stackOwner": "https://www.ytj.fi/en" } } \ No newline at end of file diff --git a/independent-publisher-connectors/Star Wars/apiDefinition.swagger.json b/independent-publisher-connectors/Star Wars/apiDefinition.swagger.json index 9459684256..3b9cc7ce77 100644 --- a/independent-publisher-connectors/Star Wars/apiDefinition.swagger.json +++ b/independent-publisher-connectors/Star Wars/apiDefinition.swagger.json @@ -56,7 +56,7 @@ } }, "parameters": [{ - "name": "Search", + "name": "search", "in": "query", "required": false, "type": "string", @@ -64,13 +64,7 @@ "x-ms-summary": "Search string", "description": "Search species by name" }, { - "name": "Page", - "in": "query", - "required": false, - "type": "integer", - "format": "int32", - "description": "Page number", - "x-ms-summary": "Page number" + "$ref": "#/parameters/Page" } ], "summary": "Get All Species" @@ -100,13 +94,7 @@ "x-ms-summary": "Search string", "description": "Search sharships by name" }, { - "name": "Page", - "in": "query", - "required": false, - "type": "integer", - "format": "int32", - "description": "Page number", - "x-ms-summary": "Page number" + "$ref": "#/parameters/Page" } ], "summary": "Get all starships" @@ -158,13 +146,7 @@ "x-ms-summary": "Search string", "description": "Search films by name" }, { - "name": "Page", - "in": "query", - "required": false, - "type": "integer", - "format": "int32", - "description": "Page number", - "x-ms-summary": "Page number" + "$ref": "#/parameters/Page" } ], "summary": "Get all films" @@ -239,13 +221,7 @@ "x-ms-summary": "Search string", "description": "Search planets by name" }, { - "name": "Page", - "in": "query", - "required": false, - "type": "integer", - "format": "int32", - "description": "Page number", - "x-ms-summary": "Page number" + "$ref": "#/parameters/Page" } ] } @@ -269,13 +245,7 @@ "x-ms-summary": "Search string", "description": "Search people by name" }, { - "name": "Page", - "in": "query", - "required": false, - "type": "integer", - "format": "int32", - "description": "Page number", - "x-ms-summary": "Page number" + "$ref": "#/parameters/Page" } ], "summary": "Get People", @@ -852,7 +822,17 @@ "propertyValue": "Lifestyle and Entertainment" } ], - "parameters": {}, + "parameters": { + "Page": { + "name": "page", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Page number", + "x-ms-summary": "Page number" + } + }, "responses": {}, "securityDefinitions": {}, "security": [], diff --git a/independent-publisher-connectors/haveibeenpwned/apiDefinition.swagger.json b/independent-publisher-connectors/haveibeenpwned/apiDefinition.swagger.json index 2b98bd5484..462a6bb90c 100644 --- a/independent-publisher-connectors/haveibeenpwned/apiDefinition.swagger.json +++ b/independent-publisher-connectors/haveibeenpwned/apiDefinition.swagger.json @@ -333,7 +333,7 @@ } }, "summary": "Getting all breached sites in the system", - "description": "A breach is an instance of a system having been compromised by an attacker and the data disclosed. For example, Adobe was a breach, Gawker was a breach etc. It is possible to return the details of each of breach in the system.", + "description": "A breach is an instance of a system having been compromised by an attacker and the data disclosed.", "operationId": "AllBreaches", "parameters": [] } From f667b483c8a4a0f0f115995d8111b8c4d3fffd83 Mon Sep 17 00:00:00 2001 From: Troy Taylor <44444967+troystaylor@users.noreply.github.com> Date: Mon, 6 Jun 2022 17:57:06 -0400 Subject: [PATCH 04/21] Revert "Revert "Merge branch 'microsoft:dev' into dev"" This reverts commit a3f086ef0f4e8b47ec14e9287ec7ebc29a09ea33. --- .../apiDefinition.swagger.json | 59 +++++++++++-------- .../SmartCOMM On Demand Doc-Gen/script.csx | 19 ++++++ 2 files changed, 54 insertions(+), 24 deletions(-) create mode 100644 certified-connectors/SmartCOMM On Demand Doc-Gen/script.csx diff --git a/certified-connectors/SmartCOMM On Demand Doc-Gen/apiDefinition.swagger.json b/certified-connectors/SmartCOMM On Demand Doc-Gen/apiDefinition.swagger.json index df16750498..d1a6fecbf7 100644 --- a/certified-connectors/SmartCOMM On Demand Doc-Gen/apiDefinition.swagger.json +++ b/certified-connectors/SmartCOMM On Demand Doc-Gen/apiDefinition.swagger.json @@ -10,7 +10,7 @@ "email": "support@smartcommunications.com" } }, - "host": "ap10-sb.smartcommunications.cloud", + "host": "eu10-sb.smartcommunications.cloud", "basePath": "/", "schemes": [ "https" @@ -22,7 +22,7 @@ "application/json" ], "paths": { - "/one/oauth2/api/v10/job/generateDocument": { + "/one/oauth2/api/v11/job/generateDocument": { "post": { "summary": "Generate Document", "description": "This function generates a document.", @@ -47,8 +47,9 @@ "required": true, "type": "string", "default": "application/json", - "description": "The API accepts both XML and JSON requests. The request type is determined by the \u2018Content-Type\u2019 HTTP header in the request.", - "x-ms-summary": "Content-Type" + "description": "The API accepts both XML and JSON requests. The request type is determined by the 'Content-Type' HTTP header in the request.", + "x-ms-summary": "Content-Type", + "x-ms-visibility": "internal" }, { "name": "Accept", @@ -56,8 +57,9 @@ "required": true, "type": "string", "default": "application/json", - "description": "The API accepts both XML and JSON responses. The response type is determined by the \u2018Accept\u2019 HTTP header in the request.", - "x-ms-summary": "Accept" + "description": "The API accepts both XML and JSON responses. The response type is determined by the 'Accept' HTTP header in the request.", + "x-ms-summary": "Accept", + "x-ms-visibility": "internal" }, { "name": "body", @@ -68,18 +70,19 @@ "properties": { "projectId": { "type": "integer", - "format": "int32", + "format": "int64", "description": "The CMS project ID used to scope the request execution. If this value is not specified then the job will execute in production mode.", - "title": "projectId" + "title": "projectId", + "x-ms-summary": "Project ID" }, "transactionData": { "type": "string", - "description": "The sample data. The data is encoded as Base64.", + "description": "The sample data.", "title": "transactionData" }, "batchConfigResId": { "type": "integer", - "format": "int32", + "format": "int64", "description": "The CMS ID of the Template Selector resource. The Template Selector is used to map the transaction data to the Template and Data Model.", "title": "batchConfigResId" }, @@ -94,7 +97,11 @@ "type": "string", "description": "The content type of the transaction data. Can be 'application/xml' or 'application/json'. Defaults to 'application/xml'.", "title": "transactionDataType", - "default": "application/xml" + "default": "application/xml", + "enum": [ + "application/xml", + "application/json" + ] }, "properties": { "type": "array", @@ -136,13 +143,13 @@ "properties": { "classId": { "type": "integer", - "format": "int32", + "format": "int64", "description": "The code of the business exception.", "title": "classId" }, "id": { "type": "integer", - "format": "int32", + "format": "int64", "description": "The unique ID of the business exception.", "title": "id" }, @@ -185,18 +192,20 @@ "type": "object", "properties": { "startPage": { - "type": "string", + "type": "integer", + "format": "int32", "description": "The start page number of an enclosed document in the primary merged print document.", "title": "startPage" }, "pageCount": { - "type": "string", + "type": "integer", + "format": "int32", "description": "The number of pages in the document generated.", "title": "pageCount" }, "channelType": { "type": "integer", - "format": "int32", + "format": "int64", "description": "The type of the channel. Possible types are: '1' TYPE_HTML '2' TYPE_PRINT '3' TYPE_SMS '4' TYPE_TEXT '5' TYPE_TML '6' TYPE_XML '7' TYPE_WORDML '8' TYPE_XSLFO.", "title": "channelType" }, @@ -239,7 +248,7 @@ }, "channelId": { "type": "integer", - "format": "int32", + "format": "int64", "description": "The channel Id of the document.", "title": "channelId" }, @@ -257,16 +266,18 @@ "type": "object", "properties": { "startPage": { - "type": "string", + "type": "integer", + "format": "int32", "description": "startPage" }, "pageCount": { - "type": "string", + "type": "integer", + "format": "int32", "description": "pageCount" }, "channelType": { "type": "integer", - "format": "int32", + "format": "int64", "description": "channelType" }, "channelName": { @@ -304,7 +315,7 @@ }, "channelId": { "type": "integer", - "format": "int32", + "format": "int64", "description": "channelId" }, "partLocation": { @@ -339,7 +350,7 @@ }, "destID": { "type": "integer", - "format": "int32", + "format": "int64", "description": "The ID of the destination.", "title": "destID" }, @@ -420,8 +431,8 @@ "oauth2_auth": { "type": "oauth2", "flow": "accessCode", - "authorizationUrl": "https://ap10-sb.smartcommunications.cloud/one/oauth2Server/authorize", - "tokenUrl": "https://ap10-sb.smartcommunications.cloud/one/oauth2Server/token", + "authorizationUrl": "https://eu10-sb.smartcommunications.cloud/one/oauth2Server/authorize", + "tokenUrl": "https://eu10-sb.smartcommunications.cloud/one/oauth2Server/token", "scopes": {} } }, diff --git a/certified-connectors/SmartCOMM On Demand Doc-Gen/script.csx b/certified-connectors/SmartCOMM On Demand Doc-Gen/script.csx new file mode 100644 index 0000000000..0cde3c14f7 --- /dev/null +++ b/certified-connectors/SmartCOMM On Demand Doc-Gen/script.csx @@ -0,0 +1,19 @@ +public class Script : ScriptBase +{ + public override async Task ExecuteAsync() + { + await this.UpdateRequest().ConfigureAwait(false); + var response = await this.Context.SendAsync(this.Context.Request, this.CancellationToken).ConfigureAwait(false); + return response; + } + + private async Task UpdateRequest() + { + var contentAsString = await this.Context.Request.Content.ReadAsStringAsync().ConfigureAwait(false); + var contentAsJson = JObject.Parse(contentAsString); + var transactionData = (string)contentAsJson["transactionData"]; + var transactionDataBytes = System.Text.Encoding.UTF8.GetBytes(transactionData); + contentAsJson["transactionData"] = System.Convert.ToBase64String(transactionDataBytes); + this.Context.Request.Content = CreateJsonContent(contentAsJson.ToString()); + } +} \ No newline at end of file From eeff7b7a02a5c65406413e7c848ebc718c30183e Mon Sep 17 00:00:00 2001 From: Troy Taylor <44444967+troystaylor@users.noreply.github.com> Date: Wed, 13 Jul 2022 13:52:56 -0400 Subject: [PATCH 05/21] Add files via upload --- .../RescueGroups/apiDefinition.swagger.json | 5589 +++++++++++++++++ .../RescueGroups/apiProperties.json | 23 + .../RescueGroups/readme.md | 37 + 3 files changed, 5649 insertions(+) create mode 100644 independent-publisher-connectors/RescueGroups/apiDefinition.swagger.json create mode 100644 independent-publisher-connectors/RescueGroups/apiProperties.json create mode 100644 independent-publisher-connectors/RescueGroups/readme.md diff --git a/independent-publisher-connectors/RescueGroups/apiDefinition.swagger.json b/independent-publisher-connectors/RescueGroups/apiDefinition.swagger.json new file mode 100644 index 0000000000..dae616f06d --- /dev/null +++ b/independent-publisher-connectors/RescueGroups/apiDefinition.swagger.json @@ -0,0 +1,5589 @@ +{ + "swagger": "2.0", + "info": { + "title": "RescueGroups", + "description": "Since 2002, RescueGroups.org has provided animal welfare organizations with easy to use, free and low-cost services like the Pet Adoption Portal to help maximize animal adoptions.", + "version": "1.0", + "contact": { + "name": "Troy Taylor", + "url": "https://www.hitachisolutions.com", + "email": "ttaylor@hitachisolutions.com" + } + }, + "host": "api.rescuegroups.org", + "basePath": "/v5/", + "schemes": [ + "https" + ], + "consumes": [], + "produces": [], + "paths": { + "/public/animals/breeds/": { + "get": { + "responses": { + "200": { + "description": "default", + "schema": { + "type": "object", + "properties": { + "meta": { + "type": "object", + "properties": { + "count": { + "type": "integer", + "format": "int32", + "description": "The count.", + "title": "Count" + }, + "countReturned": { + "type": "integer", + "format": "int32", + "description": "The count returned.", + "title": "Count Returned" + }, + "pageReturned": { + "type": "integer", + "format": "int32", + "description": "The page returned.", + "title": "Page Returned" + }, + "pages": { + "type": "integer", + "format": "int32", + "description": "The number of pages.", + "title": "Pages" + }, + "limit": { + "type": "integer", + "format": "int32", + "description": "The limit.", + "title": "Limit" + }, + "transactionId": { + "type": "string", + "description": "The transaction identifier.", + "title": "Transaction ID" + } + }, + "title": "Meta" + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type.", + "title": "Type" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "attributes": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name.", + "title": "Name" + } + }, + "title": "Attributes" + }, + "relationships": { + "type": "object", + "properties": { + "species": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type.", + "title": "Type" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "links": { + "type": "object", + "properties": { + "self": { + "type": "string", + "description": "The self.", + "title": "Self" + } + }, + "title": "Links" + } + } + }, + "title": "Data" + }, + "links": { + "type": "object", + "properties": { + "self": { + "type": "string", + "description": "The self.", + "title": "Self" + } + }, + "title": "Links" + } + }, + "title": "Species" + } + }, + "title": "Relationships" + } + } + }, + "title": "Data" + }, + "included": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type.", + "title": "Type" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "attributes": { + "type": "object", + "properties": { + "singular": { + "type": "string", + "description": "The singular.", + "title": "Singular" + }, + "plural": { + "type": "string", + "description": "The plural.", + "title": "Plural" + }, + "youngSingular": { + "type": "string", + "description": "The young singular.", + "title": "Young Singular" + }, + "youngPlural": { + "type": "string", + "description": "The young plural.", + "title": "Young Plural" + } + }, + "title": "Attributes" + } + } + }, + "title": "Included" + }, + "links": { + "type": "object", + "properties": { + "self": { + "type": "string", + "description": "The self.", + "title": "Self" + }, + "first": { + "type": "string", + "description": "The first.", + "title": "First" + }, + "last": { + "type": "string", + "description": "The last.", + "title": "Last" + }, + "next": { + "type": "string", + "description": "The next.", + "title": "Next" + } + }, + "title": "Links" + } + } + } + } + }, + "summary": "Get breeds", + "description": "Retrieves a list of breeds.", + "operationId": "Breed", + "parameters": [ + { + "name": "limit", + "in": "query", + "x-ms-summary": "Limit", + "description": "The limit.", + "required": false, + "type": "integer" + }, + { + "name": "page", + "in": "query", + "x-ms-summary": "Page", + "description": "The page number.", + "required": false, + "type": "integer" + } + ] + } + }, + "/public/animals/breeds/{id}": { + "get": { + "responses": { + "200": { + "description": "default", + "schema": { + "type": "object", + "properties": { + "meta": { + "type": "object", + "properties": { + "count": { + "type": "integer", + "format": "int32", + "description": "The count.", + "title": "Count" + }, + "countReturned": { + "type": "integer", + "format": "int32", + "description": "The count returned.", + "title": "Count Returned" + }, + "pageReturned": { + "type": "integer", + "format": "int32", + "description": "The page returned.", + "title": "Page Returned" + }, + "pages": { + "type": "integer", + "format": "int32", + "description": "The number of pages.", + "title": "Pages" + }, + "limit": { + "type": "integer", + "format": "int32", + "description": "The limit.", + "title": "Limit" + }, + "transactionId": { + "type": "string", + "description": "The transaction identifier.", + "title": "Transaction ID" + } + }, + "title": "Meta" + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type.", + "title": "Type" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "attributes": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name.", + "title": "Name" + } + }, + "title": "Attributes" + }, + "relationships": { + "type": "object", + "properties": { + "species": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type.", + "title": "Type" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "links": { + "type": "object", + "properties": { + "self": { + "type": "string", + "description": "The self.", + "title": "Self" + } + }, + "title": "Links" + } + } + }, + "title": "Data" + }, + "links": { + "type": "object", + "properties": { + "self": { + "type": "string", + "description": "The self.", + "title": "Self" + } + }, + "title": "Links" + } + }, + "title": "Species" + } + }, + "title": "Relationships" + } + } + }, + "title": "Data" + }, + "included": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type.", + "title": "Type" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "attributes": { + "type": "object", + "properties": { + "singular": { + "type": "string", + "description": "The singular.", + "title": "Singular" + }, + "plural": { + "type": "string", + "description": "The plural.", + "title": "Plural" + }, + "youngSingular": { + "type": "string", + "description": "The young singular.", + "title": "Young Singular" + }, + "youngPlural": { + "type": "string", + "description": "The young plural.", + "title": "Young Plural" + } + }, + "title": "Attributes" + } + } + }, + "title": "Included" + }, + "links": { + "type": "object", + "properties": { + "self": { + "type": "string", + "description": "The self.", + "title": "Self" + }, + "first": { + "type": "string", + "description": "The first.", + "title": "First" + }, + "last": { + "type": "string", + "description": "The last.", + "title": "Last" + } + }, + "title": "Links" + } + } + } + } + }, + "summary": "Get breed by ID", + "description": "Retrieves the breed information by identifier.", + "operationId": "BreedID", + "parameters": [ + { + "name": "id", + "in": "path", + "x-ms-summary": "Identifier", + "x-ms-url-encoding": "single", + "description": "The identifier.", + "required": true, + "type": "string" + } + ] + } + }, + "/public/animals/breeds/search/{species}/": { + "get": { + "responses": { + "200": { + "description": "default", + "schema": { + "type": "object", + "properties": { + "meta": { + "type": "object", + "properties": { + "count": { + "type": "integer", + "format": "int32", + "description": "The count.", + "title": "Count" + }, + "countReturned": { + "type": "integer", + "format": "int32", + "description": "The count returned.", + "title": "Count Returned" + }, + "pageReturned": { + "type": "integer", + "format": "int32", + "description": "The page returned.", + "title": "Page Returned" + }, + "pages": { + "type": "integer", + "format": "int32", + "description": "The number of pages.", + "title": "Pages" + }, + "limit": { + "type": "integer", + "format": "int32", + "description": "The limit.", + "title": "Limit" + }, + "transactionId": { + "type": "string", + "description": "The transaction identifier.", + "title": "Transaction ID" + } + }, + "title": "Meta" + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type.", + "title": "Type" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "attributes": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name.", + "title": "Name" + } + }, + "title": "Attributes" + }, + "relationships": { + "type": "object", + "properties": { + "species": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type.", + "title": "Type" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "links": { + "type": "object", + "properties": { + "self": { + "type": "string", + "description": "The self.", + "title": "Self" + } + }, + "title": "Links" + } + } + }, + "title": "Data" + }, + "links": { + "type": "object", + "properties": { + "self": { + "type": "string", + "description": "The self.", + "title": "Self" + } + }, + "title": "Links" + } + }, + "title": "Species" + } + }, + "title": "Relationships" + } + } + }, + "title": "Data" + }, + "included": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type.", + "title": "Type" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "attributes": { + "type": "object", + "properties": { + "singular": { + "type": "string", + "description": "The singular.", + "title": "Singular" + }, + "plural": { + "type": "string", + "description": "The plural.", + "title": "Plural" + }, + "youngSingular": { + "type": "string", + "description": "The young singular.", + "title": "Young Singular" + }, + "youngPlural": { + "type": "string", + "description": "The young plural.", + "title": "Young Plural" + } + }, + "title": "Attributes" + } + } + }, + "title": "Included" + }, + "links": { + "type": "object", + "properties": { + "self": { + "type": "string", + "description": "The self.", + "title": "Self" + }, + "first": { + "type": "string", + "description": "The first.", + "title": "First" + }, + "last": { + "type": "string", + "description": "The last.", + "title": "Last" + }, + "next": { + "type": "string", + "description": "The next.", + "title": "Next" + } + }, + "title": "Links" + } + } + } + } + }, + "summary": "Get breeds by species", + "description": "Retrieves a list of breeds by species.", + "operationId": "BreedSpecies", + "parameters": [ + { + "name": "species", + "in": "path", + "x-ms-summary": "Species", + "x-ms-url-encoding": "single", + "description": "The species.", + "required": true, + "type": "string" + }, + { + "name": "limit", + "in": "query", + "x-ms-summary": "Limit", + "description": "The limit.", + "required": false, + "type": "integer" + }, + { + "name": "page", + "in": "query", + "x-ms-summary": "Page", + "description": "The page number.", + "required": false, + "type": "integer" + } + ] + } + }, + "/public/animals/species/{id}/breeds/": { + "get": { + "responses": { + "200": { + "description": "default", + "schema": { + "type": "object", + "properties": { + "meta": { + "type": "object", + "properties": { + "count": { + "type": "integer", + "format": "int32", + "description": "The count.", + "title": "Count" + }, + "countReturned": { + "type": "integer", + "format": "int32", + "description": "The count returned.", + "title": "Count Returned" + }, + "pageReturned": { + "type": "integer", + "format": "int32", + "description": "The page returned.", + "title": "Page Returned" + }, + "pages": { + "type": "integer", + "format": "int32", + "description": "The number of pages.", + "title": "Pages" + }, + "limit": { + "type": "integer", + "format": "int32", + "description": "The limit.", + "title": "Limit" + }, + "transactionId": { + "type": "string", + "description": "The transaction identifier.", + "title": "Transaction ID" + } + }, + "title": "Meta" + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type.", + "title": "Type" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "attributes": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name.", + "title": "Name" + } + }, + "title": "Attributes" + }, + "relationships": { + "type": "object", + "properties": { + "species": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type.", + "title": "Type" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "links": { + "type": "object", + "properties": { + "self": { + "type": "string", + "description": "The self.", + "title": "Self" + } + }, + "title": "Links" + } + } + }, + "title": "Data" + }, + "links": { + "type": "object", + "properties": { + "self": { + "type": "string", + "description": "The self.", + "title": "Self" + } + }, + "title": "Links" + } + }, + "title": "Species" + } + }, + "title": "Relationships" + } + } + }, + "title": "Data" + }, + "included": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type.", + "title": "Type" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "attributes": { + "type": "object", + "properties": { + "singular": { + "type": "string", + "description": "The singular.", + "title": "Singular" + }, + "plural": { + "type": "string", + "description": "The plural.", + "title": "Plural" + }, + "youngSingular": { + "type": "string", + "description": "The young singular.", + "title": "Young Singular" + }, + "youngPlural": { + "type": "string", + "description": "The young plural.", + "title": "Young Plural" + } + }, + "title": "Attributes" + } + } + }, + "title": "Included" + }, + "links": { + "type": "object", + "properties": { + "self": { + "type": "string", + "description": "The self.", + "title": "Self" + }, + "first": { + "type": "string", + "description": "The first.", + "title": "First" + }, + "last": { + "type": "string", + "description": "The last.", + "title": "Last" + } + }, + "title": "Links" + } + } + } + } + }, + "summary": "Get breeds by species ID", + "description": "Retrieves a list of breeds by species identifier.", + "operationId": "BreedSpeciesID", + "parameters": [ + { + "name": "id", + "in": "path", + "x-ms-summary": "Identifier", + "x-ms-url-encoding": "single", + "description": "The identifier.", + "required": true, + "type": "string" + }, + { + "name": "limit", + "in": "query", + "x-ms-summary": "Limit", + "description": "The limit.", + "required": false, + "type": "integer" + }, + { + "name": "page", + "in": "query", + "x-ms-summary": "Page", + "description": "The page number.", + "required": false, + "type": "integer" + } + ] + } + }, + "/public/orgs/": { + "get": { + "responses": { + "200": { + "description": "default", + "schema": { + "type": "object", + "properties": { + "meta": { + "type": "object", + "properties": { + "count": { + "type": "integer", + "format": "int32", + "description": "The count.", + "title": "Count" + }, + "countReturned": { + "type": "integer", + "format": "int32", + "description": "The count returned.", + "title": "Count Returned" + }, + "pageReturned": { + "type": "integer", + "format": "int32", + "description": "The page returned.", + "title": "Page Returned" + }, + "limit": { + "type": "integer", + "format": "int32", + "description": "The limit.", + "title": "Limit" + }, + "pages": { + "type": "integer", + "format": "int32", + "description": "The number of pages.", + "title": "Pages" + }, + "transactionId": { + "type": "string", + "description": "The transaction identifier.", + "title": "Transaction ID" + } + }, + "title": "Meta" + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type.", + "title": "Type" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "attributes": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name.", + "title": "Name" + }, + "city": { + "type": "string", + "description": "The city.", + "title": "City" + }, + "state": { + "type": "string", + "description": "The state.", + "title": "State" + }, + "postalcode": { + "type": "string", + "description": "The postal code.", + "title": "Postal Code" + }, + "postalcodePlus4": { + "type": "string", + "description": "The postal code plus 4 digits.", + "title": "Postal Code Plus 4" + }, + "country": { + "type": "string", + "description": "The country.", + "title": "Country" + }, + "email": { + "type": "string", + "description": "The email address.", + "title": "Email" + }, + "url": { + "type": "string", + "description": "The URL address.", + "title": "URL" + }, + "facebookUrl": { + "type": "string", + "description": "The Facebook URL address.", + "title": "Facebook URL" + }, + "type": { + "type": "string", + "description": "The type.", + "title": "Type" + }, + "isCommonapplicationAccepted": { + "type": "boolean", + "description": "Whether common application is accepted.", + "title": "Is Common Application Accepted" + }, + "lat": { + "type": "number", + "format": "float", + "description": "The latitude.", + "title": "Lat" + }, + "lon": { + "type": "number", + "format": "float", + "description": "The longitude.", + "title": "Lon" + }, + "coordinates": { + "type": "string", + "description": "The coordinates.", + "title": "Coordinates" + }, + "citystate": { + "type": "string", + "description": "The city and state.", + "title": "City/State" + }, + "street": { + "type": "string", + "description": "The street.", + "title": "Street" + }, + "phone": { + "type": "string", + "description": "The phone.", + "title": "Phone" + }, + "serveAreas": { + "type": "string", + "description": "The areas served.", + "title": "Serve Areas" + }, + "services": { + "type": "string", + "description": "The services.", + "title": "Services" + }, + "about": { + "type": "string", + "description": "The about.", + "title": "About" + }, + "adoptionProcess": { + "type": "string", + "description": "The adoption process.", + "title": "Adoption Process" + }, + "adoptionUrl": { + "type": "string", + "description": "The adoption URL address.", + "title": "Adoption URL" + }, + "donationUrl": { + "type": "string", + "description": "The donation URL address.", + "title": "Donation URL" + }, + "sponsorshipUrl": { + "type": "string", + "description": "The sponsorship URL address.", + "title": "Sponsorship URL" + } + }, + "title": "Attributes" + } + } + }, + "title": "Data" + } + } + } + } + }, + "summary": "Get organizations", + "description": "Retrieves a list of organizations", + "operationId": "Organization", + "parameters": [ + { + "name": "limit", + "in": "query", + "x-ms-summary": "Limit", + "description": "The limit.", + "required": false, + "type": "integer" + }, + { + "name": "page", + "in": "query", + "x-ms-summary": "Page", + "description": "The page number.", + "required": false, + "type": "integer" + } + ] + } + }, + "/public/orgs/{id}": { + "get": { + "responses": { + "200": { + "description": "default", + "schema": { + "type": "object", + "properties": { + "meta": { + "type": "object", + "properties": { + "count": { + "type": "integer", + "format": "int32", + "description": "The count.", + "title": "Count" + }, + "countReturned": { + "type": "integer", + "format": "int32", + "description": "The count returned.", + "title": "Count Returned" + }, + "pageReturned": { + "type": "integer", + "format": "int32", + "description": "The page returned.", + "title": "Page Returned" + }, + "limit": { + "type": "integer", + "format": "int32", + "description": "The limit.", + "title": "Limit" + }, + "pages": { + "type": "integer", + "format": "int32", + "description": "The number of pages.", + "title": "Pages" + }, + "transactionId": { + "type": "string", + "description": "The transaction identifier.", + "title": "Transaction ID" + } + }, + "title": "Meta" + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type.", + "title": "Type" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "attributes": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name.", + "title": "Name" + }, + "city": { + "type": "string", + "description": "The city.", + "title": "City" + }, + "state": { + "type": "string", + "description": "The state.", + "title": "State" + }, + "postalcode": { + "type": "string", + "description": "The postal code.", + "title": "Postal Code" + }, + "postalcodePlus4": { + "type": "string", + "description": "The postal code plus 4 digits.", + "title": "Postal Code Plus 4" + }, + "country": { + "type": "string", + "description": "The country.", + "title": "Country" + }, + "email": { + "type": "string", + "description": "The email address.", + "title": "Email" + }, + "url": { + "type": "string", + "description": "The URL address.", + "title": "URL" + }, + "facebookUrl": { + "type": "string", + "description": "The Facebook URL address.", + "title": "Facebook URL" + }, + "type": { + "type": "string", + "description": "The type.", + "title": "Type" + }, + "isCommonapplicationAccepted": { + "type": "boolean", + "description": "Whether common application is accepted.", + "title": "Is Common Application Accepted" + }, + "lat": { + "type": "number", + "format": "float", + "description": "The latitude.", + "title": "Lat" + }, + "lon": { + "type": "number", + "format": "float", + "description": "The longitude.", + "title": "Lon" + }, + "coordinates": { + "type": "string", + "description": "The coordinates.", + "title": "Coordinates" + }, + "citystate": { + "type": "string", + "description": "The city and state.", + "title": "City/State" + } + }, + "title": "Attributes" + } + } + }, + "title": "Data" + } + } + } + } + }, + "summary": "Get organization by ID", + "description": "Retrieve an organization by identifier.", + "operationId": "OrganizationID", + "parameters": [ + { + "name": "id", + "in": "path", + "x-ms-summary": "Identifier", + "x-ms-url-encoding": "single", + "description": "The identifier.", + "required": true, + "type": "string" + } + ] + } + }, + "/public/animals/": { + "get": { + "responses": { + "200": { + "description": "default", + "schema": { + "type": "object", + "properties": { + "meta": { + "type": "object", + "properties": { + "count": { + "type": "integer", + "format": "int32", + "description": "The count.", + "title": "Count" + }, + "countReturned": { + "type": "integer", + "format": "int32", + "description": "The count returned.", + "title": "Count Returned" + }, + "pageReturned": { + "type": "integer", + "format": "int32", + "description": "The page returned.", + "title": "Page Returned" + }, + "limit": { + "type": "integer", + "format": "int32", + "description": "The limit.", + "title": "Limit" + }, + "pages": { + "type": "integer", + "format": "int32", + "description": "The number of pages.", + "title": "Pages" + }, + "transactionId": { + "type": "string", + "description": "The transaction identifier.", + "title": "Transaction ID" + } + }, + "title": "Meta" + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type.", + "title": "Type" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "attributes": { + "type": "object", + "properties": { + "adoptedDate": { + "type": "string", + "description": "The adoption date.", + "title": "Adopted Date" + }, + "isAdoptionPending": { + "type": "boolean", + "description": "Whether adoption is pending.", + "title": "Is Adoption Pending" + }, + "ageGroup": { + "type": "string", + "description": "The age group.", + "title": "Age Group" + }, + "ageString": { + "type": "string", + "description": "The age.", + "title": "Age" + }, + "birthDate": { + "type": "string", + "description": "The birth date.", + "title": "Birth Date" + }, + "isBirthDateExact": { + "type": "boolean", + "description": "Whether birth date is exact.", + "title": "Is Birth Date Exact" + }, + "breedString": { + "type": "string", + "description": "The breed.", + "title": "Breed" + }, + "breedPrimary": { + "type": "string", + "description": "The primary breed.", + "title": "Breed Primary" + }, + "breedPrimaryId": { + "type": "integer", + "format": "int32", + "description": "The primary breed identifier.", + "title": "Breed Primary ID" + }, + "breedSecondary": { + "type": "string", + "description": "The secondary breed.", + "title": "Breed Secondary" + }, + "breedSecondaryId": { + "type": "integer", + "format": "int32", + "description": "The secondary breed identifier.", + "title": "Breed Secondary ID" + }, + "colorDetails": { + "type": "string", + "description": "The color details.", + "title": "Color Details" + }, + "isCourtesyListing": { + "type": "boolean", + "description": "Whether listing is courtesy.", + "title": "Is Courtesy Listing" + }, + "descriptionHtml": { + "type": "string", + "description": "The description in HTML.", + "title": "Description Html" + }, + "descriptionText": { + "type": "string", + "description": "The description text.", + "title": "Description Text" + }, + "isNeedingFoster": { + "type": "boolean", + "description": "Whether is needing foster.", + "title": "Is Needing Foster" + }, + "isFound": { + "type": "boolean", + "description": "Whether was found.", + "title": "Is Found" + }, + "priority": { + "type": "integer", + "format": "int32", + "description": "The priority.", + "title": "Priority" + }, + "name": { + "type": "string", + "description": "The name.", + "title": "Name" + }, + "pictureCount": { + "type": "integer", + "format": "int32", + "description": "The picture count.", + "title": "Picture Count" + }, + "pictureThumbnailUrl": { + "type": "string", + "description": "The thumbnail picture URL address.", + "title": "Picture Thumbnail URL" + }, + "searchString": { + "type": "string", + "description": "The search string.", + "title": "Search String" + }, + "sex": { + "type": "string", + "description": "The sex.", + "title": "Sex" + }, + "sizeUOM": { + "type": "string", + "description": "The size unit of measurement.", + "title": "Size UOM" + }, + "slug": { + "type": "string", + "description": "The slug.", + "title": "Slug" + }, + "isSponsorable": { + "type": "boolean", + "description": "Whether is sponsorable.", + "title": "Is Sponsorable" + }, + "trackerimageUrl": { + "type": "string", + "description": "The tracker image URL address.", + "title": "Tracker Image URL" + }, + "url": { + "type": "string", + "description": "The URL address.", + "title": "URL" + }, + "videoCount": { + "type": "integer", + "format": "int32", + "description": "The video count.", + "title": "Video Count" + }, + "videoUrlCount": { + "type": "integer", + "format": "int32", + "description": "The video URL count.", + "title": "Video URL Count" + }, + "createdDate": { + "type": "string", + "description": "The date created.", + "title": "Created Date" + }, + "updatedDate": { + "type": "string", + "description": "When updated date.", + "title": "Updated Date" + }, + "activityLevel": { + "type": "string", + "description": "The activity level.", + "title": "Activity Level" + }, + "adoptionFeeString": { + "type": "string", + "description": "The adoption fee.", + "title": "Adoption Fee" + }, + "isBreedMixed": { + "type": "boolean", + "description": "Whether is a mixed breed.", + "title": "Is Breed Mixed" + }, + "isCatsOk": { + "type": "boolean", + "description": "Whether is okay with cats.", + "title": "Is Cats Ok" + }, + "coatLength": { + "type": "string", + "description": "The coat length.", + "title": "Coat Length" + }, + "isCurrentVaccinations": { + "type": "boolean", + "description": "Whether is current with vaccinations.", + "title": "Is Current Vaccinations" + }, + "isDogsOk": { + "type": "boolean", + "description": "Whether is okay with dogs.", + "title": "Is Dogs Ok" + }, + "isKidsOk": { + "type": "boolean", + "description": "Whether is okay with kids.", + "title": "Is Kids Ok" + }, + "newPeopleReaction": { + "type": "string", + "description": "The reaction with new people.", + "title": "New People Reaction" + }, + "ownerExperience": { + "type": "string", + "description": "The previous owner experience.", + "title": "Owner Experience" + }, + "sizeCurrent": { + "type": "number", + "format": "float", + "description": "The current size.", + "title": "Size Current" + }, + "sizeGroup": { + "type": "string", + "description": "The group size.", + "title": "Size Group" + }, + "sizePotential": { + "type": "integer", + "format": "int32", + "description": "The potential size.", + "title": "Size Potential" + }, + "isSpecialNeeds": { + "type": "boolean", + "description": "Whether is special needs.", + "title": "Is Special Needs" + }, + "availableDate": { + "type": "string", + "description": "The date available.", + "title": "Available Date" + }, + "isHousetrained": { + "type": "boolean", + "description": "Whether is house-trained.", + "title": "Is House-trained" + }, + "rescueId": { + "type": "string", + "description": "The rescue identifier.", + "title": "Rescue ID" + }, + "adultSexesOk": { + "type": "string", + "description": "The adult sexes okay with.", + "title": "Adult Sexes Ok" + }, + "energyLevel": { + "type": "string", + "description": "The energy level.", + "title": "Energy Level" + }, + "fenceNeeds": { + "type": "string", + "description": "The fence needs.", + "title": "Fence Needs" + }, + "groomingNeeds": { + "type": "string", + "description": "The grooming needs.", + "title": "Grooming Needs" + }, + "obedienceTraining": { + "type": "string", + "description": "The obedience training.", + "title": "Obedience Training" + }, + "qualities": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The qualities.", + "title": "Qualities" + }, + "vocalLevel": { + "type": "string", + "description": "The vocal level.", + "title": "Vocal Level" + }, + "isYardRequired": { + "type": "boolean", + "description": "Whether yard is required.", + "title": "Is Yard Required" + }, + "specialNeedsDetails": { + "type": "string", + "description": "The special needs details.", + "title": "Special Needs Details" + }, + "exerciseNeeds": { + "type": "string", + "description": "The exercise needs.", + "title": "Exercise Needs" + }, + "indoorOutdoor": { + "type": "string", + "description": "The indoor and outdoor preference.", + "title": "Indoor Outdoor" + }, + "sheddingLevel": { + "type": "string", + "description": "The shedding level.", + "title": "Shedding Level" + }, + "summary": { + "type": "string", + "description": "The summary.", + "title": "Summary" + }, + "isDeclawed": { + "type": "boolean", + "description": "Whether is declawed.", + "title": "Is Declawed" + }, + "earType": { + "type": "string", + "description": "The ear type.", + "title": "Ear Type" + }, + "eyeColor": { + "type": "string", + "description": "The eye color.", + "title": "Eye Color" + }, + "tailType": { + "type": "string", + "description": "The tail type.", + "title": "Tail Type" + }, + "killReason": { + "type": "string", + "description": "The kill reason.", + "title": "Kill Reason" + } + }, + "title": "Attributes" + }, + "relationships": { + "type": "object", + "properties": { + "breeds": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type.", + "title": "Type" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + } + } + }, + "title": "Data" + } + }, + "title": "Breeds" + }, + "species": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type.", + "title": "Type" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + } + } + }, + "title": "Data" + } + }, + "title": "Species" + }, + "statuses": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type.", + "title": "Type" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + } + } + }, + "title": "Data" + } + }, + "title": "Statuses" + }, + "locations": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type.", + "title": "Type" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + } + } + }, + "title": "Data" + } + }, + "title": "Locations" + }, + "orgs": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type.", + "title": "Type" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + } + } + }, + "title": "Data" + } + }, + "title": "Orgs" + }, + "pictures": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type.", + "title": "Type" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + } + } + }, + "title": "Data" + } + }, + "title": "Pictures" + }, + "colors": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type.", + "title": "Type" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + } + } + }, + "title": "Data" + } + }, + "title": "Colors" + }, + "videourls": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type.", + "title": "Type" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + } + } + }, + "title": "Data" + } + }, + "title": "Video URLs" + } + }, + "title": "Relationships" + } + } + }, + "title": "Data" + }, + "included": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type.", + "title": "Type" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "attributes": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name.", + "title": "Name" + }, + "singular": { + "type": "string", + "description": "The singular.", + "title": "Singular" + }, + "plural": { + "type": "string", + "description": "The plural.", + "title": "Plural" + }, + "youngSingular": { + "type": "string", + "description": "The young singular.", + "title": "Young Singular" + }, + "youngPlural": { + "type": "string", + "description": "The young plural.", + "title": "Young Plural" + }, + "description": { + "type": "string", + "description": "The description.", + "title": "Description" + }, + "street": { + "type": "string", + "description": "The street.", + "title": "Street" + }, + "city": { + "type": "string", + "description": "The city.", + "title": "City" + }, + "state": { + "type": "string", + "description": "The state.", + "title": "State" + }, + "citystate": { + "type": "string", + "description": "The city and state.", + "title": "City/State" + }, + "postalcode": { + "type": "string", + "description": "The postal code.", + "title": "Postal Code" + }, + "country": { + "type": "string", + "description": "The country.", + "title": "Country" + }, + "phone": { + "type": "string", + "description": "The phone.", + "title": "Phone" + }, + "lat": { + "type": "number", + "format": "float", + "description": "The latitude.", + "title": "Lat" + }, + "lon": { + "type": "number", + "format": "float", + "description": "The longitude.", + "title": "Lon" + }, + "coordinates": { + "type": "string", + "description": "The coordinates.", + "title": "Coordinates" + }, + "email": { + "type": "string", + "description": "The email address.", + "title": "Email" + }, + "url": { + "type": "string", + "description": "The URL address.", + "title": "URL" + }, + "facebookUrl": { + "type": "string", + "description": "The Facebook URL address.", + "title": "Facebook URL" + }, + "type": { + "type": "string", + "description": "The type.", + "title": "Type" + }, + "original": { + "type": "object", + "properties": { + "filesize": { + "type": "integer", + "format": "int32", + "description": "The file size.", + "title": "File Size" + }, + "resolutionX": { + "type": "integer", + "format": "int32", + "description": "The x resolution.", + "title": "Resolution X" + }, + "resolutionY": { + "type": "integer", + "format": "int32", + "description": "The y resolution.", + "title": "Resolution Y" + }, + "url": { + "type": "string", + "description": "The URL address.", + "title": "URL" + } + }, + "title": "Original" + }, + "large": { + "type": "object", + "properties": { + "filesize": { + "type": "integer", + "format": "int32", + "description": "The file size.", + "title": "File Size" + }, + "resolutionX": { + "type": "integer", + "format": "int32", + "description": "The x resolution.", + "title": "Resolution X" + }, + "resolutionY": { + "type": "integer", + "format": "int32", + "description": "The y resolution.", + "title": "Resolution Y" + }, + "url": { + "type": "string", + "description": "The URL address.", + "title": "URL" + } + }, + "title": "Large" + }, + "small": { + "type": "object", + "properties": { + "filesize": { + "type": "integer", + "format": "int32", + "description": "The file size.", + "title": "File Size" + }, + "resolutionX": { + "type": "integer", + "format": "int32", + "description": "The x resolution.", + "title": "Resolution X" + }, + "resolutionY": { + "type": "integer", + "format": "int32", + "description": "The y resolution.", + "title": "Resolution Y" + }, + "url": { + "type": "string", + "description": "The URL address.", + "title": "URL" + } + }, + "title": "Small" + }, + "order": { + "type": "integer", + "format": "int32", + "description": "The order.", + "title": "Order" + }, + "created": { + "type": "string", + "description": "When created.", + "title": "Created" + }, + "updated": { + "type": "string", + "description": "When updated.", + "title": "Updated" + }, + "services": { + "type": "string", + "description": "The services.", + "title": "Services" + }, + "adoptionProcess": { + "type": "string", + "description": "The adoption process.", + "title": "Adoption Process" + }, + "about": { + "type": "string", + "description": "The about.", + "title": "About" + }, + "adoptionUrl": { + "type": "string", + "description": "The adoption URL address.", + "title": "Adoption URL" + }, + "donationUrl": { + "type": "string", + "description": "The donation URL address.", + "title": "Donation URL" + }, + "videoId": { + "type": "string", + "description": "The video identifier.", + "title": "Video ID" + }, + "urlThumbnail": { + "type": "string", + "description": "The thumbnail URL address.", + "title": "URL Thumbnail" + } + }, + "title": "Attributes" + }, + "links": { + "type": "object", + "properties": { + "self": { + "type": "string", + "description": "The self.", + "title": "Self" + } + }, + "title": "Links" + } + } + }, + "title": "Included" + } + } + } + } + }, + "summary": "Get animals", + "description": "Retrieve a list of animals.", + "operationId": "Animal", + "parameters": [ + { + "name": "limit", + "in": "query", + "x-ms-summary": "Limit", + "description": "The limit.", + "required": false, + "type": "integer" + }, + { + "name": "page", + "in": "query", + "x-ms-summary": "Page", + "description": "The page number.", + "required": false, + "type": "integer" + } + ] + } + }, + "/public/animals/search/{status}/": { + "get": { + "responses": { + "200": { + "description": "default", + "schema": { + "type": "object", + "properties": { + "meta": { + "type": "object", + "properties": { + "count": { + "type": "integer", + "format": "int32", + "description": "The count.", + "title": "Count" + }, + "countReturned": { + "type": "integer", + "format": "int32", + "description": "The count returned.", + "title": "Count Returned" + }, + "pageReturned": { + "type": "integer", + "format": "int32", + "description": "The page returned.", + "title": "Page Returned" + }, + "limit": { + "type": "integer", + "format": "int32", + "description": "The limit.", + "title": "Limit" + }, + "pages": { + "type": "integer", + "format": "int32", + "description": "The number of pages.", + "title": "Pages" + }, + "transactionId": { + "type": "string", + "description": "The transaction identifier.", + "title": "Transaction ID" + } + }, + "title": "Meta" + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type.", + "title": "Type" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "attributes": { + "type": "object", + "properties": { + "isAdoptionPending": { + "type": "boolean", + "description": "Whether adoption is pending.", + "title": "Is Adoption Pending" + }, + "ageGroup": { + "type": "string", + "description": "The age group.", + "title": "Age Group" + }, + "ageString": { + "type": "string", + "description": "The age.", + "title": "Age" + }, + "birthDate": { + "type": "string", + "description": "The birth date.", + "title": "Birth Date" + }, + "isBirthDateExact": { + "type": "boolean", + "description": "Whether birth date is exact.", + "title": "Is Birth Date Exact" + }, + "breedString": { + "type": "string", + "description": "The breed.", + "title": "Breed" + }, + "breedPrimary": { + "type": "string", + "description": "The primary breed.", + "title": "Breed Primary" + }, + "breedPrimaryId": { + "type": "integer", + "format": "int32", + "description": "The primary breed identifier.", + "title": "Breed Primary ID" + }, + "breedSecondary": { + "type": "string", + "description": "The secondary breed.", + "title": "Breed Secondary" + }, + "breedSecondaryId": { + "type": "integer", + "format": "int32", + "description": "The secondary breed identifier.", + "title": "Breed Secondary ID" + }, + "coatLength": { + "type": "string", + "description": "The coat length.", + "title": "Coat Length" + }, + "isCourtesyListing": { + "type": "boolean", + "description": "Whether listing is courtesy.", + "title": "Is Courtesy Listing" + }, + "descriptionHtml": { + "type": "string", + "description": "The description in HTML.", + "title": "Description Html" + }, + "descriptionText": { + "type": "string", + "description": "The description text.", + "title": "Description Text" + }, + "isNeedingFoster": { + "type": "boolean", + "description": "Whether is needing foster.", + "title": "Is Needing Foster" + }, + "isFound": { + "type": "boolean", + "description": "Whether was found.", + "title": "Is Found" + }, + "priority": { + "type": "integer", + "format": "int32", + "description": "The priority.", + "title": "Priority" + }, + "name": { + "type": "string", + "description": "The name.", + "title": "Name" + }, + "pictureCount": { + "type": "integer", + "format": "int32", + "description": "The picture count.", + "title": "Picture Count" + }, + "pictureThumbnailUrl": { + "type": "string", + "description": "The thumbnail picture URL address.", + "title": "Picture Thumbnail URL" + }, + "rescueId": { + "type": "string", + "description": "The rescue identifier.", + "title": "Rescue ID" + }, + "searchString": { + "type": "string", + "description": "The search string.", + "title": "Search String" + }, + "sex": { + "type": "string", + "description": "The sex.", + "title": "Sex" + }, + "sizeCurrent": { + "type": "number", + "format": "float", + "description": "The current size.", + "title": "Size Current" + }, + "sizeUOM": { + "type": "string", + "description": "The size unit of measurement.", + "title": "Size UOM" + }, + "slug": { + "type": "string", + "description": "The slug.", + "title": "Slug" + }, + "isSponsorable": { + "type": "boolean", + "description": "Whether is sponsorable.", + "title": "Is Sponsorable" + }, + "trackerimageUrl": { + "type": "string", + "description": "The tracker image URL address.", + "title": "Tracker Image URL" + }, + "videoCount": { + "type": "integer", + "format": "int32", + "description": "The video count.", + "title": "Video Count" + }, + "videoUrlCount": { + "type": "integer", + "format": "int32", + "description": "The video URL count.", + "title": "Video URL Count" + }, + "createdDate": { + "type": "string", + "description": "The date created.", + "title": "Created Date" + }, + "updatedDate": { + "type": "string", + "description": "When updated date.", + "title": "Updated Date" + }, + "isBreedMixed": { + "type": "boolean", + "description": "Whether is a mixed breed.", + "title": "Is Breed Mixed" + }, + "isCatsOk": { + "type": "boolean", + "description": "Whether is okay with cats.", + "title": "Is Cats Ok" + }, + "isCurrentVaccinations": { + "type": "boolean", + "description": "Whether is current with vaccinations.", + "title": "Is Current Vaccinations" + }, + "isDeclawed": { + "type": "boolean", + "description": "Whether is declawed.", + "title": "Is Declawed" + }, + "isDogsOk": { + "type": "boolean", + "description": "Whether is okay with dogs.", + "title": "Is Dogs Ok" + }, + "isHousetrained": { + "type": "boolean", + "description": "Whether is house-trained.", + "title": "Is House-trained" + }, + "isKidsOk": { + "type": "boolean", + "description": "Whether is okay with kids.", + "title": "Is Kids Ok" + }, + "sizeGroup": { + "type": "string", + "description": "The group size.", + "title": "Size Group" + }, + "activityLevel": { + "type": "string", + "description": "The activity level.", + "title": "Activity Level" + }, + "energyLevel": { + "type": "string", + "description": "The energy level.", + "title": "Energy Level" + }, + "indoorOutdoor": { + "type": "string", + "description": "The indoor and outdoor preference.", + "title": "Indoor Outdoor" + }, + "newPeopleReaction": { + "type": "string", + "description": "The reaction with new people.", + "title": "New People Reaction" + }, + "adoptionFeeString": { + "type": "string", + "description": "The adoption fee.", + "title": "Adoption Fee" + }, + "adultSexesOk": { + "type": "string", + "description": "The adult sexes okay with.", + "title": "Adult Sexes Ok" + }, + "exerciseNeeds": { + "type": "string", + "description": "The exercise needs.", + "title": "Exercise Needs" + }, + "fenceNeeds": { + "type": "string", + "description": "The fence needs.", + "title": "Fence Needs" + }, + "groomingNeeds": { + "type": "string", + "description": "The grooming needs.", + "title": "Grooming Needs" + }, + "obedienceTraining": { + "type": "string", + "description": "The obedience training.", + "title": "Obedience Training" + }, + "ownerExperience": { + "type": "string", + "description": "The previous owner experience.", + "title": "Owner Experience" + }, + "sheddingLevel": { + "type": "string", + "description": "The shedding level.", + "title": "Shedding Level" + }, + "isSpecialNeeds": { + "type": "boolean", + "description": "Whether is special needs.", + "title": "Is Special Needs" + }, + "vocalLevel": { + "type": "string", + "description": "The vocal level.", + "title": "Vocal Level" + }, + "isYardRequired": { + "type": "boolean", + "description": "Whether yard is required.", + "title": "Is Yard Required" + }, + "colorDetails": { + "type": "string", + "description": "The color details.", + "title": "Color Details" + }, + "eyeColor": { + "type": "string", + "description": "The eye color.", + "title": "Eye Color" + }, + "killReason": { + "type": "string", + "description": "The kill reason.", + "title": "Kill Reason" + }, + "qualities": { + "type": "array", + "items": { + "type": "string" + }, + "title": "Qualities" + }, + "url": { + "type": "string", + "description": "The URL address.", + "title": "URL" + }, + "sponsorshipMinimum": { + "type": "string", + "description": "The sponsorship minimum.", + "title": "Sponsorship Minimum" + }, + "sponsors": { + "type": "string", + "description": "The sponsors.", + "title": "Sponsors" + }, + "summary": { + "type": "string", + "description": "The summary.", + "title": "Summary" + }, + "foundDate": { + "type": "string", + "description": "The date found.", + "title": "Found Date" + }, + "availableDate": { + "type": "string", + "description": "The date available.", + "title": "Available Date" + }, + "adoptedDate": { + "type": "string", + "description": "The adoption date.", + "title": "Adopted Date" + }, + "sizePotential": { + "type": "integer", + "format": "int32", + "description": "The potential size.", + "title": "Size Potential" + } + }, + "title": "Attributes" + }, + "relationships": { + "type": "object", + "properties": { + "breeds": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type.", + "title": "Type" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + } + } + }, + "title": "Data" + } + }, + "title": "Breeds" + }, + "colors": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type.", + "title": "Type" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + } + } + }, + "title": "Data" + } + }, + "title": "Colors" + }, + "patterns": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type.", + "title": "Type" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + } + } + }, + "title": "Data" + } + }, + "title": "Patterns" + }, + "species": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type.", + "title": "Type" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + } + } + }, + "title": "Data" + } + }, + "title": "Species" + }, + "statuses": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type.", + "title": "Type" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + } + } + }, + "title": "Data" + } + }, + "title": "Statuses" + }, + "locations": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type.", + "title": "Type" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + } + } + }, + "title": "Data" + } + }, + "title": "Locations" + }, + "orgs": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type.", + "title": "Type" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + } + } + }, + "title": "Data" + } + }, + "title": "Orgs" + }, + "pictures": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type.", + "title": "Type" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + } + } + }, + "title": "Data" + } + }, + "title": "Pictures" + }, + "fosters": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type.", + "title": "Type" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + } + } + }, + "title": "Data" + } + }, + "title": "Fosters" + }, + "videos": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type.", + "title": "Type" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + } + } + }, + "title": "Data" + } + }, + "title": "Videos" + }, + "videourls": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type.", + "title": "Type" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + } + } + }, + "title": "Data" + } + }, + "title": "Videourls" + } + }, + "title": "Relationships" + } + } + }, + "title": "Data" + }, + "included": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type.", + "title": "Type" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "attributes": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name.", + "title": "Name" + }, + "singular": { + "type": "string", + "description": "The singular.", + "title": "Singular" + }, + "plural": { + "type": "string", + "description": "The plural.", + "title": "Plural" + }, + "youngSingular": { + "type": "string", + "description": "The young singular.", + "title": "Young Singular" + }, + "youngPlural": { + "type": "string", + "description": "The young plural.", + "title": "Young Plural" + }, + "description": { + "type": "string", + "description": "The description.", + "title": "Description" + }, + "street": { + "type": "string", + "description": "The street.", + "title": "Street" + }, + "city": { + "type": "string", + "description": "The city.", + "title": "City" + }, + "state": { + "type": "string", + "description": "The state.", + "title": "State" + }, + "citystate": { + "type": "string", + "description": "The city and state.", + "title": "City/State" + }, + "postalcode": { + "type": "string", + "description": "The postal code.", + "title": "Postal Code" + }, + "country": { + "type": "string", + "description": "The country.", + "title": "Country" + }, + "phone": { + "type": "string", + "description": "The phone.", + "title": "Phone" + }, + "lat": { + "type": "number", + "format": "float", + "description": "The latitude.", + "title": "Lat" + }, + "lon": { + "type": "number", + "format": "float", + "description": "The longitude.", + "title": "Lon" + }, + "coordinates": { + "type": "string", + "description": "The coordinates.", + "title": "Coordinates" + }, + "email": { + "type": "string", + "description": "The email address.", + "title": "Email" + }, + "url": { + "type": "string", + "description": "The URL address.", + "title": "URL" + }, + "facebookUrl": { + "type": "string", + "description": "The Facebook URL address.", + "title": "Facebook URL" + }, + "adoptionProcess": { + "type": "string", + "description": "The adoption process.", + "title": "Adoption Process" + }, + "about": { + "type": "string", + "description": "The about.", + "title": "About" + }, + "services": { + "type": "string", + "description": "The services.", + "title": "Services" + }, + "type": { + "type": "string", + "description": "The type.", + "title": "Type" + }, + "original": { + "type": "object", + "properties": { + "filesize": { + "type": "integer", + "format": "int32", + "description": "The file size.", + "title": "File Size" + }, + "resolutionX": { + "type": "integer", + "format": "int32", + "description": "The x resolution.", + "title": "Resolution X" + }, + "resolutionY": { + "type": "integer", + "format": "int32", + "description": "The y resolution.", + "title": "Resolution Y" + }, + "url": { + "type": "string", + "description": "The URL address.", + "title": "URL" + } + }, + "title": "Original" + }, + "large": { + "type": "object", + "properties": { + "filesize": { + "type": "integer", + "format": "int32", + "description": "The file size.", + "title": "File Size" + }, + "resolutionX": { + "type": "integer", + "format": "int32", + "description": "The x resolution.", + "title": "Resolution X" + }, + "resolutionY": { + "type": "integer", + "format": "int32", + "description": "The y resolution.", + "title": "Resolution Y" + }, + "url": { + "type": "string", + "description": "The URL address.", + "title": "URL" + } + }, + "title": "Large" + }, + "small": { + "type": "object", + "properties": { + "filesize": { + "type": "integer", + "format": "int32", + "description": "The file size.", + "title": "File Size" + }, + "resolutionX": { + "type": "integer", + "format": "int32", + "description": "The x resolution.", + "title": "Resolution X" + }, + "resolutionY": { + "type": "integer", + "format": "int32", + "description": "The y resolution.", + "title": "Resolution Y" + }, + "url": { + "type": "string", + "description": "The URL address.", + "title": "URL" + } + }, + "title": "Small" + }, + "order": { + "type": "integer", + "format": "int32", + "description": "The order.", + "title": "Order" + }, + "created": { + "type": "string", + "description": "When created.", + "title": "Created" + }, + "updated": { + "type": "string", + "description": "When updated.", + "title": "Updated" + }, + "firstname": { + "type": "string", + "description": "The first name.", + "title": "First Name" + }, + "fullname": { + "type": "string", + "description": "The full name.", + "title": "Full Name" + }, + "adoptionUrl": { + "type": "string", + "description": "The adoption URL address.", + "title": "Adoption URL" + }, + "donationUrl": { + "type": "string", + "description": "The donation URL address.", + "title": "Donation URL" + }, + "sponsorshipUrl": { + "type": "string", + "description": "The sponsorship URL address.", + "title": "Sponsorship URL" + }, + "fileSize": { + "type": "integer", + "format": "int32", + "description": "The file size.", + "title": "File Size" + }, + "videoId": { + "type": "string", + "description": "The video identifier.", + "title": "Video ID" + }, + "urlThumbnail": { + "type": "string", + "description": "The thumbnail URL address.", + "title": "URL Thumbnail" + } + }, + "title": "Attributes" + }, + "links": { + "type": "object", + "properties": { + "self": { + "type": "string", + "description": "The self.", + "title": "Self" + } + }, + "title": "Links" + } + } + }, + "title": "Included" + } + } + } + } + }, + "summary": "Get animals by status", + "description": "Retrieves a list of animals by status.", + "operationId": "AnimalStatus", + "parameters": [ + { + "name": "status", + "in": "path", + "x-ms-summary": "Status", + "x-ms-url-encoding": "single", + "description": "The status.", + "required": true, + "type": "string" + }, + { + "name": "limit", + "in": "query", + "x-ms-summary": "Limit", + "description": "The limit.", + "required": false, + "type": "integer" + }, + { + "name": "page", + "in": "query", + "x-ms-summary": "Page", + "description": "The page number.", + "required": false, + "type": "integer" + } + ] + } + }, + "/public/animals/{id}": { + "get": { + "responses": { + "200": { + "description": "default", + "schema": { + "type": "object", + "properties": { + "meta": { + "type": "object", + "properties": { + "count": { + "type": "integer", + "format": "int32", + "description": "The count.", + "title": "Count" + }, + "countReturned": { + "type": "integer", + "format": "int32", + "description": "The count returned.", + "title": "Count Returned" + }, + "pageReturned": { + "type": "integer", + "format": "int32", + "description": "The page returned.", + "title": "Page Returned" + }, + "limit": { + "type": "integer", + "format": "int32", + "description": "The limit.", + "title": "Limit" + }, + "pages": { + "type": "integer", + "format": "int32", + "description": "The number of pages.", + "title": "Pages" + }, + "transactionId": { + "type": "string", + "description": "The transaction identifier.", + "title": "Transaction ID" + } + }, + "title": "Meta" + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type.", + "title": "Type" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "attributes": { + "type": "object", + "properties": { + "isAdoptionPending": { + "type": "boolean", + "description": "Whether adoption is pending.", + "title": "Is Adoption Pending" + }, + "ageGroup": { + "type": "string", + "description": "The age group.", + "title": "Age Group" + }, + "ageString": { + "type": "string", + "description": "The age.", + "title": "Age" + }, + "birthDate": { + "type": "string", + "description": "The birth date.", + "title": "Birth Date" + }, + "isBirthDateExact": { + "type": "boolean", + "description": "Whether birth date is exact.", + "title": "Is Birth Date Exact" + }, + "breedString": { + "type": "string", + "description": "The breed.", + "title": "Breed" + }, + "breedPrimary": { + "type": "string", + "description": "The primary breed.", + "title": "Breed Primary" + }, + "breedPrimaryId": { + "type": "integer", + "format": "int32", + "description": "The primary breed identifier.", + "title": "Breed Primary ID" + }, + "breedSecondary": { + "type": "string", + "description": "The secondary breed.", + "title": "Breed Secondary" + }, + "breedSecondaryId": { + "type": "integer", + "format": "int32", + "description": "The secondary breed identifier.", + "title": "Breed Secondary ID" + }, + "coatLength": { + "type": "string", + "description": "The coat length.", + "title": "Coat Length" + }, + "isCourtesyListing": { + "type": "boolean", + "description": "Whether listing is courtesy.", + "title": "Is Courtesy Listing" + }, + "descriptionHtml": { + "type": "string", + "description": "The description in HTML.", + "title": "Description Html" + }, + "descriptionText": { + "type": "string", + "description": "The description text.", + "title": "Description Text" + }, + "isNeedingFoster": { + "type": "boolean", + "description": "Whether is needing foster.", + "title": "Is Needing Foster" + }, + "isFound": { + "type": "boolean", + "description": "Whether was found.", + "title": "Is Found" + }, + "priority": { + "type": "integer", + "format": "int32", + "description": "The priority.", + "title": "Priority" + }, + "name": { + "type": "string", + "description": "The name.", + "title": "Name" + }, + "pictureCount": { + "type": "integer", + "format": "int32", + "description": "The picture count.", + "title": "Picture Count" + }, + "pictureThumbnailUrl": { + "type": "string", + "description": "The thumbnail picture URL address.", + "title": "Picture Thumbnail URL" + }, + "rescueId": { + "type": "string", + "description": "The rescue identifier.", + "title": "Rescue ID" + }, + "searchString": { + "type": "string", + "description": "The search string.", + "title": "Search String" + }, + "sex": { + "type": "string", + "description": "The sex.", + "title": "Sex" + }, + "sizeCurrent": { + "type": "number", + "format": "float", + "description": "The current size.", + "title": "Size Current" + }, + "sizeUOM": { + "type": "string", + "description": "The size unit of measurement.", + "title": "Size UOM" + }, + "slug": { + "type": "string", + "description": "The slug.", + "title": "Slug" + }, + "isSponsorable": { + "type": "boolean", + "description": "Whether is sponsorable.", + "title": "Is Sponsorable" + }, + "trackerimageUrl": { + "type": "string", + "description": "The tracker image URL address.", + "title": "Tracker Image URL" + }, + "videoCount": { + "type": "integer", + "format": "int32", + "description": "The video count.", + "title": "Video Count" + }, + "videoUrlCount": { + "type": "integer", + "format": "int32", + "description": "The video URL count.", + "title": "Video URL Count" + }, + "createdDate": { + "type": "string", + "description": "The date created.", + "title": "Created Date" + }, + "updatedDate": { + "type": "string", + "description": "When updated date.", + "title": "Updated Date" + } + }, + "title": "Attributes" + }, + "relationships": { + "type": "object", + "properties": { + "breeds": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type.", + "title": "Type" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + } + } + }, + "title": "Data" + } + }, + "title": "Breeds" + }, + "colors": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type.", + "title": "Type" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + } + } + }, + "title": "Data" + } + }, + "title": "Colors" + }, + "patterns": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type.", + "title": "Type" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + } + } + }, + "title": "Data" + } + }, + "title": "Patterns" + }, + "species": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type.", + "title": "Type" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + } + } + }, + "title": "Data" + } + }, + "title": "Species" + }, + "statuses": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type.", + "title": "Type" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + } + } + }, + "title": "Data" + } + }, + "title": "Statuses" + }, + "locations": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type.", + "title": "Type" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + } + } + }, + "title": "Data" + } + }, + "title": "Locations" + }, + "orgs": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type.", + "title": "Type" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + } + } + }, + "title": "Data" + } + }, + "title": "Orgs" + }, + "pictures": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type.", + "title": "Type" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + } + } + }, + "title": "Data" + } + }, + "title": "Pictures" + } + }, + "title": "Relationships" + } + } + }, + "title": "Data" + }, + "included": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type.", + "title": "Type" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "attributes": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name.", + "title": "Name" + }, + "singular": { + "type": "string", + "description": "The singular.", + "title": "Singular" + }, + "plural": { + "type": "string", + "description": "The plural.", + "title": "Plural" + }, + "youngSingular": { + "type": "string", + "description": "The young singular.", + "title": "Young Singular" + }, + "youngPlural": { + "type": "string", + "description": "The young plural.", + "title": "Young Plural" + }, + "description": { + "type": "string", + "description": "The description.", + "title": "Description" + }, + "street": { + "type": "string", + "description": "The street.", + "title": "Street" + }, + "city": { + "type": "string", + "description": "The city.", + "title": "City" + }, + "state": { + "type": "string", + "description": "The state.", + "title": "State" + }, + "citystate": { + "type": "string", + "description": "The city and state.", + "title": "City/State" + }, + "postalcode": { + "type": "string", + "description": "The postal code.", + "title": "Postal Code" + }, + "country": { + "type": "string", + "description": "The country.", + "title": "Country" + }, + "phone": { + "type": "string", + "description": "The phone.", + "title": "Phone" + }, + "lat": { + "type": "number", + "format": "float", + "description": "The latitude.", + "title": "Lat" + }, + "lon": { + "type": "number", + "format": "float", + "description": "The longitude.", + "title": "Lon" + }, + "coordinates": { + "type": "string", + "description": "The coordinates.", + "title": "Coordinates" + }, + "email": { + "type": "string", + "description": "The email address.", + "title": "Email" + }, + "url": { + "type": "string", + "description": "The URL address.", + "title": "URL" + }, + "facebookUrl": { + "type": "string", + "description": "The Facebook URL address.", + "title": "Facebook URL" + }, + "adoptionProcess": { + "type": "string", + "description": "The adoption process.", + "title": "Adoption Process" + }, + "about": { + "type": "string", + "description": "The about.", + "title": "About" + }, + "services": { + "type": "string", + "description": "The services.", + "title": "Services" + }, + "type": { + "type": "string", + "description": "The type.", + "title": "Type" + }, + "original": { + "type": "object", + "properties": { + "filesize": { + "type": "integer", + "format": "int32", + "description": "The file size.", + "title": "File Size" + }, + "resolutionX": { + "type": "integer", + "format": "int32", + "description": "The x resolution.", + "title": "Resolution X" + }, + "resolutionY": { + "type": "integer", + "format": "int32", + "description": "The y resolution.", + "title": "Resolution Y" + }, + "url": { + "type": "string", + "description": "The URL address.", + "title": "URL" + } + }, + "title": "Original" + }, + "large": { + "type": "object", + "properties": { + "filesize": { + "type": "integer", + "format": "int32", + "description": "The file size.", + "title": "File Size" + }, + "resolutionX": { + "type": "integer", + "format": "int32", + "description": "The x resolution.", + "title": "Resolution X" + }, + "resolutionY": { + "type": "integer", + "format": "int32", + "description": "The y resolution.", + "title": "Resolution Y" + }, + "url": { + "type": "string", + "description": "The URL address.", + "title": "URL" + } + }, + "title": "Large" + }, + "small": { + "type": "object", + "properties": { + "filesize": { + "type": "integer", + "format": "int32", + "description": "The file size.", + "title": "File Size" + }, + "resolutionX": { + "type": "integer", + "format": "int32", + "description": "The x resolution.", + "title": "Resolution X" + }, + "resolutionY": { + "type": "integer", + "format": "int32", + "description": "The y resolution.", + "title": "Resolution Y" + }, + "url": { + "type": "string", + "description": "The URL address.", + "title": "URL" + } + }, + "title": "Small" + }, + "order": { + "type": "integer", + "format": "int32", + "description": "The order.", + "title": "Order" + }, + "created": { + "type": "string", + "description": "When created.", + "title": "Created" + }, + "updated": { + "type": "string", + "description": "When updated.", + "title": "Updated" + } + }, + "title": "Attributes" + }, + "links": { + "type": "object", + "properties": { + "self": { + "type": "string", + "description": "The self.", + "title": "Self" + } + }, + "title": "Links" + } + } + }, + "title": "Included" + } + } + } + } + }, + "summary": "Get animal by ID", + "description": "Retrieves an animal's information by identifier.", + "operationId": "AnimalID", + "parameters": [ + { + "name": "id", + "in": "path", + "x-ms-summary": "Identifier", + "x-ms-url-encoding": "single", + "description": "The identifier.", + "required": true, + "type": "string" + } + ], + "x-ms-visibility": "important" + } + }, + "/public/orgs/{id}/animals/": { + "get": { + "responses": { + "200": { + "description": "default", + "schema": { + "type": "object", + "properties": { + "meta": { + "type": "object", + "properties": { + "count": { + "type": "integer", + "format": "int32", + "description": "The count.", + "title": "Count" + }, + "countReturned": { + "type": "integer", + "format": "int32", + "description": "The count returned.", + "title": "Count Returned" + }, + "pageReturned": { + "type": "integer", + "format": "int32", + "description": "The page returned.", + "title": "Page Returned" + }, + "limit": { + "type": "integer", + "format": "int32", + "description": "The limit.", + "title": "Limit" + }, + "pages": { + "type": "integer", + "format": "int32", + "description": "The number of pages.", + "title": "Pages" + }, + "transactionId": { + "type": "string", + "description": "The transaction identifier.", + "title": "Transaction ID" + } + }, + "title": "Meta" + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type.", + "title": "Type" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "attributes": { + "type": "object", + "properties": { + "activityLevel": { + "type": "string", + "description": "The activity level.", + "title": "Activity Level" + }, + "isAdoptionPending": { + "type": "boolean", + "description": "Whether adoption is pending.", + "title": "Is Adoption Pending" + }, + "ageString": { + "type": "string", + "description": "The age.", + "title": "Age" + }, + "birthDate": { + "type": "string", + "description": "The birth date.", + "title": "Birth Date" + }, + "isBirthDateExact": { + "type": "boolean", + "description": "Whether birth date is exact.", + "title": "Is Birth Date Exact" + }, + "breedString": { + "type": "string", + "description": "The breed.", + "title": "Breed" + }, + "breedPrimary": { + "type": "string", + "description": "The primary breed.", + "title": "Breed Primary" + }, + "breedPrimaryId": { + "type": "integer", + "format": "int32", + "description": "The primary breed identifier.", + "title": "Breed Primary ID" + }, + "isBreedMixed": { + "type": "boolean", + "description": "Whether is a mixed breed.", + "title": "Is Breed Mixed" + }, + "isCatsOk": { + "type": "boolean", + "description": "Whether is okay with cats.", + "title": "Is Cats Ok" + }, + "coatLength": { + "type": "string", + "description": "The coat length.", + "title": "Coat Length" + }, + "colorDetails": { + "type": "string", + "description": "The color details.", + "title": "Color Details" + }, + "isCourtesyListing": { + "type": "boolean", + "description": "Whether listing is courtesy.", + "title": "Is Courtesy Listing" + }, + "isCurrentVaccinations": { + "type": "boolean", + "description": "Whether is current with vaccinations.", + "title": "Is Current Vaccinations" + }, + "isDeclawed": { + "type": "boolean", + "description": "Whether is declawed.", + "title": "Is Declawed" + }, + "descriptionHtml": { + "type": "string", + "description": "The description in HTML.", + "title": "Description Html" + }, + "descriptionText": { + "type": "string", + "description": "The description text.", + "title": "Description Text" + }, + "isNeedingFoster": { + "type": "boolean", + "description": "Whether is needing foster.", + "title": "Is Needing Foster" + }, + "isFound": { + "type": "boolean", + "description": "Whether was found.", + "title": "Is Found" + }, + "priority": { + "type": "integer", + "format": "int32", + "description": "The priority.", + "title": "Priority" + }, + "indoorOutdoor": { + "type": "string", + "description": "The indoor and outdoor preference.", + "title": "Indoor Outdoor" + }, + "name": { + "type": "string", + "description": "The name.", + "title": "Name" + }, + "newPeopleReaction": { + "type": "string", + "description": "The reaction with new people.", + "title": "New People Reaction" + }, + "ownerExperience": { + "type": "string", + "description": "The previous owner experience.", + "title": "Owner Experience" + }, + "pictureCount": { + "type": "integer", + "format": "int32", + "description": "The picture count.", + "title": "Picture Count" + }, + "pictureThumbnailUrl": { + "type": "string", + "description": "The thumbnail picture URL address.", + "title": "Picture Thumbnail URL" + }, + "searchString": { + "type": "string", + "description": "The search string.", + "title": "Search String" + }, + "sex": { + "type": "string", + "description": "The sex.", + "title": "Sex" + }, + "sizeGroup": { + "type": "string", + "description": "The group size.", + "title": "Size Group" + }, + "sizeUOM": { + "type": "string", + "description": "The size unit of measurement.", + "title": "Size UOM" + }, + "slug": { + "type": "string", + "description": "The slug.", + "title": "Slug" + }, + "isSpecialNeeds": { + "type": "boolean", + "description": "Whether is special needs.", + "title": "Is Special Needs" + }, + "isSponsorable": { + "type": "boolean", + "description": "Whether is sponsorable.", + "title": "Is Sponsorable" + }, + "trackerimageUrl": { + "type": "string", + "description": "The tracker image URL address.", + "title": "Tracker Image URL" + }, + "url": { + "type": "string", + "description": "The URL address.", + "title": "URL" + }, + "videoCount": { + "type": "integer", + "format": "int32", + "description": "The video count.", + "title": "Video Count" + }, + "videoUrlCount": { + "type": "integer", + "format": "int32", + "description": "The video URL count.", + "title": "Video URL Count" + }, + "createdDate": { + "type": "string", + "description": "The date created.", + "title": "Created Date" + }, + "updatedDate": { + "type": "string", + "description": "When updated date.", + "title": "Updated Date" + }, + "ageGroup": { + "type": "string", + "description": "The age group.", + "title": "Age Group" + }, + "breedSecondary": { + "type": "string", + "description": "The secondary breed.", + "title": "Breed Secondary" + }, + "breedSecondaryId": { + "type": "integer", + "format": "int32", + "description": "The secondary breed identifier.", + "title": "Breed Secondary ID" + }, + "isKidsOk": { + "type": "boolean", + "description": "Whether is okay with kids.", + "title": "Is Kids Ok" + }, + "isDogsOk": { + "type": "boolean", + "description": "Whether is okay with dogs.", + "title": "Is Dogs Ok" + }, + "adoptedDate": { + "type": "string", + "description": "The adoption date.", + "title": "Adopted Date" + }, + "sizeCurrent": { + "type": "number", + "format": "float", + "description": "The current size.", + "title": "Size Current" + } + }, + "title": "Attributes" + }, + "relationships": { + "type": "object", + "properties": { + "breeds": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type.", + "title": "Type" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + } + } + }, + "title": "Data" + } + }, + "title": "Breeds" + }, + "colors": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type.", + "title": "Type" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + } + } + }, + "title": "Data" + } + }, + "title": "Colors" + }, + "species": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type.", + "title": "Type" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + } + } + }, + "title": "Data" + } + }, + "title": "Species" + }, + "statuses": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type.", + "title": "Type" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + } + } + }, + "title": "Data" + } + }, + "title": "Statuses" + }, + "locations": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type.", + "title": "Type" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + } + } + }, + "title": "Data" + } + }, + "title": "Locations" + }, + "orgs": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type.", + "title": "Type" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + } + } + }, + "title": "Data" + } + }, + "title": "Orgs" + }, + "pictures": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type.", + "title": "Type" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + } + } + }, + "title": "Data" + } + }, + "title": "Pictures" + }, + "patterns": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type.", + "title": "Type" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + } + } + }, + "title": "Data" + } + }, + "title": "Patterns" + } + }, + "title": "Relationships" + } + } + }, + "title": "Data" + }, + "included": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type.", + "title": "Type" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "attributes": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name.", + "title": "Name" + }, + "singular": { + "type": "string", + "description": "The singular.", + "title": "Singular" + }, + "plural": { + "type": "string", + "description": "The plural.", + "title": "Plural" + }, + "youngSingular": { + "type": "string", + "description": "The young singular.", + "title": "Young Singular" + }, + "youngPlural": { + "type": "string", + "description": "The young plural.", + "title": "Young Plural" + }, + "description": { + "type": "string", + "description": "The description.", + "title": "Description" + }, + "city": { + "type": "string", + "description": "The city.", + "title": "City" + }, + "state": { + "type": "string", + "description": "The state.", + "title": "State" + }, + "citystate": { + "type": "string", + "description": "The city and state.", + "title": "City/State" + }, + "postalcode": { + "type": "string", + "description": "The postal code.", + "title": "Postal Code" + }, + "country": { + "type": "string", + "description": "The country.", + "title": "Country" + }, + "lat": { + "type": "number", + "format": "float", + "description": "The latitude.", + "title": "Lat" + }, + "lon": { + "type": "number", + "format": "float", + "description": "The longitude.", + "title": "Lon" + }, + "coordinates": { + "type": "string", + "description": "The coordinates.", + "title": "Coordinates" + }, + "postalcodePlus4": { + "type": "string", + "description": "The postal code plus 4 digits.", + "title": "Postal Code Plus 4" + }, + "email": { + "type": "string", + "description": "The email address.", + "title": "Email" + }, + "url": { + "type": "string", + "description": "The URL address.", + "title": "URL" + }, + "facebookUrl": { + "type": "string", + "description": "The Facebook URL address.", + "title": "Facebook URL" + }, + "type": { + "type": "string", + "description": "The type.", + "title": "Type" + }, + "original": { + "type": "object", + "properties": { + "filesize": { + "type": "integer", + "format": "int32", + "description": "The file size.", + "title": "File Size" + }, + "resolutionX": { + "type": "integer", + "format": "int32", + "description": "The x resolution.", + "title": "Resolution X" + }, + "resolutionY": { + "type": "integer", + "format": "int32", + "description": "The y resolution.", + "title": "Resolution Y" + }, + "url": { + "type": "string", + "description": "The URL address.", + "title": "URL" + } + }, + "title": "Original" + }, + "large": { + "type": "object", + "properties": { + "filesize": { + "type": "integer", + "format": "int32", + "description": "The file size.", + "title": "File Size" + }, + "resolutionX": { + "type": "integer", + "format": "int32", + "description": "The x resolution.", + "title": "Resolution X" + }, + "resolutionY": { + "type": "integer", + "format": "int32", + "description": "The y resolution.", + "title": "Resolution Y" + }, + "url": { + "type": "string", + "description": "The URL address.", + "title": "URL" + } + }, + "title": "Large" + }, + "small": { + "type": "object", + "properties": { + "filesize": { + "type": "integer", + "format": "int32", + "description": "The file size.", + "title": "File Size" + }, + "resolutionX": { + "type": "integer", + "format": "int32", + "description": "The x resolution.", + "title": "Resolution X" + }, + "resolutionY": { + "type": "integer", + "format": "int32", + "description": "The y resolution.", + "title": "Resolution Y" + }, + "url": { + "type": "string", + "description": "The URL address.", + "title": "URL" + } + }, + "title": "Small" + }, + "order": { + "type": "integer", + "format": "int32", + "description": "The order.", + "title": "Order" + }, + "created": { + "type": "string", + "description": "When created.", + "title": "Created" + }, + "updated": { + "type": "string", + "description": "When updated.", + "title": "Updated" + } + }, + "title": "Attributes" + }, + "links": { + "type": "object", + "properties": { + "self": { + "type": "string", + "description": "The self.", + "title": "Self" + } + }, + "title": "Links" + } + } + }, + "title": "Included" + } + } + } + } + }, + "summary": "Get animals at organization", + "description": "Retrieve a list of animals at an organization.", + "operationId": "OrganizationAnimal", + "x-ms-visibility": "important", + "parameters": [ + { + "name": "id", + "in": "path", + "x-ms-summary": "Identifier", + "x-ms-url-encoding": "single", + "description": "The identifier.", + "required": true, + "type": "string" + }, + { + "name": "limit", + "in": "query", + "x-ms-summary": "Limit", + "description": "The limit.", + "required": false, + "type": "integer" + }, + { + "name": "page", + "in": "query", + "x-ms-summary": "Page", + "description": "The page number.", + "required": false, + "type": "integer" + } + ] + } + }, + "/public/orgs/{id}/animals/search/{status}/": { + "get": { + "responses": { + "200": { + "description": "default", + "schema": { + "type": "object", + "properties": { + "meta": { + "type": "object", + "properties": { + "count": { + "type": "integer", + "format": "int32", + "description": "The count.", + "title": "Count" + }, + "countReturned": { + "type": "integer", + "format": "int32", + "description": "The count returned.", + "title": "Count Returned" + }, + "pageReturned": { + "type": "integer", + "format": "int32", + "description": "The page returned.", + "title": "Page Returned" + }, + "limit": { + "type": "integer", + "format": "int32", + "description": "The limit.", + "title": "Limit" + }, + "pages": { + "type": "integer", + "format": "int32", + "description": "The number of pages.", + "title": "Pages" + }, + "transactionId": { + "type": "string", + "description": "The transaction identifier.", + "title": "Transaction ID" + } + }, + "title": "Meta" + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type.", + "title": "Type" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "attributes": { + "type": "object", + "properties": { + "activityLevel": { + "type": "string", + "description": "The activity level.", + "title": "Activity Level" + }, + "isAdoptionPending": { + "type": "boolean", + "description": "Whether adoption is pending.", + "title": "Is Adoption Pending" + }, + "ageGroup": { + "type": "string", + "description": "The age group.", + "title": "Age Group" + }, + "ageString": { + "type": "string", + "description": "The age.", + "title": "Age" + }, + "birthDate": { + "type": "string", + "description": "The birth date.", + "title": "Birth Date" + }, + "isBirthDateExact": { + "type": "boolean", + "description": "Whether birth date is exact.", + "title": "Is Birth Date Exact" + }, + "breedString": { + "type": "string", + "description": "The breed.", + "title": "Breed" + }, + "breedPrimary": { + "type": "string", + "description": "The primary breed.", + "title": "Breed Primary" + }, + "breedPrimaryId": { + "type": "integer", + "format": "int32", + "description": "The primary breed identifier.", + "title": "Breed Primary ID" + }, + "isBreedMixed": { + "type": "boolean", + "description": "Whether is a mixed breed.", + "title": "Is Breed Mixed" + }, + "coatLength": { + "type": "string", + "description": "The coat length.", + "title": "Coat Length" + }, + "colorDetails": { + "type": "string", + "description": "The color details.", + "title": "Color Details" + }, + "isCourtesyListing": { + "type": "boolean", + "description": "Whether listing is courtesy.", + "title": "Is Courtesy Listing" + }, + "isCurrentVaccinations": { + "type": "boolean", + "description": "Whether is current with vaccinations.", + "title": "Is Current Vaccinations" + }, + "descriptionHtml": { + "type": "string", + "description": "The description in HTML.", + "title": "Description Html" + }, + "descriptionText": { + "type": "string", + "description": "The description text.", + "title": "Description Text" + }, + "isNeedingFoster": { + "type": "boolean", + "description": "Whether is needing foster.", + "title": "Is Needing Foster" + }, + "isFound": { + "type": "boolean", + "description": "Whether was found.", + "title": "Is Found" + }, + "priority": { + "type": "integer", + "format": "int32", + "description": "The priority.", + "title": "Priority" + }, + "indoorOutdoor": { + "type": "string", + "description": "The indoor and outdoor preference.", + "title": "Indoor Outdoor" + }, + "name": { + "type": "string", + "description": "The name.", + "title": "Name" + }, + "pictureCount": { + "type": "integer", + "format": "int32", + "description": "The picture count.", + "title": "Picture Count" + }, + "pictureThumbnailUrl": { + "type": "string", + "description": "The thumbnail picture URL address.", + "title": "Picture Thumbnail URL" + }, + "searchString": { + "type": "string", + "description": "The search string.", + "title": "Search String" + }, + "sex": { + "type": "string", + "description": "The sex.", + "title": "Sex" + }, + "sizeGroup": { + "type": "string", + "description": "The group size.", + "title": "Size Group" + }, + "sizeUOM": { + "type": "string", + "description": "The size unit of measurement.", + "title": "Size UOM" + }, + "slug": { + "type": "string", + "description": "The slug.", + "title": "Slug" + }, + "isSpecialNeeds": { + "type": "boolean", + "description": "Whether is special needs.", + "title": "Is Special Needs" + }, + "isSponsorable": { + "type": "boolean", + "description": "Whether is sponsorable.", + "title": "Is Sponsorable" + }, + "trackerimageUrl": { + "type": "string", + "description": "The tracker image URL address.", + "title": "Tracker Image URL" + }, + "url": { + "type": "string", + "description": "The URL address.", + "title": "URL" + }, + "videoCount": { + "type": "integer", + "format": "int32", + "description": "The video count.", + "title": "Video Count" + }, + "videoUrlCount": { + "type": "integer", + "format": "int32", + "description": "The video URL count.", + "title": "Video URL Count" + }, + "createdDate": { + "type": "string", + "description": "The date created.", + "title": "Created Date" + }, + "updatedDate": { + "type": "string", + "description": "When updated date.", + "title": "Updated Date" + } + }, + "title": "Attributes" + }, + "relationships": { + "type": "object", + "properties": { + "breeds": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type.", + "title": "Type" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + } + } + }, + "title": "Data" + } + }, + "title": "Breeds" + }, + "colors": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type.", + "title": "Type" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + } + } + }, + "title": "Data" + } + }, + "title": "Colors" + }, + "patterns": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type.", + "title": "Type" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + } + } + }, + "title": "Data" + } + }, + "title": "Patterns" + }, + "species": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type.", + "title": "Type" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + } + } + }, + "title": "Data" + } + }, + "title": "Species" + }, + "statuses": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type.", + "title": "Type" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + } + } + }, + "title": "Data" + } + }, + "title": "Statuses" + }, + "locations": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type.", + "title": "Type" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + } + } + }, + "title": "Data" + } + }, + "title": "Locations" + }, + "orgs": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type.", + "title": "Type" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + } + } + }, + "title": "Data" + } + }, + "title": "Orgs" + }, + "pictures": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type.", + "title": "Type" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + } + } + }, + "title": "Data" + } + }, + "title": "Pictures" + } + }, + "title": "Relationships" + } + } + }, + "title": "Data" + }, + "included": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type.", + "title": "Type" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "attributes": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name.", + "title": "Name" + }, + "singular": { + "type": "string", + "description": "The singular.", + "title": "Singular" + }, + "plural": { + "type": "string", + "description": "The plural.", + "title": "Plural" + }, + "youngSingular": { + "type": "string", + "description": "The young singular.", + "title": "Young Singular" + }, + "youngPlural": { + "type": "string", + "description": "The young plural.", + "title": "Young Plural" + }, + "description": { + "type": "string", + "description": "The description.", + "title": "Description" + }, + "city": { + "type": "string", + "description": "The city.", + "title": "City" + }, + "state": { + "type": "string", + "description": "The state.", + "title": "State" + }, + "citystate": { + "type": "string", + "description": "The city and state.", + "title": "City/State" + }, + "postalcode": { + "type": "string", + "description": "The postal code.", + "title": "Postal Code" + }, + "country": { + "type": "string", + "description": "The country.", + "title": "Country" + }, + "lat": { + "type": "number", + "format": "float", + "description": "The latitude.", + "title": "Lat" + }, + "lon": { + "type": "number", + "format": "float", + "description": "The longitude.", + "title": "Lon" + }, + "coordinates": { + "type": "string", + "description": "The coordinates.", + "title": "Coordinates" + }, + "postalcodePlus4": { + "type": "string", + "description": "The postal code plus 4 digits.", + "title": "Postal Code Plus 4" + }, + "email": { + "type": "string", + "description": "The email address.", + "title": "Email" + }, + "url": { + "type": "string", + "description": "The URL address.", + "title": "URL" + }, + "facebookUrl": { + "type": "string", + "description": "The Facebook URL address.", + "title": "Facebook URL" + }, + "type": { + "type": "string", + "description": "The type.", + "title": "Type" + }, + "original": { + "type": "object", + "properties": { + "filesize": { + "type": "integer", + "format": "int32", + "description": "The file size.", + "title": "File Size" + }, + "resolutionX": { + "type": "integer", + "format": "int32", + "description": "The x resolution.", + "title": "Resolution X" + }, + "resolutionY": { + "type": "integer", + "format": "int32", + "description": "The y resolution.", + "title": "Resolution Y" + }, + "url": { + "type": "string", + "description": "The URL address.", + "title": "URL" + } + }, + "title": "Original" + }, + "large": { + "type": "object", + "properties": { + "filesize": { + "type": "integer", + "format": "int32", + "description": "The file size.", + "title": "File Size" + }, + "resolutionX": { + "type": "integer", + "format": "int32", + "description": "The x resolution.", + "title": "Resolution X" + }, + "resolutionY": { + "type": "integer", + "format": "int32", + "description": "The y resolution.", + "title": "Resolution Y" + }, + "url": { + "type": "string", + "description": "The URL address.", + "title": "URL" + } + }, + "title": "Large" + }, + "small": { + "type": "object", + "properties": { + "filesize": { + "type": "integer", + "format": "int32", + "description": "The file size.", + "title": "File Size" + }, + "resolutionX": { + "type": "integer", + "format": "int32", + "description": "The x resolution.", + "title": "Resolution X" + }, + "resolutionY": { + "type": "integer", + "format": "int32", + "description": "The y resolution.", + "title": "Resolution Y" + }, + "url": { + "type": "string", + "description": "The URL address.", + "title": "URL" + } + }, + "title": "Small" + }, + "order": { + "type": "integer", + "format": "int32", + "description": "The order.", + "title": "Order" + }, + "created": { + "type": "string", + "description": "When created.", + "title": "Created" + }, + "updated": { + "type": "string", + "description": "When updated.", + "title": "Updated" + } + }, + "title": "Attributes" + }, + "links": { + "type": "object", + "properties": { + "self": { + "type": "string", + "description": "The self.", + "title": "Self" + } + }, + "title": "Links" + } + } + }, + "title": "Included" + } + } + } + } + }, + "summary": "Get animals at organization by status", + "description": "Retrieves a list of animals at an organization by status.", + "operationId": "OrganizationAnimalStatus", + "parameters": [ + { + "name": "id", + "in": "path", + "x-ms-summary": "Identifier", + "x-ms-url-encoding": "single", + "description": "The identifier.", + "required": true, + "type": "string" + }, + { + "name": "status", + "in": "path", + "x-ms-summary": "Status", + "x-ms-url-encoding": "single", + "description": "The status.", + "required": true, + "type": "string" + }, + { + "name": "limit", + "in": "query", + "x-ms-summary": "Limit", + "description": "The limit.", + "required": false, + "type": "integer" + }, + { + "name": "page", + "in": "query", + "x-ms-summary": "Page", + "description": "The page number.", + "required": false, + "type": "integer" + } + ] + } + } + }, + "definitions": {}, + "parameters": {}, + "responses": {}, + "securityDefinitions": { + "API Key": { + "type": "apiKey", + "in": "header", + "name": "Authorization" + } + }, + "security": [ + { + "API Key": [] + } + ], + "tags": [], + "x-ms-connector-metadata": [ + { + "propertyName": "Website", + "propertyValue": "https://rescuegroups.org/" + }, + { + "propertyName": "Privacy policy", + "propertyValue": "https://rescuegroups.org/privacy-statement/" + }, + { + "propertyName": "Categories", + "propertyValue": "Lifestyle and Entertainment" + } + ] +} \ No newline at end of file diff --git a/independent-publisher-connectors/RescueGroups/apiProperties.json b/independent-publisher-connectors/RescueGroups/apiProperties.json new file mode 100644 index 0000000000..c56e11124d --- /dev/null +++ b/independent-publisher-connectors/RescueGroups/apiProperties.json @@ -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", + "constraints": { + "tabIndex": 2, + "clearText": false, + "required": "true" + } + } + } + }, + "iconBrandColor": "#da3b01", + "capabilities": [], + "publisher": "Troy Taylor", + "stackOwner": "RescueGroups.org" + } +} \ No newline at end of file diff --git a/independent-publisher-connectors/RescueGroups/readme.md b/independent-publisher-connectors/RescueGroups/readme.md new file mode 100644 index 0000000000..7e3bb6f05c --- /dev/null +++ b/independent-publisher-connectors/RescueGroups/readme.md @@ -0,0 +1,37 @@ +# RescueGroups +Since 2002, RescueGroups.org has provided animal welfare organizations with easy to use, free and low-cost services like the Pet Adoption Portal to help maximize animal adoptions. + +## Publisher: Troy Taylor, Hitachi Solutions + +## Prerequisites +There are no prerequisites needed to use this service. + +## Obtaining Credentials +An API Key must be requested using the [form on the RescueGroups.org website](https://rescuegroups.org/services/request-an-api-key/). + +## Supported Operations +### Get breeds +Retrieves a list of breeds. +### Get breed by ID +Retrieves the breed information by identifier. +### Get breeds by species +Retrieves a list of breeds by species. +### Get breeds by species ID +Retrieves a list of breeds by species identifier. +### Get organizations +Retrieves a list of organizations. +### Get organization by ID +Retrieve an organization by identifier. +### Get animals +Retrieve a list of animals. +### Get animals by status +Retrieves a list of animals by status. +### Get animal by ID +Retrieves an animal's information by identifier. +### Get animals at organization +Retrieve a list of animals at an organization. +### Get animals at organization by status +Retrieves a list of animals at an organization by status. + +## Known Issues and Limitations +There are no known issues at this time. From 68f0e42406ce805b712cedbf84d882c3ab4f7276 Mon Sep 17 00:00:00 2001 From: Troy Taylor Date: Wed, 13 Jul 2022 13:54:28 -0400 Subject: [PATCH 06/21] Revert "Add files via upload" This reverts commit eeff7b7a02a5c65406413e7c848ebc718c30183e. --- .../RescueGroups/apiDefinition.swagger.json | 5589 ----------------- .../RescueGroups/apiProperties.json | 23 - .../RescueGroups/readme.md | 37 - 3 files changed, 5649 deletions(-) delete mode 100644 independent-publisher-connectors/RescueGroups/apiDefinition.swagger.json delete mode 100644 independent-publisher-connectors/RescueGroups/apiProperties.json delete mode 100644 independent-publisher-connectors/RescueGroups/readme.md diff --git a/independent-publisher-connectors/RescueGroups/apiDefinition.swagger.json b/independent-publisher-connectors/RescueGroups/apiDefinition.swagger.json deleted file mode 100644 index dae616f06d..0000000000 --- a/independent-publisher-connectors/RescueGroups/apiDefinition.swagger.json +++ /dev/null @@ -1,5589 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "RescueGroups", - "description": "Since 2002, RescueGroups.org has provided animal welfare organizations with easy to use, free and low-cost services like the Pet Adoption Portal to help maximize animal adoptions.", - "version": "1.0", - "contact": { - "name": "Troy Taylor", - "url": "https://www.hitachisolutions.com", - "email": "ttaylor@hitachisolutions.com" - } - }, - "host": "api.rescuegroups.org", - "basePath": "/v5/", - "schemes": [ - "https" - ], - "consumes": [], - "produces": [], - "paths": { - "/public/animals/breeds/": { - "get": { - "responses": { - "200": { - "description": "default", - "schema": { - "type": "object", - "properties": { - "meta": { - "type": "object", - "properties": { - "count": { - "type": "integer", - "format": "int32", - "description": "The count.", - "title": "Count" - }, - "countReturned": { - "type": "integer", - "format": "int32", - "description": "The count returned.", - "title": "Count Returned" - }, - "pageReturned": { - "type": "integer", - "format": "int32", - "description": "The page returned.", - "title": "Page Returned" - }, - "pages": { - "type": "integer", - "format": "int32", - "description": "The number of pages.", - "title": "Pages" - }, - "limit": { - "type": "integer", - "format": "int32", - "description": "The limit.", - "title": "Limit" - }, - "transactionId": { - "type": "string", - "description": "The transaction identifier.", - "title": "Transaction ID" - } - }, - "title": "Meta" - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type.", - "title": "Type" - }, - "id": { - "type": "string", - "description": "The identifier.", - "title": "ID" - }, - "attributes": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name.", - "title": "Name" - } - }, - "title": "Attributes" - }, - "relationships": { - "type": "object", - "properties": { - "species": { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type.", - "title": "Type" - }, - "id": { - "type": "string", - "description": "The identifier.", - "title": "ID" - }, - "links": { - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The self.", - "title": "Self" - } - }, - "title": "Links" - } - } - }, - "title": "Data" - }, - "links": { - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The self.", - "title": "Self" - } - }, - "title": "Links" - } - }, - "title": "Species" - } - }, - "title": "Relationships" - } - } - }, - "title": "Data" - }, - "included": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type.", - "title": "Type" - }, - "id": { - "type": "string", - "description": "The identifier.", - "title": "ID" - }, - "attributes": { - "type": "object", - "properties": { - "singular": { - "type": "string", - "description": "The singular.", - "title": "Singular" - }, - "plural": { - "type": "string", - "description": "The plural.", - "title": "Plural" - }, - "youngSingular": { - "type": "string", - "description": "The young singular.", - "title": "Young Singular" - }, - "youngPlural": { - "type": "string", - "description": "The young plural.", - "title": "Young Plural" - } - }, - "title": "Attributes" - } - } - }, - "title": "Included" - }, - "links": { - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The self.", - "title": "Self" - }, - "first": { - "type": "string", - "description": "The first.", - "title": "First" - }, - "last": { - "type": "string", - "description": "The last.", - "title": "Last" - }, - "next": { - "type": "string", - "description": "The next.", - "title": "Next" - } - }, - "title": "Links" - } - } - } - } - }, - "summary": "Get breeds", - "description": "Retrieves a list of breeds.", - "operationId": "Breed", - "parameters": [ - { - "name": "limit", - "in": "query", - "x-ms-summary": "Limit", - "description": "The limit.", - "required": false, - "type": "integer" - }, - { - "name": "page", - "in": "query", - "x-ms-summary": "Page", - "description": "The page number.", - "required": false, - "type": "integer" - } - ] - } - }, - "/public/animals/breeds/{id}": { - "get": { - "responses": { - "200": { - "description": "default", - "schema": { - "type": "object", - "properties": { - "meta": { - "type": "object", - "properties": { - "count": { - "type": "integer", - "format": "int32", - "description": "The count.", - "title": "Count" - }, - "countReturned": { - "type": "integer", - "format": "int32", - "description": "The count returned.", - "title": "Count Returned" - }, - "pageReturned": { - "type": "integer", - "format": "int32", - "description": "The page returned.", - "title": "Page Returned" - }, - "pages": { - "type": "integer", - "format": "int32", - "description": "The number of pages.", - "title": "Pages" - }, - "limit": { - "type": "integer", - "format": "int32", - "description": "The limit.", - "title": "Limit" - }, - "transactionId": { - "type": "string", - "description": "The transaction identifier.", - "title": "Transaction ID" - } - }, - "title": "Meta" - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type.", - "title": "Type" - }, - "id": { - "type": "string", - "description": "The identifier.", - "title": "ID" - }, - "attributes": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name.", - "title": "Name" - } - }, - "title": "Attributes" - }, - "relationships": { - "type": "object", - "properties": { - "species": { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type.", - "title": "Type" - }, - "id": { - "type": "string", - "description": "The identifier.", - "title": "ID" - }, - "links": { - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The self.", - "title": "Self" - } - }, - "title": "Links" - } - } - }, - "title": "Data" - }, - "links": { - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The self.", - "title": "Self" - } - }, - "title": "Links" - } - }, - "title": "Species" - } - }, - "title": "Relationships" - } - } - }, - "title": "Data" - }, - "included": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type.", - "title": "Type" - }, - "id": { - "type": "string", - "description": "The identifier.", - "title": "ID" - }, - "attributes": { - "type": "object", - "properties": { - "singular": { - "type": "string", - "description": "The singular.", - "title": "Singular" - }, - "plural": { - "type": "string", - "description": "The plural.", - "title": "Plural" - }, - "youngSingular": { - "type": "string", - "description": "The young singular.", - "title": "Young Singular" - }, - "youngPlural": { - "type": "string", - "description": "The young plural.", - "title": "Young Plural" - } - }, - "title": "Attributes" - } - } - }, - "title": "Included" - }, - "links": { - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The self.", - "title": "Self" - }, - "first": { - "type": "string", - "description": "The first.", - "title": "First" - }, - "last": { - "type": "string", - "description": "The last.", - "title": "Last" - } - }, - "title": "Links" - } - } - } - } - }, - "summary": "Get breed by ID", - "description": "Retrieves the breed information by identifier.", - "operationId": "BreedID", - "parameters": [ - { - "name": "id", - "in": "path", - "x-ms-summary": "Identifier", - "x-ms-url-encoding": "single", - "description": "The identifier.", - "required": true, - "type": "string" - } - ] - } - }, - "/public/animals/breeds/search/{species}/": { - "get": { - "responses": { - "200": { - "description": "default", - "schema": { - "type": "object", - "properties": { - "meta": { - "type": "object", - "properties": { - "count": { - "type": "integer", - "format": "int32", - "description": "The count.", - "title": "Count" - }, - "countReturned": { - "type": "integer", - "format": "int32", - "description": "The count returned.", - "title": "Count Returned" - }, - "pageReturned": { - "type": "integer", - "format": "int32", - "description": "The page returned.", - "title": "Page Returned" - }, - "pages": { - "type": "integer", - "format": "int32", - "description": "The number of pages.", - "title": "Pages" - }, - "limit": { - "type": "integer", - "format": "int32", - "description": "The limit.", - "title": "Limit" - }, - "transactionId": { - "type": "string", - "description": "The transaction identifier.", - "title": "Transaction ID" - } - }, - "title": "Meta" - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type.", - "title": "Type" - }, - "id": { - "type": "string", - "description": "The identifier.", - "title": "ID" - }, - "attributes": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name.", - "title": "Name" - } - }, - "title": "Attributes" - }, - "relationships": { - "type": "object", - "properties": { - "species": { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type.", - "title": "Type" - }, - "id": { - "type": "string", - "description": "The identifier.", - "title": "ID" - }, - "links": { - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The self.", - "title": "Self" - } - }, - "title": "Links" - } - } - }, - "title": "Data" - }, - "links": { - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The self.", - "title": "Self" - } - }, - "title": "Links" - } - }, - "title": "Species" - } - }, - "title": "Relationships" - } - } - }, - "title": "Data" - }, - "included": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type.", - "title": "Type" - }, - "id": { - "type": "string", - "description": "The identifier.", - "title": "ID" - }, - "attributes": { - "type": "object", - "properties": { - "singular": { - "type": "string", - "description": "The singular.", - "title": "Singular" - }, - "plural": { - "type": "string", - "description": "The plural.", - "title": "Plural" - }, - "youngSingular": { - "type": "string", - "description": "The young singular.", - "title": "Young Singular" - }, - "youngPlural": { - "type": "string", - "description": "The young plural.", - "title": "Young Plural" - } - }, - "title": "Attributes" - } - } - }, - "title": "Included" - }, - "links": { - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The self.", - "title": "Self" - }, - "first": { - "type": "string", - "description": "The first.", - "title": "First" - }, - "last": { - "type": "string", - "description": "The last.", - "title": "Last" - }, - "next": { - "type": "string", - "description": "The next.", - "title": "Next" - } - }, - "title": "Links" - } - } - } - } - }, - "summary": "Get breeds by species", - "description": "Retrieves a list of breeds by species.", - "operationId": "BreedSpecies", - "parameters": [ - { - "name": "species", - "in": "path", - "x-ms-summary": "Species", - "x-ms-url-encoding": "single", - "description": "The species.", - "required": true, - "type": "string" - }, - { - "name": "limit", - "in": "query", - "x-ms-summary": "Limit", - "description": "The limit.", - "required": false, - "type": "integer" - }, - { - "name": "page", - "in": "query", - "x-ms-summary": "Page", - "description": "The page number.", - "required": false, - "type": "integer" - } - ] - } - }, - "/public/animals/species/{id}/breeds/": { - "get": { - "responses": { - "200": { - "description": "default", - "schema": { - "type": "object", - "properties": { - "meta": { - "type": "object", - "properties": { - "count": { - "type": "integer", - "format": "int32", - "description": "The count.", - "title": "Count" - }, - "countReturned": { - "type": "integer", - "format": "int32", - "description": "The count returned.", - "title": "Count Returned" - }, - "pageReturned": { - "type": "integer", - "format": "int32", - "description": "The page returned.", - "title": "Page Returned" - }, - "pages": { - "type": "integer", - "format": "int32", - "description": "The number of pages.", - "title": "Pages" - }, - "limit": { - "type": "integer", - "format": "int32", - "description": "The limit.", - "title": "Limit" - }, - "transactionId": { - "type": "string", - "description": "The transaction identifier.", - "title": "Transaction ID" - } - }, - "title": "Meta" - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type.", - "title": "Type" - }, - "id": { - "type": "string", - "description": "The identifier.", - "title": "ID" - }, - "attributes": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name.", - "title": "Name" - } - }, - "title": "Attributes" - }, - "relationships": { - "type": "object", - "properties": { - "species": { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type.", - "title": "Type" - }, - "id": { - "type": "string", - "description": "The identifier.", - "title": "ID" - }, - "links": { - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The self.", - "title": "Self" - } - }, - "title": "Links" - } - } - }, - "title": "Data" - }, - "links": { - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The self.", - "title": "Self" - } - }, - "title": "Links" - } - }, - "title": "Species" - } - }, - "title": "Relationships" - } - } - }, - "title": "Data" - }, - "included": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type.", - "title": "Type" - }, - "id": { - "type": "string", - "description": "The identifier.", - "title": "ID" - }, - "attributes": { - "type": "object", - "properties": { - "singular": { - "type": "string", - "description": "The singular.", - "title": "Singular" - }, - "plural": { - "type": "string", - "description": "The plural.", - "title": "Plural" - }, - "youngSingular": { - "type": "string", - "description": "The young singular.", - "title": "Young Singular" - }, - "youngPlural": { - "type": "string", - "description": "The young plural.", - "title": "Young Plural" - } - }, - "title": "Attributes" - } - } - }, - "title": "Included" - }, - "links": { - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The self.", - "title": "Self" - }, - "first": { - "type": "string", - "description": "The first.", - "title": "First" - }, - "last": { - "type": "string", - "description": "The last.", - "title": "Last" - } - }, - "title": "Links" - } - } - } - } - }, - "summary": "Get breeds by species ID", - "description": "Retrieves a list of breeds by species identifier.", - "operationId": "BreedSpeciesID", - "parameters": [ - { - "name": "id", - "in": "path", - "x-ms-summary": "Identifier", - "x-ms-url-encoding": "single", - "description": "The identifier.", - "required": true, - "type": "string" - }, - { - "name": "limit", - "in": "query", - "x-ms-summary": "Limit", - "description": "The limit.", - "required": false, - "type": "integer" - }, - { - "name": "page", - "in": "query", - "x-ms-summary": "Page", - "description": "The page number.", - "required": false, - "type": "integer" - } - ] - } - }, - "/public/orgs/": { - "get": { - "responses": { - "200": { - "description": "default", - "schema": { - "type": "object", - "properties": { - "meta": { - "type": "object", - "properties": { - "count": { - "type": "integer", - "format": "int32", - "description": "The count.", - "title": "Count" - }, - "countReturned": { - "type": "integer", - "format": "int32", - "description": "The count returned.", - "title": "Count Returned" - }, - "pageReturned": { - "type": "integer", - "format": "int32", - "description": "The page returned.", - "title": "Page Returned" - }, - "limit": { - "type": "integer", - "format": "int32", - "description": "The limit.", - "title": "Limit" - }, - "pages": { - "type": "integer", - "format": "int32", - "description": "The number of pages.", - "title": "Pages" - }, - "transactionId": { - "type": "string", - "description": "The transaction identifier.", - "title": "Transaction ID" - } - }, - "title": "Meta" - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type.", - "title": "Type" - }, - "id": { - "type": "string", - "description": "The identifier.", - "title": "ID" - }, - "attributes": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name.", - "title": "Name" - }, - "city": { - "type": "string", - "description": "The city.", - "title": "City" - }, - "state": { - "type": "string", - "description": "The state.", - "title": "State" - }, - "postalcode": { - "type": "string", - "description": "The postal code.", - "title": "Postal Code" - }, - "postalcodePlus4": { - "type": "string", - "description": "The postal code plus 4 digits.", - "title": "Postal Code Plus 4" - }, - "country": { - "type": "string", - "description": "The country.", - "title": "Country" - }, - "email": { - "type": "string", - "description": "The email address.", - "title": "Email" - }, - "url": { - "type": "string", - "description": "The URL address.", - "title": "URL" - }, - "facebookUrl": { - "type": "string", - "description": "The Facebook URL address.", - "title": "Facebook URL" - }, - "type": { - "type": "string", - "description": "The type.", - "title": "Type" - }, - "isCommonapplicationAccepted": { - "type": "boolean", - "description": "Whether common application is accepted.", - "title": "Is Common Application Accepted" - }, - "lat": { - "type": "number", - "format": "float", - "description": "The latitude.", - "title": "Lat" - }, - "lon": { - "type": "number", - "format": "float", - "description": "The longitude.", - "title": "Lon" - }, - "coordinates": { - "type": "string", - "description": "The coordinates.", - "title": "Coordinates" - }, - "citystate": { - "type": "string", - "description": "The city and state.", - "title": "City/State" - }, - "street": { - "type": "string", - "description": "The street.", - "title": "Street" - }, - "phone": { - "type": "string", - "description": "The phone.", - "title": "Phone" - }, - "serveAreas": { - "type": "string", - "description": "The areas served.", - "title": "Serve Areas" - }, - "services": { - "type": "string", - "description": "The services.", - "title": "Services" - }, - "about": { - "type": "string", - "description": "The about.", - "title": "About" - }, - "adoptionProcess": { - "type": "string", - "description": "The adoption process.", - "title": "Adoption Process" - }, - "adoptionUrl": { - "type": "string", - "description": "The adoption URL address.", - "title": "Adoption URL" - }, - "donationUrl": { - "type": "string", - "description": "The donation URL address.", - "title": "Donation URL" - }, - "sponsorshipUrl": { - "type": "string", - "description": "The sponsorship URL address.", - "title": "Sponsorship URL" - } - }, - "title": "Attributes" - } - } - }, - "title": "Data" - } - } - } - } - }, - "summary": "Get organizations", - "description": "Retrieves a list of organizations", - "operationId": "Organization", - "parameters": [ - { - "name": "limit", - "in": "query", - "x-ms-summary": "Limit", - "description": "The limit.", - "required": false, - "type": "integer" - }, - { - "name": "page", - "in": "query", - "x-ms-summary": "Page", - "description": "The page number.", - "required": false, - "type": "integer" - } - ] - } - }, - "/public/orgs/{id}": { - "get": { - "responses": { - "200": { - "description": "default", - "schema": { - "type": "object", - "properties": { - "meta": { - "type": "object", - "properties": { - "count": { - "type": "integer", - "format": "int32", - "description": "The count.", - "title": "Count" - }, - "countReturned": { - "type": "integer", - "format": "int32", - "description": "The count returned.", - "title": "Count Returned" - }, - "pageReturned": { - "type": "integer", - "format": "int32", - "description": "The page returned.", - "title": "Page Returned" - }, - "limit": { - "type": "integer", - "format": "int32", - "description": "The limit.", - "title": "Limit" - }, - "pages": { - "type": "integer", - "format": "int32", - "description": "The number of pages.", - "title": "Pages" - }, - "transactionId": { - "type": "string", - "description": "The transaction identifier.", - "title": "Transaction ID" - } - }, - "title": "Meta" - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type.", - "title": "Type" - }, - "id": { - "type": "string", - "description": "The identifier.", - "title": "ID" - }, - "attributes": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name.", - "title": "Name" - }, - "city": { - "type": "string", - "description": "The city.", - "title": "City" - }, - "state": { - "type": "string", - "description": "The state.", - "title": "State" - }, - "postalcode": { - "type": "string", - "description": "The postal code.", - "title": "Postal Code" - }, - "postalcodePlus4": { - "type": "string", - "description": "The postal code plus 4 digits.", - "title": "Postal Code Plus 4" - }, - "country": { - "type": "string", - "description": "The country.", - "title": "Country" - }, - "email": { - "type": "string", - "description": "The email address.", - "title": "Email" - }, - "url": { - "type": "string", - "description": "The URL address.", - "title": "URL" - }, - "facebookUrl": { - "type": "string", - "description": "The Facebook URL address.", - "title": "Facebook URL" - }, - "type": { - "type": "string", - "description": "The type.", - "title": "Type" - }, - "isCommonapplicationAccepted": { - "type": "boolean", - "description": "Whether common application is accepted.", - "title": "Is Common Application Accepted" - }, - "lat": { - "type": "number", - "format": "float", - "description": "The latitude.", - "title": "Lat" - }, - "lon": { - "type": "number", - "format": "float", - "description": "The longitude.", - "title": "Lon" - }, - "coordinates": { - "type": "string", - "description": "The coordinates.", - "title": "Coordinates" - }, - "citystate": { - "type": "string", - "description": "The city and state.", - "title": "City/State" - } - }, - "title": "Attributes" - } - } - }, - "title": "Data" - } - } - } - } - }, - "summary": "Get organization by ID", - "description": "Retrieve an organization by identifier.", - "operationId": "OrganizationID", - "parameters": [ - { - "name": "id", - "in": "path", - "x-ms-summary": "Identifier", - "x-ms-url-encoding": "single", - "description": "The identifier.", - "required": true, - "type": "string" - } - ] - } - }, - "/public/animals/": { - "get": { - "responses": { - "200": { - "description": "default", - "schema": { - "type": "object", - "properties": { - "meta": { - "type": "object", - "properties": { - "count": { - "type": "integer", - "format": "int32", - "description": "The count.", - "title": "Count" - }, - "countReturned": { - "type": "integer", - "format": "int32", - "description": "The count returned.", - "title": "Count Returned" - }, - "pageReturned": { - "type": "integer", - "format": "int32", - "description": "The page returned.", - "title": "Page Returned" - }, - "limit": { - "type": "integer", - "format": "int32", - "description": "The limit.", - "title": "Limit" - }, - "pages": { - "type": "integer", - "format": "int32", - "description": "The number of pages.", - "title": "Pages" - }, - "transactionId": { - "type": "string", - "description": "The transaction identifier.", - "title": "Transaction ID" - } - }, - "title": "Meta" - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type.", - "title": "Type" - }, - "id": { - "type": "string", - "description": "The identifier.", - "title": "ID" - }, - "attributes": { - "type": "object", - "properties": { - "adoptedDate": { - "type": "string", - "description": "The adoption date.", - "title": "Adopted Date" - }, - "isAdoptionPending": { - "type": "boolean", - "description": "Whether adoption is pending.", - "title": "Is Adoption Pending" - }, - "ageGroup": { - "type": "string", - "description": "The age group.", - "title": "Age Group" - }, - "ageString": { - "type": "string", - "description": "The age.", - "title": "Age" - }, - "birthDate": { - "type": "string", - "description": "The birth date.", - "title": "Birth Date" - }, - "isBirthDateExact": { - "type": "boolean", - "description": "Whether birth date is exact.", - "title": "Is Birth Date Exact" - }, - "breedString": { - "type": "string", - "description": "The breed.", - "title": "Breed" - }, - "breedPrimary": { - "type": "string", - "description": "The primary breed.", - "title": "Breed Primary" - }, - "breedPrimaryId": { - "type": "integer", - "format": "int32", - "description": "The primary breed identifier.", - "title": "Breed Primary ID" - }, - "breedSecondary": { - "type": "string", - "description": "The secondary breed.", - "title": "Breed Secondary" - }, - "breedSecondaryId": { - "type": "integer", - "format": "int32", - "description": "The secondary breed identifier.", - "title": "Breed Secondary ID" - }, - "colorDetails": { - "type": "string", - "description": "The color details.", - "title": "Color Details" - }, - "isCourtesyListing": { - "type": "boolean", - "description": "Whether listing is courtesy.", - "title": "Is Courtesy Listing" - }, - "descriptionHtml": { - "type": "string", - "description": "The description in HTML.", - "title": "Description Html" - }, - "descriptionText": { - "type": "string", - "description": "The description text.", - "title": "Description Text" - }, - "isNeedingFoster": { - "type": "boolean", - "description": "Whether is needing foster.", - "title": "Is Needing Foster" - }, - "isFound": { - "type": "boolean", - "description": "Whether was found.", - "title": "Is Found" - }, - "priority": { - "type": "integer", - "format": "int32", - "description": "The priority.", - "title": "Priority" - }, - "name": { - "type": "string", - "description": "The name.", - "title": "Name" - }, - "pictureCount": { - "type": "integer", - "format": "int32", - "description": "The picture count.", - "title": "Picture Count" - }, - "pictureThumbnailUrl": { - "type": "string", - "description": "The thumbnail picture URL address.", - "title": "Picture Thumbnail URL" - }, - "searchString": { - "type": "string", - "description": "The search string.", - "title": "Search String" - }, - "sex": { - "type": "string", - "description": "The sex.", - "title": "Sex" - }, - "sizeUOM": { - "type": "string", - "description": "The size unit of measurement.", - "title": "Size UOM" - }, - "slug": { - "type": "string", - "description": "The slug.", - "title": "Slug" - }, - "isSponsorable": { - "type": "boolean", - "description": "Whether is sponsorable.", - "title": "Is Sponsorable" - }, - "trackerimageUrl": { - "type": "string", - "description": "The tracker image URL address.", - "title": "Tracker Image URL" - }, - "url": { - "type": "string", - "description": "The URL address.", - "title": "URL" - }, - "videoCount": { - "type": "integer", - "format": "int32", - "description": "The video count.", - "title": "Video Count" - }, - "videoUrlCount": { - "type": "integer", - "format": "int32", - "description": "The video URL count.", - "title": "Video URL Count" - }, - "createdDate": { - "type": "string", - "description": "The date created.", - "title": "Created Date" - }, - "updatedDate": { - "type": "string", - "description": "When updated date.", - "title": "Updated Date" - }, - "activityLevel": { - "type": "string", - "description": "The activity level.", - "title": "Activity Level" - }, - "adoptionFeeString": { - "type": "string", - "description": "The adoption fee.", - "title": "Adoption Fee" - }, - "isBreedMixed": { - "type": "boolean", - "description": "Whether is a mixed breed.", - "title": "Is Breed Mixed" - }, - "isCatsOk": { - "type": "boolean", - "description": "Whether is okay with cats.", - "title": "Is Cats Ok" - }, - "coatLength": { - "type": "string", - "description": "The coat length.", - "title": "Coat Length" - }, - "isCurrentVaccinations": { - "type": "boolean", - "description": "Whether is current with vaccinations.", - "title": "Is Current Vaccinations" - }, - "isDogsOk": { - "type": "boolean", - "description": "Whether is okay with dogs.", - "title": "Is Dogs Ok" - }, - "isKidsOk": { - "type": "boolean", - "description": "Whether is okay with kids.", - "title": "Is Kids Ok" - }, - "newPeopleReaction": { - "type": "string", - "description": "The reaction with new people.", - "title": "New People Reaction" - }, - "ownerExperience": { - "type": "string", - "description": "The previous owner experience.", - "title": "Owner Experience" - }, - "sizeCurrent": { - "type": "number", - "format": "float", - "description": "The current size.", - "title": "Size Current" - }, - "sizeGroup": { - "type": "string", - "description": "The group size.", - "title": "Size Group" - }, - "sizePotential": { - "type": "integer", - "format": "int32", - "description": "The potential size.", - "title": "Size Potential" - }, - "isSpecialNeeds": { - "type": "boolean", - "description": "Whether is special needs.", - "title": "Is Special Needs" - }, - "availableDate": { - "type": "string", - "description": "The date available.", - "title": "Available Date" - }, - "isHousetrained": { - "type": "boolean", - "description": "Whether is house-trained.", - "title": "Is House-trained" - }, - "rescueId": { - "type": "string", - "description": "The rescue identifier.", - "title": "Rescue ID" - }, - "adultSexesOk": { - "type": "string", - "description": "The adult sexes okay with.", - "title": "Adult Sexes Ok" - }, - "energyLevel": { - "type": "string", - "description": "The energy level.", - "title": "Energy Level" - }, - "fenceNeeds": { - "type": "string", - "description": "The fence needs.", - "title": "Fence Needs" - }, - "groomingNeeds": { - "type": "string", - "description": "The grooming needs.", - "title": "Grooming Needs" - }, - "obedienceTraining": { - "type": "string", - "description": "The obedience training.", - "title": "Obedience Training" - }, - "qualities": { - "type": "array", - "items": { - "type": "string" - }, - "description": "The qualities.", - "title": "Qualities" - }, - "vocalLevel": { - "type": "string", - "description": "The vocal level.", - "title": "Vocal Level" - }, - "isYardRequired": { - "type": "boolean", - "description": "Whether yard is required.", - "title": "Is Yard Required" - }, - "specialNeedsDetails": { - "type": "string", - "description": "The special needs details.", - "title": "Special Needs Details" - }, - "exerciseNeeds": { - "type": "string", - "description": "The exercise needs.", - "title": "Exercise Needs" - }, - "indoorOutdoor": { - "type": "string", - "description": "The indoor and outdoor preference.", - "title": "Indoor Outdoor" - }, - "sheddingLevel": { - "type": "string", - "description": "The shedding level.", - "title": "Shedding Level" - }, - "summary": { - "type": "string", - "description": "The summary.", - "title": "Summary" - }, - "isDeclawed": { - "type": "boolean", - "description": "Whether is declawed.", - "title": "Is Declawed" - }, - "earType": { - "type": "string", - "description": "The ear type.", - "title": "Ear Type" - }, - "eyeColor": { - "type": "string", - "description": "The eye color.", - "title": "Eye Color" - }, - "tailType": { - "type": "string", - "description": "The tail type.", - "title": "Tail Type" - }, - "killReason": { - "type": "string", - "description": "The kill reason.", - "title": "Kill Reason" - } - }, - "title": "Attributes" - }, - "relationships": { - "type": "object", - "properties": { - "breeds": { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type.", - "title": "Type" - }, - "id": { - "type": "string", - "description": "The identifier.", - "title": "ID" - } - } - }, - "title": "Data" - } - }, - "title": "Breeds" - }, - "species": { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type.", - "title": "Type" - }, - "id": { - "type": "string", - "description": "The identifier.", - "title": "ID" - } - } - }, - "title": "Data" - } - }, - "title": "Species" - }, - "statuses": { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type.", - "title": "Type" - }, - "id": { - "type": "string", - "description": "The identifier.", - "title": "ID" - } - } - }, - "title": "Data" - } - }, - "title": "Statuses" - }, - "locations": { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type.", - "title": "Type" - }, - "id": { - "type": "string", - "description": "The identifier.", - "title": "ID" - } - } - }, - "title": "Data" - } - }, - "title": "Locations" - }, - "orgs": { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type.", - "title": "Type" - }, - "id": { - "type": "string", - "description": "The identifier.", - "title": "ID" - } - } - }, - "title": "Data" - } - }, - "title": "Orgs" - }, - "pictures": { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type.", - "title": "Type" - }, - "id": { - "type": "string", - "description": "The identifier.", - "title": "ID" - } - } - }, - "title": "Data" - } - }, - "title": "Pictures" - }, - "colors": { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type.", - "title": "Type" - }, - "id": { - "type": "string", - "description": "The identifier.", - "title": "ID" - } - } - }, - "title": "Data" - } - }, - "title": "Colors" - }, - "videourls": { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type.", - "title": "Type" - }, - "id": { - "type": "string", - "description": "The identifier.", - "title": "ID" - } - } - }, - "title": "Data" - } - }, - "title": "Video URLs" - } - }, - "title": "Relationships" - } - } - }, - "title": "Data" - }, - "included": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type.", - "title": "Type" - }, - "id": { - "type": "string", - "description": "The identifier.", - "title": "ID" - }, - "attributes": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name.", - "title": "Name" - }, - "singular": { - "type": "string", - "description": "The singular.", - "title": "Singular" - }, - "plural": { - "type": "string", - "description": "The plural.", - "title": "Plural" - }, - "youngSingular": { - "type": "string", - "description": "The young singular.", - "title": "Young Singular" - }, - "youngPlural": { - "type": "string", - "description": "The young plural.", - "title": "Young Plural" - }, - "description": { - "type": "string", - "description": "The description.", - "title": "Description" - }, - "street": { - "type": "string", - "description": "The street.", - "title": "Street" - }, - "city": { - "type": "string", - "description": "The city.", - "title": "City" - }, - "state": { - "type": "string", - "description": "The state.", - "title": "State" - }, - "citystate": { - "type": "string", - "description": "The city and state.", - "title": "City/State" - }, - "postalcode": { - "type": "string", - "description": "The postal code.", - "title": "Postal Code" - }, - "country": { - "type": "string", - "description": "The country.", - "title": "Country" - }, - "phone": { - "type": "string", - "description": "The phone.", - "title": "Phone" - }, - "lat": { - "type": "number", - "format": "float", - "description": "The latitude.", - "title": "Lat" - }, - "lon": { - "type": "number", - "format": "float", - "description": "The longitude.", - "title": "Lon" - }, - "coordinates": { - "type": "string", - "description": "The coordinates.", - "title": "Coordinates" - }, - "email": { - "type": "string", - "description": "The email address.", - "title": "Email" - }, - "url": { - "type": "string", - "description": "The URL address.", - "title": "URL" - }, - "facebookUrl": { - "type": "string", - "description": "The Facebook URL address.", - "title": "Facebook URL" - }, - "type": { - "type": "string", - "description": "The type.", - "title": "Type" - }, - "original": { - "type": "object", - "properties": { - "filesize": { - "type": "integer", - "format": "int32", - "description": "The file size.", - "title": "File Size" - }, - "resolutionX": { - "type": "integer", - "format": "int32", - "description": "The x resolution.", - "title": "Resolution X" - }, - "resolutionY": { - "type": "integer", - "format": "int32", - "description": "The y resolution.", - "title": "Resolution Y" - }, - "url": { - "type": "string", - "description": "The URL address.", - "title": "URL" - } - }, - "title": "Original" - }, - "large": { - "type": "object", - "properties": { - "filesize": { - "type": "integer", - "format": "int32", - "description": "The file size.", - "title": "File Size" - }, - "resolutionX": { - "type": "integer", - "format": "int32", - "description": "The x resolution.", - "title": "Resolution X" - }, - "resolutionY": { - "type": "integer", - "format": "int32", - "description": "The y resolution.", - "title": "Resolution Y" - }, - "url": { - "type": "string", - "description": "The URL address.", - "title": "URL" - } - }, - "title": "Large" - }, - "small": { - "type": "object", - "properties": { - "filesize": { - "type": "integer", - "format": "int32", - "description": "The file size.", - "title": "File Size" - }, - "resolutionX": { - "type": "integer", - "format": "int32", - "description": "The x resolution.", - "title": "Resolution X" - }, - "resolutionY": { - "type": "integer", - "format": "int32", - "description": "The y resolution.", - "title": "Resolution Y" - }, - "url": { - "type": "string", - "description": "The URL address.", - "title": "URL" - } - }, - "title": "Small" - }, - "order": { - "type": "integer", - "format": "int32", - "description": "The order.", - "title": "Order" - }, - "created": { - "type": "string", - "description": "When created.", - "title": "Created" - }, - "updated": { - "type": "string", - "description": "When updated.", - "title": "Updated" - }, - "services": { - "type": "string", - "description": "The services.", - "title": "Services" - }, - "adoptionProcess": { - "type": "string", - "description": "The adoption process.", - "title": "Adoption Process" - }, - "about": { - "type": "string", - "description": "The about.", - "title": "About" - }, - "adoptionUrl": { - "type": "string", - "description": "The adoption URL address.", - "title": "Adoption URL" - }, - "donationUrl": { - "type": "string", - "description": "The donation URL address.", - "title": "Donation URL" - }, - "videoId": { - "type": "string", - "description": "The video identifier.", - "title": "Video ID" - }, - "urlThumbnail": { - "type": "string", - "description": "The thumbnail URL address.", - "title": "URL Thumbnail" - } - }, - "title": "Attributes" - }, - "links": { - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The self.", - "title": "Self" - } - }, - "title": "Links" - } - } - }, - "title": "Included" - } - } - } - } - }, - "summary": "Get animals", - "description": "Retrieve a list of animals.", - "operationId": "Animal", - "parameters": [ - { - "name": "limit", - "in": "query", - "x-ms-summary": "Limit", - "description": "The limit.", - "required": false, - "type": "integer" - }, - { - "name": "page", - "in": "query", - "x-ms-summary": "Page", - "description": "The page number.", - "required": false, - "type": "integer" - } - ] - } - }, - "/public/animals/search/{status}/": { - "get": { - "responses": { - "200": { - "description": "default", - "schema": { - "type": "object", - "properties": { - "meta": { - "type": "object", - "properties": { - "count": { - "type": "integer", - "format": "int32", - "description": "The count.", - "title": "Count" - }, - "countReturned": { - "type": "integer", - "format": "int32", - "description": "The count returned.", - "title": "Count Returned" - }, - "pageReturned": { - "type": "integer", - "format": "int32", - "description": "The page returned.", - "title": "Page Returned" - }, - "limit": { - "type": "integer", - "format": "int32", - "description": "The limit.", - "title": "Limit" - }, - "pages": { - "type": "integer", - "format": "int32", - "description": "The number of pages.", - "title": "Pages" - }, - "transactionId": { - "type": "string", - "description": "The transaction identifier.", - "title": "Transaction ID" - } - }, - "title": "Meta" - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type.", - "title": "Type" - }, - "id": { - "type": "string", - "description": "The identifier.", - "title": "ID" - }, - "attributes": { - "type": "object", - "properties": { - "isAdoptionPending": { - "type": "boolean", - "description": "Whether adoption is pending.", - "title": "Is Adoption Pending" - }, - "ageGroup": { - "type": "string", - "description": "The age group.", - "title": "Age Group" - }, - "ageString": { - "type": "string", - "description": "The age.", - "title": "Age" - }, - "birthDate": { - "type": "string", - "description": "The birth date.", - "title": "Birth Date" - }, - "isBirthDateExact": { - "type": "boolean", - "description": "Whether birth date is exact.", - "title": "Is Birth Date Exact" - }, - "breedString": { - "type": "string", - "description": "The breed.", - "title": "Breed" - }, - "breedPrimary": { - "type": "string", - "description": "The primary breed.", - "title": "Breed Primary" - }, - "breedPrimaryId": { - "type": "integer", - "format": "int32", - "description": "The primary breed identifier.", - "title": "Breed Primary ID" - }, - "breedSecondary": { - "type": "string", - "description": "The secondary breed.", - "title": "Breed Secondary" - }, - "breedSecondaryId": { - "type": "integer", - "format": "int32", - "description": "The secondary breed identifier.", - "title": "Breed Secondary ID" - }, - "coatLength": { - "type": "string", - "description": "The coat length.", - "title": "Coat Length" - }, - "isCourtesyListing": { - "type": "boolean", - "description": "Whether listing is courtesy.", - "title": "Is Courtesy Listing" - }, - "descriptionHtml": { - "type": "string", - "description": "The description in HTML.", - "title": "Description Html" - }, - "descriptionText": { - "type": "string", - "description": "The description text.", - "title": "Description Text" - }, - "isNeedingFoster": { - "type": "boolean", - "description": "Whether is needing foster.", - "title": "Is Needing Foster" - }, - "isFound": { - "type": "boolean", - "description": "Whether was found.", - "title": "Is Found" - }, - "priority": { - "type": "integer", - "format": "int32", - "description": "The priority.", - "title": "Priority" - }, - "name": { - "type": "string", - "description": "The name.", - "title": "Name" - }, - "pictureCount": { - "type": "integer", - "format": "int32", - "description": "The picture count.", - "title": "Picture Count" - }, - "pictureThumbnailUrl": { - "type": "string", - "description": "The thumbnail picture URL address.", - "title": "Picture Thumbnail URL" - }, - "rescueId": { - "type": "string", - "description": "The rescue identifier.", - "title": "Rescue ID" - }, - "searchString": { - "type": "string", - "description": "The search string.", - "title": "Search String" - }, - "sex": { - "type": "string", - "description": "The sex.", - "title": "Sex" - }, - "sizeCurrent": { - "type": "number", - "format": "float", - "description": "The current size.", - "title": "Size Current" - }, - "sizeUOM": { - "type": "string", - "description": "The size unit of measurement.", - "title": "Size UOM" - }, - "slug": { - "type": "string", - "description": "The slug.", - "title": "Slug" - }, - "isSponsorable": { - "type": "boolean", - "description": "Whether is sponsorable.", - "title": "Is Sponsorable" - }, - "trackerimageUrl": { - "type": "string", - "description": "The tracker image URL address.", - "title": "Tracker Image URL" - }, - "videoCount": { - "type": "integer", - "format": "int32", - "description": "The video count.", - "title": "Video Count" - }, - "videoUrlCount": { - "type": "integer", - "format": "int32", - "description": "The video URL count.", - "title": "Video URL Count" - }, - "createdDate": { - "type": "string", - "description": "The date created.", - "title": "Created Date" - }, - "updatedDate": { - "type": "string", - "description": "When updated date.", - "title": "Updated Date" - }, - "isBreedMixed": { - "type": "boolean", - "description": "Whether is a mixed breed.", - "title": "Is Breed Mixed" - }, - "isCatsOk": { - "type": "boolean", - "description": "Whether is okay with cats.", - "title": "Is Cats Ok" - }, - "isCurrentVaccinations": { - "type": "boolean", - "description": "Whether is current with vaccinations.", - "title": "Is Current Vaccinations" - }, - "isDeclawed": { - "type": "boolean", - "description": "Whether is declawed.", - "title": "Is Declawed" - }, - "isDogsOk": { - "type": "boolean", - "description": "Whether is okay with dogs.", - "title": "Is Dogs Ok" - }, - "isHousetrained": { - "type": "boolean", - "description": "Whether is house-trained.", - "title": "Is House-trained" - }, - "isKidsOk": { - "type": "boolean", - "description": "Whether is okay with kids.", - "title": "Is Kids Ok" - }, - "sizeGroup": { - "type": "string", - "description": "The group size.", - "title": "Size Group" - }, - "activityLevel": { - "type": "string", - "description": "The activity level.", - "title": "Activity Level" - }, - "energyLevel": { - "type": "string", - "description": "The energy level.", - "title": "Energy Level" - }, - "indoorOutdoor": { - "type": "string", - "description": "The indoor and outdoor preference.", - "title": "Indoor Outdoor" - }, - "newPeopleReaction": { - "type": "string", - "description": "The reaction with new people.", - "title": "New People Reaction" - }, - "adoptionFeeString": { - "type": "string", - "description": "The adoption fee.", - "title": "Adoption Fee" - }, - "adultSexesOk": { - "type": "string", - "description": "The adult sexes okay with.", - "title": "Adult Sexes Ok" - }, - "exerciseNeeds": { - "type": "string", - "description": "The exercise needs.", - "title": "Exercise Needs" - }, - "fenceNeeds": { - "type": "string", - "description": "The fence needs.", - "title": "Fence Needs" - }, - "groomingNeeds": { - "type": "string", - "description": "The grooming needs.", - "title": "Grooming Needs" - }, - "obedienceTraining": { - "type": "string", - "description": "The obedience training.", - "title": "Obedience Training" - }, - "ownerExperience": { - "type": "string", - "description": "The previous owner experience.", - "title": "Owner Experience" - }, - "sheddingLevel": { - "type": "string", - "description": "The shedding level.", - "title": "Shedding Level" - }, - "isSpecialNeeds": { - "type": "boolean", - "description": "Whether is special needs.", - "title": "Is Special Needs" - }, - "vocalLevel": { - "type": "string", - "description": "The vocal level.", - "title": "Vocal Level" - }, - "isYardRequired": { - "type": "boolean", - "description": "Whether yard is required.", - "title": "Is Yard Required" - }, - "colorDetails": { - "type": "string", - "description": "The color details.", - "title": "Color Details" - }, - "eyeColor": { - "type": "string", - "description": "The eye color.", - "title": "Eye Color" - }, - "killReason": { - "type": "string", - "description": "The kill reason.", - "title": "Kill Reason" - }, - "qualities": { - "type": "array", - "items": { - "type": "string" - }, - "title": "Qualities" - }, - "url": { - "type": "string", - "description": "The URL address.", - "title": "URL" - }, - "sponsorshipMinimum": { - "type": "string", - "description": "The sponsorship minimum.", - "title": "Sponsorship Minimum" - }, - "sponsors": { - "type": "string", - "description": "The sponsors.", - "title": "Sponsors" - }, - "summary": { - "type": "string", - "description": "The summary.", - "title": "Summary" - }, - "foundDate": { - "type": "string", - "description": "The date found.", - "title": "Found Date" - }, - "availableDate": { - "type": "string", - "description": "The date available.", - "title": "Available Date" - }, - "adoptedDate": { - "type": "string", - "description": "The adoption date.", - "title": "Adopted Date" - }, - "sizePotential": { - "type": "integer", - "format": "int32", - "description": "The potential size.", - "title": "Size Potential" - } - }, - "title": "Attributes" - }, - "relationships": { - "type": "object", - "properties": { - "breeds": { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type.", - "title": "Type" - }, - "id": { - "type": "string", - "description": "The identifier.", - "title": "ID" - } - } - }, - "title": "Data" - } - }, - "title": "Breeds" - }, - "colors": { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type.", - "title": "Type" - }, - "id": { - "type": "string", - "description": "The identifier.", - "title": "ID" - } - } - }, - "title": "Data" - } - }, - "title": "Colors" - }, - "patterns": { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type.", - "title": "Type" - }, - "id": { - "type": "string", - "description": "The identifier.", - "title": "ID" - } - } - }, - "title": "Data" - } - }, - "title": "Patterns" - }, - "species": { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type.", - "title": "Type" - }, - "id": { - "type": "string", - "description": "The identifier.", - "title": "ID" - } - } - }, - "title": "Data" - } - }, - "title": "Species" - }, - "statuses": { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type.", - "title": "Type" - }, - "id": { - "type": "string", - "description": "The identifier.", - "title": "ID" - } - } - }, - "title": "Data" - } - }, - "title": "Statuses" - }, - "locations": { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type.", - "title": "Type" - }, - "id": { - "type": "string", - "description": "The identifier.", - "title": "ID" - } - } - }, - "title": "Data" - } - }, - "title": "Locations" - }, - "orgs": { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type.", - "title": "Type" - }, - "id": { - "type": "string", - "description": "The identifier.", - "title": "ID" - } - } - }, - "title": "Data" - } - }, - "title": "Orgs" - }, - "pictures": { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type.", - "title": "Type" - }, - "id": { - "type": "string", - "description": "The identifier.", - "title": "ID" - } - } - }, - "title": "Data" - } - }, - "title": "Pictures" - }, - "fosters": { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type.", - "title": "Type" - }, - "id": { - "type": "string", - "description": "The identifier.", - "title": "ID" - } - } - }, - "title": "Data" - } - }, - "title": "Fosters" - }, - "videos": { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type.", - "title": "Type" - }, - "id": { - "type": "string", - "description": "The identifier.", - "title": "ID" - } - } - }, - "title": "Data" - } - }, - "title": "Videos" - }, - "videourls": { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type.", - "title": "Type" - }, - "id": { - "type": "string", - "description": "The identifier.", - "title": "ID" - } - } - }, - "title": "Data" - } - }, - "title": "Videourls" - } - }, - "title": "Relationships" - } - } - }, - "title": "Data" - }, - "included": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type.", - "title": "Type" - }, - "id": { - "type": "string", - "description": "The identifier.", - "title": "ID" - }, - "attributes": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name.", - "title": "Name" - }, - "singular": { - "type": "string", - "description": "The singular.", - "title": "Singular" - }, - "plural": { - "type": "string", - "description": "The plural.", - "title": "Plural" - }, - "youngSingular": { - "type": "string", - "description": "The young singular.", - "title": "Young Singular" - }, - "youngPlural": { - "type": "string", - "description": "The young plural.", - "title": "Young Plural" - }, - "description": { - "type": "string", - "description": "The description.", - "title": "Description" - }, - "street": { - "type": "string", - "description": "The street.", - "title": "Street" - }, - "city": { - "type": "string", - "description": "The city.", - "title": "City" - }, - "state": { - "type": "string", - "description": "The state.", - "title": "State" - }, - "citystate": { - "type": "string", - "description": "The city and state.", - "title": "City/State" - }, - "postalcode": { - "type": "string", - "description": "The postal code.", - "title": "Postal Code" - }, - "country": { - "type": "string", - "description": "The country.", - "title": "Country" - }, - "phone": { - "type": "string", - "description": "The phone.", - "title": "Phone" - }, - "lat": { - "type": "number", - "format": "float", - "description": "The latitude.", - "title": "Lat" - }, - "lon": { - "type": "number", - "format": "float", - "description": "The longitude.", - "title": "Lon" - }, - "coordinates": { - "type": "string", - "description": "The coordinates.", - "title": "Coordinates" - }, - "email": { - "type": "string", - "description": "The email address.", - "title": "Email" - }, - "url": { - "type": "string", - "description": "The URL address.", - "title": "URL" - }, - "facebookUrl": { - "type": "string", - "description": "The Facebook URL address.", - "title": "Facebook URL" - }, - "adoptionProcess": { - "type": "string", - "description": "The adoption process.", - "title": "Adoption Process" - }, - "about": { - "type": "string", - "description": "The about.", - "title": "About" - }, - "services": { - "type": "string", - "description": "The services.", - "title": "Services" - }, - "type": { - "type": "string", - "description": "The type.", - "title": "Type" - }, - "original": { - "type": "object", - "properties": { - "filesize": { - "type": "integer", - "format": "int32", - "description": "The file size.", - "title": "File Size" - }, - "resolutionX": { - "type": "integer", - "format": "int32", - "description": "The x resolution.", - "title": "Resolution X" - }, - "resolutionY": { - "type": "integer", - "format": "int32", - "description": "The y resolution.", - "title": "Resolution Y" - }, - "url": { - "type": "string", - "description": "The URL address.", - "title": "URL" - } - }, - "title": "Original" - }, - "large": { - "type": "object", - "properties": { - "filesize": { - "type": "integer", - "format": "int32", - "description": "The file size.", - "title": "File Size" - }, - "resolutionX": { - "type": "integer", - "format": "int32", - "description": "The x resolution.", - "title": "Resolution X" - }, - "resolutionY": { - "type": "integer", - "format": "int32", - "description": "The y resolution.", - "title": "Resolution Y" - }, - "url": { - "type": "string", - "description": "The URL address.", - "title": "URL" - } - }, - "title": "Large" - }, - "small": { - "type": "object", - "properties": { - "filesize": { - "type": "integer", - "format": "int32", - "description": "The file size.", - "title": "File Size" - }, - "resolutionX": { - "type": "integer", - "format": "int32", - "description": "The x resolution.", - "title": "Resolution X" - }, - "resolutionY": { - "type": "integer", - "format": "int32", - "description": "The y resolution.", - "title": "Resolution Y" - }, - "url": { - "type": "string", - "description": "The URL address.", - "title": "URL" - } - }, - "title": "Small" - }, - "order": { - "type": "integer", - "format": "int32", - "description": "The order.", - "title": "Order" - }, - "created": { - "type": "string", - "description": "When created.", - "title": "Created" - }, - "updated": { - "type": "string", - "description": "When updated.", - "title": "Updated" - }, - "firstname": { - "type": "string", - "description": "The first name.", - "title": "First Name" - }, - "fullname": { - "type": "string", - "description": "The full name.", - "title": "Full Name" - }, - "adoptionUrl": { - "type": "string", - "description": "The adoption URL address.", - "title": "Adoption URL" - }, - "donationUrl": { - "type": "string", - "description": "The donation URL address.", - "title": "Donation URL" - }, - "sponsorshipUrl": { - "type": "string", - "description": "The sponsorship URL address.", - "title": "Sponsorship URL" - }, - "fileSize": { - "type": "integer", - "format": "int32", - "description": "The file size.", - "title": "File Size" - }, - "videoId": { - "type": "string", - "description": "The video identifier.", - "title": "Video ID" - }, - "urlThumbnail": { - "type": "string", - "description": "The thumbnail URL address.", - "title": "URL Thumbnail" - } - }, - "title": "Attributes" - }, - "links": { - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The self.", - "title": "Self" - } - }, - "title": "Links" - } - } - }, - "title": "Included" - } - } - } - } - }, - "summary": "Get animals by status", - "description": "Retrieves a list of animals by status.", - "operationId": "AnimalStatus", - "parameters": [ - { - "name": "status", - "in": "path", - "x-ms-summary": "Status", - "x-ms-url-encoding": "single", - "description": "The status.", - "required": true, - "type": "string" - }, - { - "name": "limit", - "in": "query", - "x-ms-summary": "Limit", - "description": "The limit.", - "required": false, - "type": "integer" - }, - { - "name": "page", - "in": "query", - "x-ms-summary": "Page", - "description": "The page number.", - "required": false, - "type": "integer" - } - ] - } - }, - "/public/animals/{id}": { - "get": { - "responses": { - "200": { - "description": "default", - "schema": { - "type": "object", - "properties": { - "meta": { - "type": "object", - "properties": { - "count": { - "type": "integer", - "format": "int32", - "description": "The count.", - "title": "Count" - }, - "countReturned": { - "type": "integer", - "format": "int32", - "description": "The count returned.", - "title": "Count Returned" - }, - "pageReturned": { - "type": "integer", - "format": "int32", - "description": "The page returned.", - "title": "Page Returned" - }, - "limit": { - "type": "integer", - "format": "int32", - "description": "The limit.", - "title": "Limit" - }, - "pages": { - "type": "integer", - "format": "int32", - "description": "The number of pages.", - "title": "Pages" - }, - "transactionId": { - "type": "string", - "description": "The transaction identifier.", - "title": "Transaction ID" - } - }, - "title": "Meta" - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type.", - "title": "Type" - }, - "id": { - "type": "string", - "description": "The identifier.", - "title": "ID" - }, - "attributes": { - "type": "object", - "properties": { - "isAdoptionPending": { - "type": "boolean", - "description": "Whether adoption is pending.", - "title": "Is Adoption Pending" - }, - "ageGroup": { - "type": "string", - "description": "The age group.", - "title": "Age Group" - }, - "ageString": { - "type": "string", - "description": "The age.", - "title": "Age" - }, - "birthDate": { - "type": "string", - "description": "The birth date.", - "title": "Birth Date" - }, - "isBirthDateExact": { - "type": "boolean", - "description": "Whether birth date is exact.", - "title": "Is Birth Date Exact" - }, - "breedString": { - "type": "string", - "description": "The breed.", - "title": "Breed" - }, - "breedPrimary": { - "type": "string", - "description": "The primary breed.", - "title": "Breed Primary" - }, - "breedPrimaryId": { - "type": "integer", - "format": "int32", - "description": "The primary breed identifier.", - "title": "Breed Primary ID" - }, - "breedSecondary": { - "type": "string", - "description": "The secondary breed.", - "title": "Breed Secondary" - }, - "breedSecondaryId": { - "type": "integer", - "format": "int32", - "description": "The secondary breed identifier.", - "title": "Breed Secondary ID" - }, - "coatLength": { - "type": "string", - "description": "The coat length.", - "title": "Coat Length" - }, - "isCourtesyListing": { - "type": "boolean", - "description": "Whether listing is courtesy.", - "title": "Is Courtesy Listing" - }, - "descriptionHtml": { - "type": "string", - "description": "The description in HTML.", - "title": "Description Html" - }, - "descriptionText": { - "type": "string", - "description": "The description text.", - "title": "Description Text" - }, - "isNeedingFoster": { - "type": "boolean", - "description": "Whether is needing foster.", - "title": "Is Needing Foster" - }, - "isFound": { - "type": "boolean", - "description": "Whether was found.", - "title": "Is Found" - }, - "priority": { - "type": "integer", - "format": "int32", - "description": "The priority.", - "title": "Priority" - }, - "name": { - "type": "string", - "description": "The name.", - "title": "Name" - }, - "pictureCount": { - "type": "integer", - "format": "int32", - "description": "The picture count.", - "title": "Picture Count" - }, - "pictureThumbnailUrl": { - "type": "string", - "description": "The thumbnail picture URL address.", - "title": "Picture Thumbnail URL" - }, - "rescueId": { - "type": "string", - "description": "The rescue identifier.", - "title": "Rescue ID" - }, - "searchString": { - "type": "string", - "description": "The search string.", - "title": "Search String" - }, - "sex": { - "type": "string", - "description": "The sex.", - "title": "Sex" - }, - "sizeCurrent": { - "type": "number", - "format": "float", - "description": "The current size.", - "title": "Size Current" - }, - "sizeUOM": { - "type": "string", - "description": "The size unit of measurement.", - "title": "Size UOM" - }, - "slug": { - "type": "string", - "description": "The slug.", - "title": "Slug" - }, - "isSponsorable": { - "type": "boolean", - "description": "Whether is sponsorable.", - "title": "Is Sponsorable" - }, - "trackerimageUrl": { - "type": "string", - "description": "The tracker image URL address.", - "title": "Tracker Image URL" - }, - "videoCount": { - "type": "integer", - "format": "int32", - "description": "The video count.", - "title": "Video Count" - }, - "videoUrlCount": { - "type": "integer", - "format": "int32", - "description": "The video URL count.", - "title": "Video URL Count" - }, - "createdDate": { - "type": "string", - "description": "The date created.", - "title": "Created Date" - }, - "updatedDate": { - "type": "string", - "description": "When updated date.", - "title": "Updated Date" - } - }, - "title": "Attributes" - }, - "relationships": { - "type": "object", - "properties": { - "breeds": { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type.", - "title": "Type" - }, - "id": { - "type": "string", - "description": "The identifier.", - "title": "ID" - } - } - }, - "title": "Data" - } - }, - "title": "Breeds" - }, - "colors": { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type.", - "title": "Type" - }, - "id": { - "type": "string", - "description": "The identifier.", - "title": "ID" - } - } - }, - "title": "Data" - } - }, - "title": "Colors" - }, - "patterns": { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type.", - "title": "Type" - }, - "id": { - "type": "string", - "description": "The identifier.", - "title": "ID" - } - } - }, - "title": "Data" - } - }, - "title": "Patterns" - }, - "species": { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type.", - "title": "Type" - }, - "id": { - "type": "string", - "description": "The identifier.", - "title": "ID" - } - } - }, - "title": "Data" - } - }, - "title": "Species" - }, - "statuses": { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type.", - "title": "Type" - }, - "id": { - "type": "string", - "description": "The identifier.", - "title": "ID" - } - } - }, - "title": "Data" - } - }, - "title": "Statuses" - }, - "locations": { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type.", - "title": "Type" - }, - "id": { - "type": "string", - "description": "The identifier.", - "title": "ID" - } - } - }, - "title": "Data" - } - }, - "title": "Locations" - }, - "orgs": { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type.", - "title": "Type" - }, - "id": { - "type": "string", - "description": "The identifier.", - "title": "ID" - } - } - }, - "title": "Data" - } - }, - "title": "Orgs" - }, - "pictures": { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type.", - "title": "Type" - }, - "id": { - "type": "string", - "description": "The identifier.", - "title": "ID" - } - } - }, - "title": "Data" - } - }, - "title": "Pictures" - } - }, - "title": "Relationships" - } - } - }, - "title": "Data" - }, - "included": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type.", - "title": "Type" - }, - "id": { - "type": "string", - "description": "The identifier.", - "title": "ID" - }, - "attributes": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name.", - "title": "Name" - }, - "singular": { - "type": "string", - "description": "The singular.", - "title": "Singular" - }, - "plural": { - "type": "string", - "description": "The plural.", - "title": "Plural" - }, - "youngSingular": { - "type": "string", - "description": "The young singular.", - "title": "Young Singular" - }, - "youngPlural": { - "type": "string", - "description": "The young plural.", - "title": "Young Plural" - }, - "description": { - "type": "string", - "description": "The description.", - "title": "Description" - }, - "street": { - "type": "string", - "description": "The street.", - "title": "Street" - }, - "city": { - "type": "string", - "description": "The city.", - "title": "City" - }, - "state": { - "type": "string", - "description": "The state.", - "title": "State" - }, - "citystate": { - "type": "string", - "description": "The city and state.", - "title": "City/State" - }, - "postalcode": { - "type": "string", - "description": "The postal code.", - "title": "Postal Code" - }, - "country": { - "type": "string", - "description": "The country.", - "title": "Country" - }, - "phone": { - "type": "string", - "description": "The phone.", - "title": "Phone" - }, - "lat": { - "type": "number", - "format": "float", - "description": "The latitude.", - "title": "Lat" - }, - "lon": { - "type": "number", - "format": "float", - "description": "The longitude.", - "title": "Lon" - }, - "coordinates": { - "type": "string", - "description": "The coordinates.", - "title": "Coordinates" - }, - "email": { - "type": "string", - "description": "The email address.", - "title": "Email" - }, - "url": { - "type": "string", - "description": "The URL address.", - "title": "URL" - }, - "facebookUrl": { - "type": "string", - "description": "The Facebook URL address.", - "title": "Facebook URL" - }, - "adoptionProcess": { - "type": "string", - "description": "The adoption process.", - "title": "Adoption Process" - }, - "about": { - "type": "string", - "description": "The about.", - "title": "About" - }, - "services": { - "type": "string", - "description": "The services.", - "title": "Services" - }, - "type": { - "type": "string", - "description": "The type.", - "title": "Type" - }, - "original": { - "type": "object", - "properties": { - "filesize": { - "type": "integer", - "format": "int32", - "description": "The file size.", - "title": "File Size" - }, - "resolutionX": { - "type": "integer", - "format": "int32", - "description": "The x resolution.", - "title": "Resolution X" - }, - "resolutionY": { - "type": "integer", - "format": "int32", - "description": "The y resolution.", - "title": "Resolution Y" - }, - "url": { - "type": "string", - "description": "The URL address.", - "title": "URL" - } - }, - "title": "Original" - }, - "large": { - "type": "object", - "properties": { - "filesize": { - "type": "integer", - "format": "int32", - "description": "The file size.", - "title": "File Size" - }, - "resolutionX": { - "type": "integer", - "format": "int32", - "description": "The x resolution.", - "title": "Resolution X" - }, - "resolutionY": { - "type": "integer", - "format": "int32", - "description": "The y resolution.", - "title": "Resolution Y" - }, - "url": { - "type": "string", - "description": "The URL address.", - "title": "URL" - } - }, - "title": "Large" - }, - "small": { - "type": "object", - "properties": { - "filesize": { - "type": "integer", - "format": "int32", - "description": "The file size.", - "title": "File Size" - }, - "resolutionX": { - "type": "integer", - "format": "int32", - "description": "The x resolution.", - "title": "Resolution X" - }, - "resolutionY": { - "type": "integer", - "format": "int32", - "description": "The y resolution.", - "title": "Resolution Y" - }, - "url": { - "type": "string", - "description": "The URL address.", - "title": "URL" - } - }, - "title": "Small" - }, - "order": { - "type": "integer", - "format": "int32", - "description": "The order.", - "title": "Order" - }, - "created": { - "type": "string", - "description": "When created.", - "title": "Created" - }, - "updated": { - "type": "string", - "description": "When updated.", - "title": "Updated" - } - }, - "title": "Attributes" - }, - "links": { - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The self.", - "title": "Self" - } - }, - "title": "Links" - } - } - }, - "title": "Included" - } - } - } - } - }, - "summary": "Get animal by ID", - "description": "Retrieves an animal's information by identifier.", - "operationId": "AnimalID", - "parameters": [ - { - "name": "id", - "in": "path", - "x-ms-summary": "Identifier", - "x-ms-url-encoding": "single", - "description": "The identifier.", - "required": true, - "type": "string" - } - ], - "x-ms-visibility": "important" - } - }, - "/public/orgs/{id}/animals/": { - "get": { - "responses": { - "200": { - "description": "default", - "schema": { - "type": "object", - "properties": { - "meta": { - "type": "object", - "properties": { - "count": { - "type": "integer", - "format": "int32", - "description": "The count.", - "title": "Count" - }, - "countReturned": { - "type": "integer", - "format": "int32", - "description": "The count returned.", - "title": "Count Returned" - }, - "pageReturned": { - "type": "integer", - "format": "int32", - "description": "The page returned.", - "title": "Page Returned" - }, - "limit": { - "type": "integer", - "format": "int32", - "description": "The limit.", - "title": "Limit" - }, - "pages": { - "type": "integer", - "format": "int32", - "description": "The number of pages.", - "title": "Pages" - }, - "transactionId": { - "type": "string", - "description": "The transaction identifier.", - "title": "Transaction ID" - } - }, - "title": "Meta" - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type.", - "title": "Type" - }, - "id": { - "type": "string", - "description": "The identifier.", - "title": "ID" - }, - "attributes": { - "type": "object", - "properties": { - "activityLevel": { - "type": "string", - "description": "The activity level.", - "title": "Activity Level" - }, - "isAdoptionPending": { - "type": "boolean", - "description": "Whether adoption is pending.", - "title": "Is Adoption Pending" - }, - "ageString": { - "type": "string", - "description": "The age.", - "title": "Age" - }, - "birthDate": { - "type": "string", - "description": "The birth date.", - "title": "Birth Date" - }, - "isBirthDateExact": { - "type": "boolean", - "description": "Whether birth date is exact.", - "title": "Is Birth Date Exact" - }, - "breedString": { - "type": "string", - "description": "The breed.", - "title": "Breed" - }, - "breedPrimary": { - "type": "string", - "description": "The primary breed.", - "title": "Breed Primary" - }, - "breedPrimaryId": { - "type": "integer", - "format": "int32", - "description": "The primary breed identifier.", - "title": "Breed Primary ID" - }, - "isBreedMixed": { - "type": "boolean", - "description": "Whether is a mixed breed.", - "title": "Is Breed Mixed" - }, - "isCatsOk": { - "type": "boolean", - "description": "Whether is okay with cats.", - "title": "Is Cats Ok" - }, - "coatLength": { - "type": "string", - "description": "The coat length.", - "title": "Coat Length" - }, - "colorDetails": { - "type": "string", - "description": "The color details.", - "title": "Color Details" - }, - "isCourtesyListing": { - "type": "boolean", - "description": "Whether listing is courtesy.", - "title": "Is Courtesy Listing" - }, - "isCurrentVaccinations": { - "type": "boolean", - "description": "Whether is current with vaccinations.", - "title": "Is Current Vaccinations" - }, - "isDeclawed": { - "type": "boolean", - "description": "Whether is declawed.", - "title": "Is Declawed" - }, - "descriptionHtml": { - "type": "string", - "description": "The description in HTML.", - "title": "Description Html" - }, - "descriptionText": { - "type": "string", - "description": "The description text.", - "title": "Description Text" - }, - "isNeedingFoster": { - "type": "boolean", - "description": "Whether is needing foster.", - "title": "Is Needing Foster" - }, - "isFound": { - "type": "boolean", - "description": "Whether was found.", - "title": "Is Found" - }, - "priority": { - "type": "integer", - "format": "int32", - "description": "The priority.", - "title": "Priority" - }, - "indoorOutdoor": { - "type": "string", - "description": "The indoor and outdoor preference.", - "title": "Indoor Outdoor" - }, - "name": { - "type": "string", - "description": "The name.", - "title": "Name" - }, - "newPeopleReaction": { - "type": "string", - "description": "The reaction with new people.", - "title": "New People Reaction" - }, - "ownerExperience": { - "type": "string", - "description": "The previous owner experience.", - "title": "Owner Experience" - }, - "pictureCount": { - "type": "integer", - "format": "int32", - "description": "The picture count.", - "title": "Picture Count" - }, - "pictureThumbnailUrl": { - "type": "string", - "description": "The thumbnail picture URL address.", - "title": "Picture Thumbnail URL" - }, - "searchString": { - "type": "string", - "description": "The search string.", - "title": "Search String" - }, - "sex": { - "type": "string", - "description": "The sex.", - "title": "Sex" - }, - "sizeGroup": { - "type": "string", - "description": "The group size.", - "title": "Size Group" - }, - "sizeUOM": { - "type": "string", - "description": "The size unit of measurement.", - "title": "Size UOM" - }, - "slug": { - "type": "string", - "description": "The slug.", - "title": "Slug" - }, - "isSpecialNeeds": { - "type": "boolean", - "description": "Whether is special needs.", - "title": "Is Special Needs" - }, - "isSponsorable": { - "type": "boolean", - "description": "Whether is sponsorable.", - "title": "Is Sponsorable" - }, - "trackerimageUrl": { - "type": "string", - "description": "The tracker image URL address.", - "title": "Tracker Image URL" - }, - "url": { - "type": "string", - "description": "The URL address.", - "title": "URL" - }, - "videoCount": { - "type": "integer", - "format": "int32", - "description": "The video count.", - "title": "Video Count" - }, - "videoUrlCount": { - "type": "integer", - "format": "int32", - "description": "The video URL count.", - "title": "Video URL Count" - }, - "createdDate": { - "type": "string", - "description": "The date created.", - "title": "Created Date" - }, - "updatedDate": { - "type": "string", - "description": "When updated date.", - "title": "Updated Date" - }, - "ageGroup": { - "type": "string", - "description": "The age group.", - "title": "Age Group" - }, - "breedSecondary": { - "type": "string", - "description": "The secondary breed.", - "title": "Breed Secondary" - }, - "breedSecondaryId": { - "type": "integer", - "format": "int32", - "description": "The secondary breed identifier.", - "title": "Breed Secondary ID" - }, - "isKidsOk": { - "type": "boolean", - "description": "Whether is okay with kids.", - "title": "Is Kids Ok" - }, - "isDogsOk": { - "type": "boolean", - "description": "Whether is okay with dogs.", - "title": "Is Dogs Ok" - }, - "adoptedDate": { - "type": "string", - "description": "The adoption date.", - "title": "Adopted Date" - }, - "sizeCurrent": { - "type": "number", - "format": "float", - "description": "The current size.", - "title": "Size Current" - } - }, - "title": "Attributes" - }, - "relationships": { - "type": "object", - "properties": { - "breeds": { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type.", - "title": "Type" - }, - "id": { - "type": "string", - "description": "The identifier.", - "title": "ID" - } - } - }, - "title": "Data" - } - }, - "title": "Breeds" - }, - "colors": { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type.", - "title": "Type" - }, - "id": { - "type": "string", - "description": "The identifier.", - "title": "ID" - } - } - }, - "title": "Data" - } - }, - "title": "Colors" - }, - "species": { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type.", - "title": "Type" - }, - "id": { - "type": "string", - "description": "The identifier.", - "title": "ID" - } - } - }, - "title": "Data" - } - }, - "title": "Species" - }, - "statuses": { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type.", - "title": "Type" - }, - "id": { - "type": "string", - "description": "The identifier.", - "title": "ID" - } - } - }, - "title": "Data" - } - }, - "title": "Statuses" - }, - "locations": { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type.", - "title": "Type" - }, - "id": { - "type": "string", - "description": "The identifier.", - "title": "ID" - } - } - }, - "title": "Data" - } - }, - "title": "Locations" - }, - "orgs": { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type.", - "title": "Type" - }, - "id": { - "type": "string", - "description": "The identifier.", - "title": "ID" - } - } - }, - "title": "Data" - } - }, - "title": "Orgs" - }, - "pictures": { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type.", - "title": "Type" - }, - "id": { - "type": "string", - "description": "The identifier.", - "title": "ID" - } - } - }, - "title": "Data" - } - }, - "title": "Pictures" - }, - "patterns": { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type.", - "title": "Type" - }, - "id": { - "type": "string", - "description": "The identifier.", - "title": "ID" - } - } - }, - "title": "Data" - } - }, - "title": "Patterns" - } - }, - "title": "Relationships" - } - } - }, - "title": "Data" - }, - "included": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type.", - "title": "Type" - }, - "id": { - "type": "string", - "description": "The identifier.", - "title": "ID" - }, - "attributes": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name.", - "title": "Name" - }, - "singular": { - "type": "string", - "description": "The singular.", - "title": "Singular" - }, - "plural": { - "type": "string", - "description": "The plural.", - "title": "Plural" - }, - "youngSingular": { - "type": "string", - "description": "The young singular.", - "title": "Young Singular" - }, - "youngPlural": { - "type": "string", - "description": "The young plural.", - "title": "Young Plural" - }, - "description": { - "type": "string", - "description": "The description.", - "title": "Description" - }, - "city": { - "type": "string", - "description": "The city.", - "title": "City" - }, - "state": { - "type": "string", - "description": "The state.", - "title": "State" - }, - "citystate": { - "type": "string", - "description": "The city and state.", - "title": "City/State" - }, - "postalcode": { - "type": "string", - "description": "The postal code.", - "title": "Postal Code" - }, - "country": { - "type": "string", - "description": "The country.", - "title": "Country" - }, - "lat": { - "type": "number", - "format": "float", - "description": "The latitude.", - "title": "Lat" - }, - "lon": { - "type": "number", - "format": "float", - "description": "The longitude.", - "title": "Lon" - }, - "coordinates": { - "type": "string", - "description": "The coordinates.", - "title": "Coordinates" - }, - "postalcodePlus4": { - "type": "string", - "description": "The postal code plus 4 digits.", - "title": "Postal Code Plus 4" - }, - "email": { - "type": "string", - "description": "The email address.", - "title": "Email" - }, - "url": { - "type": "string", - "description": "The URL address.", - "title": "URL" - }, - "facebookUrl": { - "type": "string", - "description": "The Facebook URL address.", - "title": "Facebook URL" - }, - "type": { - "type": "string", - "description": "The type.", - "title": "Type" - }, - "original": { - "type": "object", - "properties": { - "filesize": { - "type": "integer", - "format": "int32", - "description": "The file size.", - "title": "File Size" - }, - "resolutionX": { - "type": "integer", - "format": "int32", - "description": "The x resolution.", - "title": "Resolution X" - }, - "resolutionY": { - "type": "integer", - "format": "int32", - "description": "The y resolution.", - "title": "Resolution Y" - }, - "url": { - "type": "string", - "description": "The URL address.", - "title": "URL" - } - }, - "title": "Original" - }, - "large": { - "type": "object", - "properties": { - "filesize": { - "type": "integer", - "format": "int32", - "description": "The file size.", - "title": "File Size" - }, - "resolutionX": { - "type": "integer", - "format": "int32", - "description": "The x resolution.", - "title": "Resolution X" - }, - "resolutionY": { - "type": "integer", - "format": "int32", - "description": "The y resolution.", - "title": "Resolution Y" - }, - "url": { - "type": "string", - "description": "The URL address.", - "title": "URL" - } - }, - "title": "Large" - }, - "small": { - "type": "object", - "properties": { - "filesize": { - "type": "integer", - "format": "int32", - "description": "The file size.", - "title": "File Size" - }, - "resolutionX": { - "type": "integer", - "format": "int32", - "description": "The x resolution.", - "title": "Resolution X" - }, - "resolutionY": { - "type": "integer", - "format": "int32", - "description": "The y resolution.", - "title": "Resolution Y" - }, - "url": { - "type": "string", - "description": "The URL address.", - "title": "URL" - } - }, - "title": "Small" - }, - "order": { - "type": "integer", - "format": "int32", - "description": "The order.", - "title": "Order" - }, - "created": { - "type": "string", - "description": "When created.", - "title": "Created" - }, - "updated": { - "type": "string", - "description": "When updated.", - "title": "Updated" - } - }, - "title": "Attributes" - }, - "links": { - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The self.", - "title": "Self" - } - }, - "title": "Links" - } - } - }, - "title": "Included" - } - } - } - } - }, - "summary": "Get animals at organization", - "description": "Retrieve a list of animals at an organization.", - "operationId": "OrganizationAnimal", - "x-ms-visibility": "important", - "parameters": [ - { - "name": "id", - "in": "path", - "x-ms-summary": "Identifier", - "x-ms-url-encoding": "single", - "description": "The identifier.", - "required": true, - "type": "string" - }, - { - "name": "limit", - "in": "query", - "x-ms-summary": "Limit", - "description": "The limit.", - "required": false, - "type": "integer" - }, - { - "name": "page", - "in": "query", - "x-ms-summary": "Page", - "description": "The page number.", - "required": false, - "type": "integer" - } - ] - } - }, - "/public/orgs/{id}/animals/search/{status}/": { - "get": { - "responses": { - "200": { - "description": "default", - "schema": { - "type": "object", - "properties": { - "meta": { - "type": "object", - "properties": { - "count": { - "type": "integer", - "format": "int32", - "description": "The count.", - "title": "Count" - }, - "countReturned": { - "type": "integer", - "format": "int32", - "description": "The count returned.", - "title": "Count Returned" - }, - "pageReturned": { - "type": "integer", - "format": "int32", - "description": "The page returned.", - "title": "Page Returned" - }, - "limit": { - "type": "integer", - "format": "int32", - "description": "The limit.", - "title": "Limit" - }, - "pages": { - "type": "integer", - "format": "int32", - "description": "The number of pages.", - "title": "Pages" - }, - "transactionId": { - "type": "string", - "description": "The transaction identifier.", - "title": "Transaction ID" - } - }, - "title": "Meta" - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type.", - "title": "Type" - }, - "id": { - "type": "string", - "description": "The identifier.", - "title": "ID" - }, - "attributes": { - "type": "object", - "properties": { - "activityLevel": { - "type": "string", - "description": "The activity level.", - "title": "Activity Level" - }, - "isAdoptionPending": { - "type": "boolean", - "description": "Whether adoption is pending.", - "title": "Is Adoption Pending" - }, - "ageGroup": { - "type": "string", - "description": "The age group.", - "title": "Age Group" - }, - "ageString": { - "type": "string", - "description": "The age.", - "title": "Age" - }, - "birthDate": { - "type": "string", - "description": "The birth date.", - "title": "Birth Date" - }, - "isBirthDateExact": { - "type": "boolean", - "description": "Whether birth date is exact.", - "title": "Is Birth Date Exact" - }, - "breedString": { - "type": "string", - "description": "The breed.", - "title": "Breed" - }, - "breedPrimary": { - "type": "string", - "description": "The primary breed.", - "title": "Breed Primary" - }, - "breedPrimaryId": { - "type": "integer", - "format": "int32", - "description": "The primary breed identifier.", - "title": "Breed Primary ID" - }, - "isBreedMixed": { - "type": "boolean", - "description": "Whether is a mixed breed.", - "title": "Is Breed Mixed" - }, - "coatLength": { - "type": "string", - "description": "The coat length.", - "title": "Coat Length" - }, - "colorDetails": { - "type": "string", - "description": "The color details.", - "title": "Color Details" - }, - "isCourtesyListing": { - "type": "boolean", - "description": "Whether listing is courtesy.", - "title": "Is Courtesy Listing" - }, - "isCurrentVaccinations": { - "type": "boolean", - "description": "Whether is current with vaccinations.", - "title": "Is Current Vaccinations" - }, - "descriptionHtml": { - "type": "string", - "description": "The description in HTML.", - "title": "Description Html" - }, - "descriptionText": { - "type": "string", - "description": "The description text.", - "title": "Description Text" - }, - "isNeedingFoster": { - "type": "boolean", - "description": "Whether is needing foster.", - "title": "Is Needing Foster" - }, - "isFound": { - "type": "boolean", - "description": "Whether was found.", - "title": "Is Found" - }, - "priority": { - "type": "integer", - "format": "int32", - "description": "The priority.", - "title": "Priority" - }, - "indoorOutdoor": { - "type": "string", - "description": "The indoor and outdoor preference.", - "title": "Indoor Outdoor" - }, - "name": { - "type": "string", - "description": "The name.", - "title": "Name" - }, - "pictureCount": { - "type": "integer", - "format": "int32", - "description": "The picture count.", - "title": "Picture Count" - }, - "pictureThumbnailUrl": { - "type": "string", - "description": "The thumbnail picture URL address.", - "title": "Picture Thumbnail URL" - }, - "searchString": { - "type": "string", - "description": "The search string.", - "title": "Search String" - }, - "sex": { - "type": "string", - "description": "The sex.", - "title": "Sex" - }, - "sizeGroup": { - "type": "string", - "description": "The group size.", - "title": "Size Group" - }, - "sizeUOM": { - "type": "string", - "description": "The size unit of measurement.", - "title": "Size UOM" - }, - "slug": { - "type": "string", - "description": "The slug.", - "title": "Slug" - }, - "isSpecialNeeds": { - "type": "boolean", - "description": "Whether is special needs.", - "title": "Is Special Needs" - }, - "isSponsorable": { - "type": "boolean", - "description": "Whether is sponsorable.", - "title": "Is Sponsorable" - }, - "trackerimageUrl": { - "type": "string", - "description": "The tracker image URL address.", - "title": "Tracker Image URL" - }, - "url": { - "type": "string", - "description": "The URL address.", - "title": "URL" - }, - "videoCount": { - "type": "integer", - "format": "int32", - "description": "The video count.", - "title": "Video Count" - }, - "videoUrlCount": { - "type": "integer", - "format": "int32", - "description": "The video URL count.", - "title": "Video URL Count" - }, - "createdDate": { - "type": "string", - "description": "The date created.", - "title": "Created Date" - }, - "updatedDate": { - "type": "string", - "description": "When updated date.", - "title": "Updated Date" - } - }, - "title": "Attributes" - }, - "relationships": { - "type": "object", - "properties": { - "breeds": { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type.", - "title": "Type" - }, - "id": { - "type": "string", - "description": "The identifier.", - "title": "ID" - } - } - }, - "title": "Data" - } - }, - "title": "Breeds" - }, - "colors": { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type.", - "title": "Type" - }, - "id": { - "type": "string", - "description": "The identifier.", - "title": "ID" - } - } - }, - "title": "Data" - } - }, - "title": "Colors" - }, - "patterns": { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type.", - "title": "Type" - }, - "id": { - "type": "string", - "description": "The identifier.", - "title": "ID" - } - } - }, - "title": "Data" - } - }, - "title": "Patterns" - }, - "species": { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type.", - "title": "Type" - }, - "id": { - "type": "string", - "description": "The identifier.", - "title": "ID" - } - } - }, - "title": "Data" - } - }, - "title": "Species" - }, - "statuses": { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type.", - "title": "Type" - }, - "id": { - "type": "string", - "description": "The identifier.", - "title": "ID" - } - } - }, - "title": "Data" - } - }, - "title": "Statuses" - }, - "locations": { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type.", - "title": "Type" - }, - "id": { - "type": "string", - "description": "The identifier.", - "title": "ID" - } - } - }, - "title": "Data" - } - }, - "title": "Locations" - }, - "orgs": { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type.", - "title": "Type" - }, - "id": { - "type": "string", - "description": "The identifier.", - "title": "ID" - } - } - }, - "title": "Data" - } - }, - "title": "Orgs" - }, - "pictures": { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type.", - "title": "Type" - }, - "id": { - "type": "string", - "description": "The identifier.", - "title": "ID" - } - } - }, - "title": "Data" - } - }, - "title": "Pictures" - } - }, - "title": "Relationships" - } - } - }, - "title": "Data" - }, - "included": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type.", - "title": "Type" - }, - "id": { - "type": "string", - "description": "The identifier.", - "title": "ID" - }, - "attributes": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name.", - "title": "Name" - }, - "singular": { - "type": "string", - "description": "The singular.", - "title": "Singular" - }, - "plural": { - "type": "string", - "description": "The plural.", - "title": "Plural" - }, - "youngSingular": { - "type": "string", - "description": "The young singular.", - "title": "Young Singular" - }, - "youngPlural": { - "type": "string", - "description": "The young plural.", - "title": "Young Plural" - }, - "description": { - "type": "string", - "description": "The description.", - "title": "Description" - }, - "city": { - "type": "string", - "description": "The city.", - "title": "City" - }, - "state": { - "type": "string", - "description": "The state.", - "title": "State" - }, - "citystate": { - "type": "string", - "description": "The city and state.", - "title": "City/State" - }, - "postalcode": { - "type": "string", - "description": "The postal code.", - "title": "Postal Code" - }, - "country": { - "type": "string", - "description": "The country.", - "title": "Country" - }, - "lat": { - "type": "number", - "format": "float", - "description": "The latitude.", - "title": "Lat" - }, - "lon": { - "type": "number", - "format": "float", - "description": "The longitude.", - "title": "Lon" - }, - "coordinates": { - "type": "string", - "description": "The coordinates.", - "title": "Coordinates" - }, - "postalcodePlus4": { - "type": "string", - "description": "The postal code plus 4 digits.", - "title": "Postal Code Plus 4" - }, - "email": { - "type": "string", - "description": "The email address.", - "title": "Email" - }, - "url": { - "type": "string", - "description": "The URL address.", - "title": "URL" - }, - "facebookUrl": { - "type": "string", - "description": "The Facebook URL address.", - "title": "Facebook URL" - }, - "type": { - "type": "string", - "description": "The type.", - "title": "Type" - }, - "original": { - "type": "object", - "properties": { - "filesize": { - "type": "integer", - "format": "int32", - "description": "The file size.", - "title": "File Size" - }, - "resolutionX": { - "type": "integer", - "format": "int32", - "description": "The x resolution.", - "title": "Resolution X" - }, - "resolutionY": { - "type": "integer", - "format": "int32", - "description": "The y resolution.", - "title": "Resolution Y" - }, - "url": { - "type": "string", - "description": "The URL address.", - "title": "URL" - } - }, - "title": "Original" - }, - "large": { - "type": "object", - "properties": { - "filesize": { - "type": "integer", - "format": "int32", - "description": "The file size.", - "title": "File Size" - }, - "resolutionX": { - "type": "integer", - "format": "int32", - "description": "The x resolution.", - "title": "Resolution X" - }, - "resolutionY": { - "type": "integer", - "format": "int32", - "description": "The y resolution.", - "title": "Resolution Y" - }, - "url": { - "type": "string", - "description": "The URL address.", - "title": "URL" - } - }, - "title": "Large" - }, - "small": { - "type": "object", - "properties": { - "filesize": { - "type": "integer", - "format": "int32", - "description": "The file size.", - "title": "File Size" - }, - "resolutionX": { - "type": "integer", - "format": "int32", - "description": "The x resolution.", - "title": "Resolution X" - }, - "resolutionY": { - "type": "integer", - "format": "int32", - "description": "The y resolution.", - "title": "Resolution Y" - }, - "url": { - "type": "string", - "description": "The URL address.", - "title": "URL" - } - }, - "title": "Small" - }, - "order": { - "type": "integer", - "format": "int32", - "description": "The order.", - "title": "Order" - }, - "created": { - "type": "string", - "description": "When created.", - "title": "Created" - }, - "updated": { - "type": "string", - "description": "When updated.", - "title": "Updated" - } - }, - "title": "Attributes" - }, - "links": { - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The self.", - "title": "Self" - } - }, - "title": "Links" - } - } - }, - "title": "Included" - } - } - } - } - }, - "summary": "Get animals at organization by status", - "description": "Retrieves a list of animals at an organization by status.", - "operationId": "OrganizationAnimalStatus", - "parameters": [ - { - "name": "id", - "in": "path", - "x-ms-summary": "Identifier", - "x-ms-url-encoding": "single", - "description": "The identifier.", - "required": true, - "type": "string" - }, - { - "name": "status", - "in": "path", - "x-ms-summary": "Status", - "x-ms-url-encoding": "single", - "description": "The status.", - "required": true, - "type": "string" - }, - { - "name": "limit", - "in": "query", - "x-ms-summary": "Limit", - "description": "The limit.", - "required": false, - "type": "integer" - }, - { - "name": "page", - "in": "query", - "x-ms-summary": "Page", - "description": "The page number.", - "required": false, - "type": "integer" - } - ] - } - } - }, - "definitions": {}, - "parameters": {}, - "responses": {}, - "securityDefinitions": { - "API Key": { - "type": "apiKey", - "in": "header", - "name": "Authorization" - } - }, - "security": [ - { - "API Key": [] - } - ], - "tags": [], - "x-ms-connector-metadata": [ - { - "propertyName": "Website", - "propertyValue": "https://rescuegroups.org/" - }, - { - "propertyName": "Privacy policy", - "propertyValue": "https://rescuegroups.org/privacy-statement/" - }, - { - "propertyName": "Categories", - "propertyValue": "Lifestyle and Entertainment" - } - ] -} \ No newline at end of file diff --git a/independent-publisher-connectors/RescueGroups/apiProperties.json b/independent-publisher-connectors/RescueGroups/apiProperties.json deleted file mode 100644 index c56e11124d..0000000000 --- a/independent-publisher-connectors/RescueGroups/apiProperties.json +++ /dev/null @@ -1,23 +0,0 @@ -{ - "properties": { - "connectionParameters": { - "api_key": { - "type": "securestring", - "uiDefinition": { - "displayName": "API Key", - "description": "The API Key for this api", - "tooltip": "Provide your API Key", - "constraints": { - "tabIndex": 2, - "clearText": false, - "required": "true" - } - } - } - }, - "iconBrandColor": "#da3b01", - "capabilities": [], - "publisher": "Troy Taylor", - "stackOwner": "RescueGroups.org" - } -} \ No newline at end of file diff --git a/independent-publisher-connectors/RescueGroups/readme.md b/independent-publisher-connectors/RescueGroups/readme.md deleted file mode 100644 index 7e3bb6f05c..0000000000 --- a/independent-publisher-connectors/RescueGroups/readme.md +++ /dev/null @@ -1,37 +0,0 @@ -# RescueGroups -Since 2002, RescueGroups.org has provided animal welfare organizations with easy to use, free and low-cost services like the Pet Adoption Portal to help maximize animal adoptions. - -## Publisher: Troy Taylor, Hitachi Solutions - -## Prerequisites -There are no prerequisites needed to use this service. - -## Obtaining Credentials -An API Key must be requested using the [form on the RescueGroups.org website](https://rescuegroups.org/services/request-an-api-key/). - -## Supported Operations -### Get breeds -Retrieves a list of breeds. -### Get breed by ID -Retrieves the breed information by identifier. -### Get breeds by species -Retrieves a list of breeds by species. -### Get breeds by species ID -Retrieves a list of breeds by species identifier. -### Get organizations -Retrieves a list of organizations. -### Get organization by ID -Retrieve an organization by identifier. -### Get animals -Retrieve a list of animals. -### Get animals by status -Retrieves a list of animals by status. -### Get animal by ID -Retrieves an animal's information by identifier. -### Get animals at organization -Retrieve a list of animals at an organization. -### Get animals at organization by status -Retrieves a list of animals at an organization by status. - -## Known Issues and Limitations -There are no known issues at this time. From 35dd93aaa527b1de5f103c17d741b3ff78ae9ad5 Mon Sep 17 00:00:00 2001 From: Troy Taylor <44444967+troystaylor@users.noreply.github.com> Date: Tue, 19 Jul 2022 16:19:10 -0400 Subject: [PATCH 07/21] Add files via upload --- .../FileIO/apiDefinition.swagger.json | 644 ++++++++++++++++++ .../FileIO/apiProperties.json | 23 + .../FileIO/readme.md | 25 + 3 files changed, 692 insertions(+) create mode 100644 independent-publisher-connectors/FileIO/apiDefinition.swagger.json create mode 100644 independent-publisher-connectors/FileIO/apiProperties.json create mode 100644 independent-publisher-connectors/FileIO/readme.md diff --git a/independent-publisher-connectors/FileIO/apiDefinition.swagger.json b/independent-publisher-connectors/FileIO/apiDefinition.swagger.json new file mode 100644 index 0000000000..8b7c5919b9 --- /dev/null +++ b/independent-publisher-connectors/FileIO/apiDefinition.swagger.json @@ -0,0 +1,644 @@ +{ + "swagger": "2.0", + "info": { + "title": "File.io", + "description": "Simply upload a file, share the link, and after it is downloaded, the file is completely deleted. For added security, set an expiration on the file and it is deleted within a certain amount of time, even if it was never downloaded.", + "version": "1.0", + "contact": { + "name": "Troy Taylor", + "url": "https://www.hitachisolutions.com", + "email": "ttaylor@hitachisolutions.com" + } + }, + "host": "file.io", + "basePath": "/", + "schemes": [ + "https" + ], + "consumes": [ + "multipart/form-data", + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/": { + "get": { + "responses": { + "200": { + "description": "default", + "schema": { + "type": "object", + "properties": { + "success": { + "type": "boolean", + "description": "Whether a success.", + "title": "Success" + }, + "status": { + "type": "integer", + "format": "int32", + "description": "The status.", + "title": "Status" + }, + "nodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "key": { + "type": "string", + "description": "The key.", + "title": "Key" + }, + "path": { + "type": "string", + "description": "The path.", + "title": "Path" + }, + "nodeType": { + "type": "string", + "description": "The node type.", + "title": "Node Type" + }, + "name": { + "type": "string", + "description": "The name.", + "title": "Name" + }, + "title": { + "type": "string", + "description": "The title.", + "title": "Title" + }, + "description": { + "type": "string", + "description": "The description.", + "title": "Description" + }, + "link": { + "type": "string", + "description": "The link.", + "title": "Link" + }, + "private": { + "type": "boolean", + "description": "Whether private.", + "title": "Private" + }, + "expires": { + "type": "string", + "description": "When expires.", + "title": "Expires" + }, + "downloads": { + "type": "integer", + "format": "int32", + "description": "The number of downloads.", + "title": "Downloads" + }, + "maxDownloads": { + "type": "integer", + "format": "int32", + "description": "The maximum number of downloads.", + "title": "Max Downloads" + }, + "autoDelete": { + "type": "boolean", + "description": "Whether automatically deletes.", + "title": "Auto Delete" + }, + "size": { + "type": "integer", + "format": "int32", + "description": "The size.", + "title": "Size" + }, + "mimeType": { + "type": "string", + "description": "The MIME type.", + "title": "MIME Type" + }, + "screeningStatus": { + "type": "string", + "description": "The screening status.", + "title": "Screening Status" + }, + "created": { + "type": "string", + "description": "When created.", + "title": "Created" + }, + "modified": { + "type": "string", + "description": "When modified.", + "title": "Modified" + } + } + }, + "title": "Nodes" + }, + "count": { + "type": "integer", + "format": "int32", + "description": "The count.", + "title": "Count" + }, + "size": { + "type": "integer", + "format": "int32", + "description": "The size.", + "title": "Size" + }, + "screeningStatus": { + "type": "string", + "description": "The screening status.", + "title": "Screening Status" + } + } + } + } + }, + "summary": "Get list of files", + "description": "Retrieves a list of your files.", + "operationId": "FileList", + "parameters": [ + { + "name": "search", + "in": "query", + "x-ms-summary": "Search", + "description": "The search term.", + "required": false, + "type": "string" + }, + { + "name": "sort", + "in": "query", + "x-ms-summary": "Sort", + "description": "The sort by.", + "required": false, + "type": "string" + }, + { + "name": "offset", + "in": "query", + "x-ms-summary": "Offset", + "description": "The offset.", + "required": false, + "type": "integer" + }, + { + "name": "limit", + "in": "query", + "x-ms-summary": "Limit", + "description": "The limit.", + "required": false, + "type": "integer" + } + ] + }, + "post": { + "responses": { + "200": { + "description": "default", + "schema": { + "type": "object", + "properties": { + "success": { + "type": "boolean", + "description": "Whether a success.", + "title": "Success" + }, + "status": { + "type": "integer", + "format": "int32", + "description": "The status.", + "title": "Status" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "key": { + "type": "string", + "description": "The key.", + "title": "Key" + }, + "path": { + "type": "string", + "description": "The path.", + "title": "Path" + }, + "nodeType": { + "type": "string", + "description": "The node type.", + "title": "Node Type" + }, + "name": { + "type": "string", + "description": "The name.", + "title": "Name" + }, + "title": { + "type": "string", + "description": "The title.", + "title": "Title" + }, + "description": { + "type": "string", + "description": "The description.", + "title": "Description" + }, + "link": { + "type": "string", + "description": "The link.", + "title": "Link" + }, + "private": { + "type": "boolean", + "description": "Whether private.", + "title": "Private" + }, + "expires": { + "type": "string", + "description": "When expires.", + "title": "Expires" + }, + "downloads": { + "type": "integer", + "format": "int32", + "description": "The number of downloads.", + "title": "Downloads" + }, + "maxDownloads": { + "type": "integer", + "format": "int32", + "description": "The maximum number of downloads.", + "title": "Max Downloads" + }, + "autoDelete": { + "type": "boolean", + "description": "Whether automatically deletes.", + "title": "Auto Delete" + }, + "size": { + "type": "integer", + "format": "int32", + "description": "The size.", + "title": "Size" + }, + "mimeType": { + "type": "string", + "description": "The MIME type.", + "title": "MIME Type" + }, + "screeningStatus": { + "type": "string", + "description": "The screening status.", + "title": "Screening Status" + }, + "created": { + "type": "string", + "description": "When created.", + "title": "Created" + }, + "modified": { + "type": "string", + "description": "When modified.", + "title": "Modified" + } + } + } + } + }, + "summary": "Upload a file", + "description": "Uploads a file and creates the file details.", + "operationId": "FileUpload", + "parameters": [ + { + "name": "body", + "in": "body", + "required": false, + "schema": { + "type": "object", + "properties": { + "file": { + "type": "string", + "description": "The file.", + "title": "File" + }, + "expires": { + "type": "string", + "description": "When expires.", + "title": "Expires" + }, + "maxDownloads": { + "type": "integer", + "format": "int32", + "description": "The maximum number of downloads.", + "title": "Max Downloads" + }, + "autoDelete": { + "type": "boolean", + "description": "Whether automatically deletes.", + "title": "Auto Delete" + } + } + } + } + ] + } + }, + "/{key}": { + "patch": { + "responses": { + "200": { + "description": "default", + "schema": { + "type": "object", + "properties": { + "success": { + "type": "boolean", + "description": "Whether a success.", + "title": "Success" + }, + "status": { + "type": "integer", + "format": "int32", + "description": "The status.", + "title": "Status" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "key": { + "type": "string", + "description": "The key.", + "title": "Key" + }, + "name": { + "type": "string", + "description": "The name.", + "title": "Name" + }, + "link": { + "type": "string", + "description": "The link.", + "title": "Link" + }, + "expires": { + "type": "string", + "description": "When expires.", + "title": "Expires" + }, + "expiry": { + "type": "string", + "description": "The .", + "title": "Expiry" + }, + "downloads": { + "type": "integer", + "format": "int32", + "description": "The number of downloads.", + "title": "Downloads" + }, + "maxDownloads": { + "type": "integer", + "format": "int32", + "description": "The maximum number of downloads.", + "title": "Max Downloads" + }, + "autoDelete": { + "type": "boolean", + "description": "Whether automatically deletes.", + "title": "Auto Delete" + }, + "size": { + "type": "integer", + "format": "int32", + "description": "The size.", + "title": "Size" + }, + "mimeType": { + "type": "string", + "description": "The MIME type.", + "title": "MIME Type" + }, + "created": { + "type": "string", + "description": "When created.", + "title": "Created" + }, + "modified": { + "type": "string", + "description": "When modified.", + "title": "Modified" + } + } + } + } + }, + "summary": "Update a file", + "description": "Updates a file by key. For any parameters not provided in request, existing values are retained.", + "operationId": "FileUpdate", + "parameters": [ + { + "name": "key", + "in": "path", + "x-ms-summary": "Key", + "x-ms-url-encoding": "single", + "description": "The file key.", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "required": false, + "schema": { + "type": "object", + "properties": { + "file": { + "type": "string", + "description": "The file.", + "title": "File" + }, + "expires": { + "type": "string", + "description": "When expires.", + "title": "Expires" + }, + "maxDownloads": { + "type": "integer", + "format": "int32", + "description": "The maximum number of downloads.", + "title": "Max Downloads" + }, + "autoDelete": { + "type": "boolean", + "description": "Whether automatically deletes.", + "title": "Auto Delete" + } + } + } + } + ] + }, + "delete": { + "responses": { + "200": { + "description": "default", + "schema": { + "type": "object", + "properties": { + "success": { + "type": "boolean", + "description": "Whether a success.", + "title": "Success" + }, + "status": { + "type": "integer", + "format": "int32", + "description": "The status.", + "title": "Status" + } + } + } + } + }, + "summary": "Delete a file", + "description": "Deletes a file identified by key", + "operationId": "FileDelete", + "parameters": [ + { + "name": "key", + "in": "path", + "x-ms-summary": "Key", + "x-ms-url-encoding": "single", + "description": "The file key.", + "required": true, + "type": "string" + } + ] + } + }, + "/me": { + "get": { + "responses": { + "200": { + "description": "default", + "schema": { + "type": "object", + "properties": { + "success": { + "type": "boolean", + "description": "Whether a success.", + "title": "Success" + }, + "status": { + "type": "integer", + "format": "int32", + "description": "The status.", + "title": "Status" + }, + "planId": { + "type": "integer", + "format": "int32", + "description": "The .", + "title": "Plan Id" + }, + "maxUploadBytes": { + "type": "integer", + "format": "int32", + "description": "The .", + "title": "Max Upload Bytes" + }, + "maxStorageBytes": { + "type": "integer", + "format": "int32", + "description": "The .", + "title": "Max Storage Bytes" + }, + "usedStorageBytes": { + "type": "integer", + "format": "int32", + "description": "The .", + "title": "Used Storage Bytes" + }, + "rateLimit": { + "type": "integer", + "format": "int32", + "description": "The .", + "title": "Rate Limit" + }, + "customDomain": { + "type": "string", + "description": "The .", + "title": "Custom Domain" + }, + "directDownload": { + "type": "string", + "description": "The .", + "title": "Direct Download" + }, + "paymentCustomerId": { + "type": "string", + "description": "The .", + "title": "Payment Customer Id" + }, + "paymentSubscriptionId": { + "type": "string", + "description": "The .", + "title": "Payment Subscription Id" + } + } + } + } + }, + "summary": "Get plan and account", + "description": "Retrieves the plan and account details for the user.", + "operationId": "Me", + "parameters": [] + } + } + }, + "definitions": {}, + "parameters": {}, + "responses": {}, + "securityDefinitions": { + "API Key": { + "type": "apiKey", + "in": "header", + "name": "Authorization" + } + }, + "security": [ + { + "API Key": [] + } + ], + "tags": [], + "x-ms-connector-metadata": [ + { + "propertyName": "Website", + "propertyValue": "https://www.file.io/" + }, + { + "propertyName": "Privacy policy", + "propertyValue": "https://www.file.io/privacy" + }, + { + "propertyName": "Categories", + "propertyValue": "Data" + } + ] +} \ No newline at end of file diff --git a/independent-publisher-connectors/FileIO/apiProperties.json b/independent-publisher-connectors/FileIO/apiProperties.json new file mode 100644 index 0000000000..dc00964f3c --- /dev/null +++ b/independent-publisher-connectors/FileIO/apiProperties.json @@ -0,0 +1,23 @@ +{ + "properties": { + "connectionParameters": { + "api_key": { + "type": "securestring", + "uiDefinition": { + "displayName": "API Key (in the form Bearer API_Key)", + "description": "The API Key (in the form Bearer API_Key) for this api", + "tooltip": "Provide your API Key (in the form Bearer API_Key)", + "constraints": { + "tabIndex": 2, + "clearText": false, + "required": "true" + } + } + } + }, + "iconBrandColor": "#da3b01", + "capabilities": [], + "publisher": "Troy Taylor", + "stackOwner": "Mr. Cowboy LLC" + } +} \ No newline at end of file diff --git a/independent-publisher-connectors/FileIO/readme.md b/independent-publisher-connectors/FileIO/readme.md new file mode 100644 index 0000000000..70460ddc63 --- /dev/null +++ b/independent-publisher-connectors/FileIO/readme.md @@ -0,0 +1,25 @@ +# File.io +Simply upload a file, share the link, and after it is downloaded, the file is completely deleted. For added security, set an expiration on the file and it is deleted within a certain amount of time, even if it was never downloaded. + +## Publisher: Troy Taylor, Hitachi Solutions + +## Prerequisites +You must sign up for an account with [file.io](https://www.file.io/signup). + +## Obtaining Credentials +In your account settings, find the API Keys tab and create a new API key. + +## Supported Operations +### Get list of files +Retrieves a list of your files. +### Upload a file +Uploads a file and creates the file details. +### Update a file +Updates a file by key. For any parameters not provided in request, existing values are retained. +### Delete a file +Deletes a file identified by key +### Get plan and account +Retrieves the plan and account details for the user. + +## Known Issues and Limitations +There are no known issues at this time. From 9a9ce19db0aeed7927fc8af1f8d67b598babcf91 Mon Sep 17 00:00:00 2001 From: Troy Taylor <44444967+troystaylor@users.noreply.github.com> Date: Tue, 19 Jul 2022 16:20:52 -0400 Subject: [PATCH 08/21] Delete independent-publisher-connectors/FileIO directory --- .../FileIO/apiDefinition.swagger.json | 644 ------------------ .../FileIO/apiProperties.json | 23 - .../FileIO/readme.md | 25 - 3 files changed, 692 deletions(-) delete mode 100644 independent-publisher-connectors/FileIO/apiDefinition.swagger.json delete mode 100644 independent-publisher-connectors/FileIO/apiProperties.json delete mode 100644 independent-publisher-connectors/FileIO/readme.md diff --git a/independent-publisher-connectors/FileIO/apiDefinition.swagger.json b/independent-publisher-connectors/FileIO/apiDefinition.swagger.json deleted file mode 100644 index 8b7c5919b9..0000000000 --- a/independent-publisher-connectors/FileIO/apiDefinition.swagger.json +++ /dev/null @@ -1,644 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "File.io", - "description": "Simply upload a file, share the link, and after it is downloaded, the file is completely deleted. For added security, set an expiration on the file and it is deleted within a certain amount of time, even if it was never downloaded.", - "version": "1.0", - "contact": { - "name": "Troy Taylor", - "url": "https://www.hitachisolutions.com", - "email": "ttaylor@hitachisolutions.com" - } - }, - "host": "file.io", - "basePath": "/", - "schemes": [ - "https" - ], - "consumes": [ - "multipart/form-data", - "application/json" - ], - "produces": [ - "application/json" - ], - "paths": { - "/": { - "get": { - "responses": { - "200": { - "description": "default", - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean", - "description": "Whether a success.", - "title": "Success" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "The status.", - "title": "Status" - }, - "nodes": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The identifier.", - "title": "ID" - }, - "key": { - "type": "string", - "description": "The key.", - "title": "Key" - }, - "path": { - "type": "string", - "description": "The path.", - "title": "Path" - }, - "nodeType": { - "type": "string", - "description": "The node type.", - "title": "Node Type" - }, - "name": { - "type": "string", - "description": "The name.", - "title": "Name" - }, - "title": { - "type": "string", - "description": "The title.", - "title": "Title" - }, - "description": { - "type": "string", - "description": "The description.", - "title": "Description" - }, - "link": { - "type": "string", - "description": "The link.", - "title": "Link" - }, - "private": { - "type": "boolean", - "description": "Whether private.", - "title": "Private" - }, - "expires": { - "type": "string", - "description": "When expires.", - "title": "Expires" - }, - "downloads": { - "type": "integer", - "format": "int32", - "description": "The number of downloads.", - "title": "Downloads" - }, - "maxDownloads": { - "type": "integer", - "format": "int32", - "description": "The maximum number of downloads.", - "title": "Max Downloads" - }, - "autoDelete": { - "type": "boolean", - "description": "Whether automatically deletes.", - "title": "Auto Delete" - }, - "size": { - "type": "integer", - "format": "int32", - "description": "The size.", - "title": "Size" - }, - "mimeType": { - "type": "string", - "description": "The MIME type.", - "title": "MIME Type" - }, - "screeningStatus": { - "type": "string", - "description": "The screening status.", - "title": "Screening Status" - }, - "created": { - "type": "string", - "description": "When created.", - "title": "Created" - }, - "modified": { - "type": "string", - "description": "When modified.", - "title": "Modified" - } - } - }, - "title": "Nodes" - }, - "count": { - "type": "integer", - "format": "int32", - "description": "The count.", - "title": "Count" - }, - "size": { - "type": "integer", - "format": "int32", - "description": "The size.", - "title": "Size" - }, - "screeningStatus": { - "type": "string", - "description": "The screening status.", - "title": "Screening Status" - } - } - } - } - }, - "summary": "Get list of files", - "description": "Retrieves a list of your files.", - "operationId": "FileList", - "parameters": [ - { - "name": "search", - "in": "query", - "x-ms-summary": "Search", - "description": "The search term.", - "required": false, - "type": "string" - }, - { - "name": "sort", - "in": "query", - "x-ms-summary": "Sort", - "description": "The sort by.", - "required": false, - "type": "string" - }, - { - "name": "offset", - "in": "query", - "x-ms-summary": "Offset", - "description": "The offset.", - "required": false, - "type": "integer" - }, - { - "name": "limit", - "in": "query", - "x-ms-summary": "Limit", - "description": "The limit.", - "required": false, - "type": "integer" - } - ] - }, - "post": { - "responses": { - "200": { - "description": "default", - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean", - "description": "Whether a success.", - "title": "Success" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "The status.", - "title": "Status" - }, - "id": { - "type": "string", - "description": "The identifier.", - "title": "ID" - }, - "key": { - "type": "string", - "description": "The key.", - "title": "Key" - }, - "path": { - "type": "string", - "description": "The path.", - "title": "Path" - }, - "nodeType": { - "type": "string", - "description": "The node type.", - "title": "Node Type" - }, - "name": { - "type": "string", - "description": "The name.", - "title": "Name" - }, - "title": { - "type": "string", - "description": "The title.", - "title": "Title" - }, - "description": { - "type": "string", - "description": "The description.", - "title": "Description" - }, - "link": { - "type": "string", - "description": "The link.", - "title": "Link" - }, - "private": { - "type": "boolean", - "description": "Whether private.", - "title": "Private" - }, - "expires": { - "type": "string", - "description": "When expires.", - "title": "Expires" - }, - "downloads": { - "type": "integer", - "format": "int32", - "description": "The number of downloads.", - "title": "Downloads" - }, - "maxDownloads": { - "type": "integer", - "format": "int32", - "description": "The maximum number of downloads.", - "title": "Max Downloads" - }, - "autoDelete": { - "type": "boolean", - "description": "Whether automatically deletes.", - "title": "Auto Delete" - }, - "size": { - "type": "integer", - "format": "int32", - "description": "The size.", - "title": "Size" - }, - "mimeType": { - "type": "string", - "description": "The MIME type.", - "title": "MIME Type" - }, - "screeningStatus": { - "type": "string", - "description": "The screening status.", - "title": "Screening Status" - }, - "created": { - "type": "string", - "description": "When created.", - "title": "Created" - }, - "modified": { - "type": "string", - "description": "When modified.", - "title": "Modified" - } - } - } - } - }, - "summary": "Upload a file", - "description": "Uploads a file and creates the file details.", - "operationId": "FileUpload", - "parameters": [ - { - "name": "body", - "in": "body", - "required": false, - "schema": { - "type": "object", - "properties": { - "file": { - "type": "string", - "description": "The file.", - "title": "File" - }, - "expires": { - "type": "string", - "description": "When expires.", - "title": "Expires" - }, - "maxDownloads": { - "type": "integer", - "format": "int32", - "description": "The maximum number of downloads.", - "title": "Max Downloads" - }, - "autoDelete": { - "type": "boolean", - "description": "Whether automatically deletes.", - "title": "Auto Delete" - } - } - } - } - ] - } - }, - "/{key}": { - "patch": { - "responses": { - "200": { - "description": "default", - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean", - "description": "Whether a success.", - "title": "Success" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "The status.", - "title": "Status" - }, - "id": { - "type": "string", - "description": "The identifier.", - "title": "ID" - }, - "key": { - "type": "string", - "description": "The key.", - "title": "Key" - }, - "name": { - "type": "string", - "description": "The name.", - "title": "Name" - }, - "link": { - "type": "string", - "description": "The link.", - "title": "Link" - }, - "expires": { - "type": "string", - "description": "When expires.", - "title": "Expires" - }, - "expiry": { - "type": "string", - "description": "The .", - "title": "Expiry" - }, - "downloads": { - "type": "integer", - "format": "int32", - "description": "The number of downloads.", - "title": "Downloads" - }, - "maxDownloads": { - "type": "integer", - "format": "int32", - "description": "The maximum number of downloads.", - "title": "Max Downloads" - }, - "autoDelete": { - "type": "boolean", - "description": "Whether automatically deletes.", - "title": "Auto Delete" - }, - "size": { - "type": "integer", - "format": "int32", - "description": "The size.", - "title": "Size" - }, - "mimeType": { - "type": "string", - "description": "The MIME type.", - "title": "MIME Type" - }, - "created": { - "type": "string", - "description": "When created.", - "title": "Created" - }, - "modified": { - "type": "string", - "description": "When modified.", - "title": "Modified" - } - } - } - } - }, - "summary": "Update a file", - "description": "Updates a file by key. For any parameters not provided in request, existing values are retained.", - "operationId": "FileUpdate", - "parameters": [ - { - "name": "key", - "in": "path", - "x-ms-summary": "Key", - "x-ms-url-encoding": "single", - "description": "The file key.", - "required": true, - "type": "string" - }, - { - "name": "body", - "in": "body", - "required": false, - "schema": { - "type": "object", - "properties": { - "file": { - "type": "string", - "description": "The file.", - "title": "File" - }, - "expires": { - "type": "string", - "description": "When expires.", - "title": "Expires" - }, - "maxDownloads": { - "type": "integer", - "format": "int32", - "description": "The maximum number of downloads.", - "title": "Max Downloads" - }, - "autoDelete": { - "type": "boolean", - "description": "Whether automatically deletes.", - "title": "Auto Delete" - } - } - } - } - ] - }, - "delete": { - "responses": { - "200": { - "description": "default", - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean", - "description": "Whether a success.", - "title": "Success" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "The status.", - "title": "Status" - } - } - } - } - }, - "summary": "Delete a file", - "description": "Deletes a file identified by key", - "operationId": "FileDelete", - "parameters": [ - { - "name": "key", - "in": "path", - "x-ms-summary": "Key", - "x-ms-url-encoding": "single", - "description": "The file key.", - "required": true, - "type": "string" - } - ] - } - }, - "/me": { - "get": { - "responses": { - "200": { - "description": "default", - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean", - "description": "Whether a success.", - "title": "Success" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "The status.", - "title": "Status" - }, - "planId": { - "type": "integer", - "format": "int32", - "description": "The .", - "title": "Plan Id" - }, - "maxUploadBytes": { - "type": "integer", - "format": "int32", - "description": "The .", - "title": "Max Upload Bytes" - }, - "maxStorageBytes": { - "type": "integer", - "format": "int32", - "description": "The .", - "title": "Max Storage Bytes" - }, - "usedStorageBytes": { - "type": "integer", - "format": "int32", - "description": "The .", - "title": "Used Storage Bytes" - }, - "rateLimit": { - "type": "integer", - "format": "int32", - "description": "The .", - "title": "Rate Limit" - }, - "customDomain": { - "type": "string", - "description": "The .", - "title": "Custom Domain" - }, - "directDownload": { - "type": "string", - "description": "The .", - "title": "Direct Download" - }, - "paymentCustomerId": { - "type": "string", - "description": "The .", - "title": "Payment Customer Id" - }, - "paymentSubscriptionId": { - "type": "string", - "description": "The .", - "title": "Payment Subscription Id" - } - } - } - } - }, - "summary": "Get plan and account", - "description": "Retrieves the plan and account details for the user.", - "operationId": "Me", - "parameters": [] - } - } - }, - "definitions": {}, - "parameters": {}, - "responses": {}, - "securityDefinitions": { - "API Key": { - "type": "apiKey", - "in": "header", - "name": "Authorization" - } - }, - "security": [ - { - "API Key": [] - } - ], - "tags": [], - "x-ms-connector-metadata": [ - { - "propertyName": "Website", - "propertyValue": "https://www.file.io/" - }, - { - "propertyName": "Privacy policy", - "propertyValue": "https://www.file.io/privacy" - }, - { - "propertyName": "Categories", - "propertyValue": "Data" - } - ] -} \ No newline at end of file diff --git a/independent-publisher-connectors/FileIO/apiProperties.json b/independent-publisher-connectors/FileIO/apiProperties.json deleted file mode 100644 index dc00964f3c..0000000000 --- a/independent-publisher-connectors/FileIO/apiProperties.json +++ /dev/null @@ -1,23 +0,0 @@ -{ - "properties": { - "connectionParameters": { - "api_key": { - "type": "securestring", - "uiDefinition": { - "displayName": "API Key (in the form Bearer API_Key)", - "description": "The API Key (in the form Bearer API_Key) for this api", - "tooltip": "Provide your API Key (in the form Bearer API_Key)", - "constraints": { - "tabIndex": 2, - "clearText": false, - "required": "true" - } - } - } - }, - "iconBrandColor": "#da3b01", - "capabilities": [], - "publisher": "Troy Taylor", - "stackOwner": "Mr. Cowboy LLC" - } -} \ No newline at end of file diff --git a/independent-publisher-connectors/FileIO/readme.md b/independent-publisher-connectors/FileIO/readme.md deleted file mode 100644 index 70460ddc63..0000000000 --- a/independent-publisher-connectors/FileIO/readme.md +++ /dev/null @@ -1,25 +0,0 @@ -# File.io -Simply upload a file, share the link, and after it is downloaded, the file is completely deleted. For added security, set an expiration on the file and it is deleted within a certain amount of time, even if it was never downloaded. - -## Publisher: Troy Taylor, Hitachi Solutions - -## Prerequisites -You must sign up for an account with [file.io](https://www.file.io/signup). - -## Obtaining Credentials -In your account settings, find the API Keys tab and create a new API key. - -## Supported Operations -### Get list of files -Retrieves a list of your files. -### Upload a file -Uploads a file and creates the file details. -### Update a file -Updates a file by key. For any parameters not provided in request, existing values are retained. -### Delete a file -Deletes a file identified by key -### Get plan and account -Retrieves the plan and account details for the user. - -## Known Issues and Limitations -There are no known issues at this time. From 0010c10426c987a49ab881c7e698ba22e7cc582e Mon Sep 17 00:00:00 2001 From: Troy Taylor <44444967+troystaylor@users.noreply.github.com> Date: Tue, 20 Sep 2022 16:02:41 -0400 Subject: [PATCH 09/21] Add files via upload --- .../Owlbot/apiDefinition.swagger.json | 120 ++++++++++++++++++ .../Owlbot/apiProperties.json | 23 ++++ .../Owlbot/readme.md | 17 +++ 3 files changed, 160 insertions(+) create mode 100644 independent-publisher-connectors/Owlbot/apiDefinition.swagger.json create mode 100644 independent-publisher-connectors/Owlbot/apiProperties.json create mode 100644 independent-publisher-connectors/Owlbot/readme.md diff --git a/independent-publisher-connectors/Owlbot/apiDefinition.swagger.json b/independent-publisher-connectors/Owlbot/apiDefinition.swagger.json new file mode 100644 index 0000000000..ca3ba79583 --- /dev/null +++ b/independent-publisher-connectors/Owlbot/apiDefinition.swagger.json @@ -0,0 +1,120 @@ +{ + "swagger": "2.0", + "info": { + "title": "Owlbot", + "description": "Owlbot searches the internet to index information and making them accessible. Currently, it offers an English dictionary.", + "version": "1.0", + "contact": { + "name": "Troy Taylor", + "url": "https://www.hitachisolutions.com", + "email": "ttaylor@hitachisolutions.com" + } + }, + "host": "owlbot.info", + "basePath": "/api/v4/dictionary/", + "schemes": [ + "https" + ], + "consumes": [], + "produces": [], + "paths": { + "/{word}": { + "get": { + "responses": { + "200": { + "description": "default", + "schema": { + "type": "object", + "properties": { + "word": { + "type": "string", + "description": "The word.", + "title": "word" + }, + "pronunciation": { + "type": "string", + "description": "The pronunciation.", + "title": "pronunciation" + }, + "definitions": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type.", + "title": "type" + }, + "definition": { + "type": "string", + "description": "The definition.", + "title": "definition" + }, + "example": { + "type": "string", + "description": "The example.", + "title": "example" + }, + "image_url": { + "type": "string", + "description": "The image URL address.", + "title": "image_url" + }, + "emoji": { + "type": "string", + "description": "The emoji.", + "title": "emoji" + } + } + }, + "title": "definitions" + } + } + } + } + }, + "summary": "Get a definition", + "description": "Retrieves the definition of a word, as well as pronunciation, picture, example sentence, and emoji if available.", + "operationId": "Def", + "parameters": [ + { + "name": "word", + "in": "path", + "x-ms-summary": "Word", + "x-ms-url-encoding": "single", + "description": "The word to define.", + "required": true, + "type": "string" + } + ] + } + } + }, + "definitions": {}, + "parameters": {}, + "responses": {}, + "securityDefinitions": { + "api_key": { + "type": "apiKey", + "in": "header", + "name": "Authorization" + } + }, + "security": [], + "tags": [], + "x-ms-connector-metadata": [ + { + "propertyName": "Website", + "propertyValue": "https://owlbot.info/" + }, + { + "propertyName": "Privacy policy", + "propertyValue": "https://owlbot.info/" + }, + { + "propertyName": "Categories", + "propertyValue": "Data" + } + ] +} \ No newline at end of file diff --git a/independent-publisher-connectors/Owlbot/apiProperties.json b/independent-publisher-connectors/Owlbot/apiProperties.json new file mode 100644 index 0000000000..8061d3fc6e --- /dev/null +++ b/independent-publisher-connectors/Owlbot/apiProperties.json @@ -0,0 +1,23 @@ +{ + "properties": { + "connectionParameters": { + "api_key": { + "type": "securestring", + "uiDefinition": { + "displayName": "API Token (in the format 'Token Your_Token')", + "description": "The API Token (in the format 'Token Your_Token') for this api", + "tooltip": "Provide your API Token (in the format 'Token Your_Token')", + "constraints": { + "tabIndex": 2, + "clearText": false, + "required": "true" + } + } + } + }, + "iconBrandColor": "#da3b01", + "capabilities": [], + "publisher": "Troy Taylor", + "stackOwner": "Owlbot" + } +} \ No newline at end of file diff --git a/independent-publisher-connectors/Owlbot/readme.md b/independent-publisher-connectors/Owlbot/readme.md new file mode 100644 index 0000000000..24963a0598 --- /dev/null +++ b/independent-publisher-connectors/Owlbot/readme.md @@ -0,0 +1,17 @@ +# Owlbot +Owlbot searches the internet to index information and making them accessible. Currently, it offers an English dictionary. + +## Publisher: Troy Taylor, Hitachi Solutions + +## Prerequisites +There are no prerequisites to use this service. + +## Obtaining Credentials +You will need to request an API token on the [Owlbot website](https://owlbot.info/). + +## Supported Operations +### Get a definition +Retrieves the definition of a word, as well as pronunciation, picture, example sentence, and emoji if available. + +## Known Issues and Limitations +There are no known issues at this time. From 06370dbbf9c4260f5d0ea6c647a01797ec70c523 Mon Sep 17 00:00:00 2001 From: Troy Taylor <44444967+troystaylor@users.noreply.github.com> Date: Mon, 10 Oct 2022 14:11:49 -0400 Subject: [PATCH 10/21] Add files via upload --- .../Tree-Nation/apiDefinition.swagger.json | 1042 +++++++++++++++++ .../Tree-Nation/apiProperties.json | 23 + .../Tree-Nation/readme.md | 39 + 3 files changed, 1104 insertions(+) create mode 100644 independent-publisher-connectors/Tree-Nation/apiDefinition.swagger.json create mode 100644 independent-publisher-connectors/Tree-Nation/apiProperties.json create mode 100644 independent-publisher-connectors/Tree-Nation/readme.md diff --git a/independent-publisher-connectors/Tree-Nation/apiDefinition.swagger.json b/independent-publisher-connectors/Tree-Nation/apiDefinition.swagger.json new file mode 100644 index 0000000000..beaea454c2 --- /dev/null +++ b/independent-publisher-connectors/Tree-Nation/apiDefinition.swagger.json @@ -0,0 +1,1042 @@ +{ + "swagger": "2.0", + "info": { + "version": "1.0", + "title": "Tree-Nation", + "description": "The simplest way for citizens and companies to plant trees around the world and offset their CO2 emissions. Tree-Nation is on a mission to plant 1 trillion trees by 2050.", + "contact": { + "name": "Troy Taylor", + "url": "https://www.hitachisolutions.com", + "email": "ttaylor@hitachisolutions.com" + } + }, + "host": "tree-nation.com", + "basePath": "/", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/api/projects": { + "get": { + "summary": "Project list", + "description": "Retrieve all projects. If the parameter status=active is passed, only active projects (those where a tree can be planted) will be listed.", + "operationId": "ProjectList", + "parameters": [ + { + "name": "status", + "default": "active", + "in": "query", + "x-ms-summary": "Status", + "description": "The status.", + "type": "string", + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32", + "description": "The identifier.", + "title": "ID" + }, + "name": { + "type": "string", + "description": "The name.", + "title": "Name" + }, + "description": { + "type": "string", + "description": "The description.", + "title": "Description" + }, + "slug": { + "type": "string", + "description": "The slug.", + "title": "Slug" + }, + "location": { + "type": "string", + "description": "The location.", + "title": "Location" + }, + "lat": { + "type": "number", + "format": "float", + "description": "The latitude.", + "title": "Latitude" + }, + "long": { + "type": "number", + "format": "float", + "description": "The longitude.", + "title": "Longitude" + }, + "status": { + "type": "string", + "description": "The status.", + "title": "Status" + }, + "url": { + "type": "string", + "description": "The URL address.", + "title": "URL" + }, + "species_price_from": { + "type": "number", + "format": "float", + "description": "The species price from.", + "title": "Species Price From" + } + } + } + } + } + } + } + }, + "/api/projects/{project_id}": { + "get": { + "summary": "Project details", + "description": "Retrieve the details about a project.", + "operationId": "ProjectDetails", + "parameters": [ + { + "name": "project_id", + "in": "path", + "x-ms-summary": "Project ID", + "x-ms-url-encoding": "single", + "description": "The project identifier.", + "type": "string", + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "schema": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32", + "description": "The identifier.", + "title": "ID" + }, + "name": { + "type": "string", + "description": "The name.", + "title": "Name" + }, + "description": { + "type": "string", + "description": "The description.", + "title": "Description" + }, + "image": { + "type": "string", + "description": "The image.", + "title": "Image" + }, + "slug": { + "type": "string", + "description": "The slug.", + "title": "Slug" + }, + "location": { + "type": "string", + "description": "The location.", + "title": "Location" + }, + "lat": { + "type": "number", + "format": "float", + "description": "The latitude.", + "title": "Latitude" + }, + "long": { + "type": "number", + "format": "float", + "description": "The longitude.", + "title": "Longitude" + }, + "status": { + "type": "string", + "description": "The status.", + "title": "Status" + }, + "url": { + "type": "string", + "description": "The URL address.", + "title": "URL" + }, + "species_price_from": { + "type": "number", + "format": "float", + "description": "The species price from.", + "title": "Species Price From" + } + } + } + } + } + } + }, + "/api/projects/{project_id}/planting-sites": { + "get": { + "summary": "Sites list", + "description": "Retrieve the available planting sites in a project.", + "operationId": "SitesList", + "parameters": [ + { + "name": "project_id", + "in": "path", + "x-ms-summary": "Project ID", + "x-ms-url-encoding": "single", + "description": "The project identifier.", + "type": "string", + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "address": { + "type": "string", + "description": "The address.", + "title": "Address" + }, + "created_at": { + "type": "string", + "description": "When created at.", + "title": "Created At" + }, + "description": { + "type": "string", + "description": "The description.", + "title": "Description" + }, + "id": { + "type": "integer", + "format": "int32", + "description": "The identifier.", + "title": "ID" + }, + "image": { + "type": "string", + "description": "The image.", + "title": "Image" + }, + "name": { + "type": "string", + "description": "The name.", + "title": "Name" + }, + "polygon_data": { + "type": "string", + "description": "The polygon data.", + "title": "Polygon Data" + }, + "project_id": { + "type": "integer", + "format": "int32", + "description": "The project identifier.", + "title": "Project ID" + }, + "slug": { + "type": "string", + "description": "The slug.", + "title": "Slug" + } + } + } + } + } + } + } + }, + "/api/projects/{project_id}/species": { + "get": { + "summary": "Species list", + "description": "Retrieve the available species in a project. Only those species with stock > 0 can be used for planting.", + "operationId": "SpeciesList", + "parameters": [ + { + "name": "project_id", + "in": "path", + "x-ms-summary": "Project ID", + "x-ms-url-encoding": "single", + "description": "The project identifier.", + "type": "string", + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32", + "description": "The identifier.", + "title": "ID" + }, + "project_id": { + "type": "integer", + "format": "int32", + "description": "The project identifier.", + "title": "Project ID" + }, + "name": { + "type": "string", + "description": "The name.", + "title": "Name" + }, + "life_time_CO2": { + "type": "integer", + "format": "int32", + "description": "The lifetime CO2.", + "title": "Lifetime CO2" + }, + "price": { + "type": "integer", + "format": "int32", + "description": "The price.", + "title": "Price" + }, + "stock": { + "type": "integer", + "format": "int32", + "description": "The stock.", + "title": "Stock" + } + } + } + } + } + } + } + }, + "/api/species/{species_id}": { + "get": { + "summary": "Species details", + "description": "Retrieve the details about a species.", + "operationId": "SpeciesDetails", + "parameters": [ + { + "name": "species_id", + "in": "path", + "x-ms-summary": "Species ID", + "x-ms-url-encoding": "single", + "description": "The species identifier.", + "type": "string", + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "schema": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32", + "description": "The identifier.", + "title": "ID" + }, + "project_id": { + "type": "integer", + "format": "int32", + "description": "The project ID.", + "title": "Project ID" + }, + "name": { + "type": "string", + "description": "The name.", + "title": "Name" + }, + "life_time_CO2": { + "type": "integer", + "format": "int32", + "description": "The lifetime CO2.", + "title": "Lifetime CO2" + }, + "price": { + "type": "integer", + "format": "int32", + "description": "The price.", + "title": "Price" + }, + "common_names": { + "type": "string", + "description": "The common name.", + "title": "Common Names" + }, + "image": { + "type": "string", + "description": "The image.", + "title": "Image" + }, + "family": { + "type": "string", + "description": "The family.", + "title": "Family" + }, + "particularities": { + "type": "string", + "description": "The particularities.", + "title": "Particularities" + }, + "planter_likes": { + "type": "string", + "description": "The planter likes.", + "title": "Planter Likes" + }, + "height": { + "type": "string", + "description": "The height.", + "title": "Height" + }, + "average_natural_life_span": { + "type": "integer", + "format": "int32", + "description": "The average natural life span.", + "title": "Average Natural Life Span" + }, + "co2_offset": { + "type": "integer", + "format": "int32", + "description": "The CO2 offset.", + "title": "CO2 Offset" + }, + "co2_offset_period": { + "type": "string", + "description": "The CO2 offset period.", + "title": "CO2 Offset Period" + }, + "stock": { + "type": "integer", + "format": "int32", + "description": "The stock.", + "title": "Stock" + }, + "category": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32", + "description": "The identifier.", + "title": "ID" + }, + "name": { + "type": "string", + "description": "The name.", + "title": "Name" + } + }, + "title": "Category" + }, + "foliage": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32", + "description": "The identifier.", + "title": "ID" + }, + "name": { + "type": "string", + "description": "The name.", + "title": "Name" + } + }, + "title": "Foliage" + }, + "origin_type": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32", + "description": "The identifier.", + "title": "ID" + }, + "name": { + "type": "string", + "description": "The name.", + "title": "Name" + } + }, + "title": "Origin Type" + } + } + } + } + } + } + }, + "/api/forests/{user_id}": { + "get": { + "summary": "Forest details", + "description": "Retrieve a user forest details", + "operationId": "ForestDetails", + "parameters": [ + { + "name": "user_id", + "in": "path", + "x-ms-summary": "User ID", + "x-ms-url-encoding": "single", + "description": "The user identifier.", + "type": "string", + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "schema": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32", + "description": "The identifier.", + "title": "ID" + }, + "co2_compensated": { + "type": "number", + "format": "float", + "description": "The CO2 compensated.", + "title": "CO2 Compensated" + }, + "tree_count": { + "type": "string", + "description": "The tree count.", + "title": "Tree Count" + } + } + } + } + } + } + }, + "/api/forests/{user_slug}/tree_counter/{period}": { + "get": { + "summary": "Forest tree count", + "description": "Retrieve a user forest tree count (by slug). Period is optional and can be one of: day, week, month, quarter, year. If period is not passed, the all time value will be returned.", + "operationId": "ForestTreeCount", + "parameters": [ + { + "name": "user_slug", + "in": "path", + "x-ms-summary": "user slug", + "x-ms-url-encoding": "single", + "description": "The user slug.", + "type": "string", + "required": true + }, + { + "name": "period", + "in": "path", + "x-ms-summary": "Period", + "x-ms-url-encoding": "single", + "description": "The period.", + "type": "string", + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "schema": { + "type": "object", + "properties": { + "count": { + "type": "integer", + "format": "int32", + "description": "The count.", + "title": "Count" + } + } + } + } + } + } + }, + "/api/plant": { + "post": { + "summary": "Plant", + "description": "Plant a tree.", + "operationId": "Plant", + "parameters": [ + { + "name": "body", + "in": "body", + "schema": { + "type": "object", + "properties": { + "recipients": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name.", + "title": "Name" + }, + "email": { + "type": "string", + "description": "The email address.", + "title": "Email" + } + } + }, + "title": "Recipients" + }, + "planter_id": { + "type": "integer", + "format": "int32", + "description": "The planter identifier.", + "title": "Planter ID" + }, + "species_id": { + "type": "integer", + "format": "int32", + "description": "The species identifier.", + "title": "Species ID" + }, + "quantity": { + "type": "integer", + "format": "int32", + "description": "The quantity.", + "title": "Quantity" + }, + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + } + } + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "schema": { + "type": "object", + "properties": { + "status": { + "type": "string", + "description": "The status.", + "title": "Status" + }, + "trees": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32", + "description": "The identifier.", + "title": "ID" + }, + "token": { + "type": "string", + "description": "The token.", + "title": "Token" + }, + "collect_url": { + "type": "string", + "description": "The collection URL address.", + "title": "Collect URL" + }, + "certificate_url": { + "type": "string", + "description": "The certificate URL address.", + "title": "Certificate URL" + } + } + }, + "title": "Trees" + }, + "payment_id": { + "type": "integer", + "format": "int32", + "description": "The payment identifier.", + "title": "Payment ID" + } + } + } + } + } + } + }, + "/api/user/b2b": { + "put": { + "summary": "Create user", + "description": "Create a new user.", + "operationId": "CreateUser", + "parameters": [ + { + "name": "body", + "in": "body", + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name.", + "title": "Name" + }, + "email": { + "type": "string", + "description": "The email address.", + "title": "Email" + }, + "language": { + "type": "string", + "description": "The language.", + "title": "Language" + }, + "password": { + "type": "string", + "description": "The password.", + "title": "Password" + }, + "responsible_name": { + "type": "string", + "description": "The responsible name.", + "title": "Responsible Name" + }, + "organization_website": { + "type": "string", + "description": "The organization website.", + "title": "Organization Website" + } + } + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "schema": { + "type": "object", + "properties": { + "status": { + "type": "string", + "description": "The status.", + "title": "Status" + }, + "user_id": { + "type": "integer", + "format": "int32", + "description": "The user identifier.", + "title": "User ID" + }, + "password": { + "type": "string", + "description": "The password.", + "title": "Password" + }, + "slug": { + "type": "string", + "description": "The slug.", + "title": "Slug" + }, + "forest_url": { + "type": "string", + "description": "The forest URL address.", + "title": "Forest URL" + } + } + } + } + } + } + }, + "/api/tree_templates/{planter_id}": { + "get": { + "summary": "Tree template details", + "description": "Retrieve the details about the tree template of a planter.", + "operationId": "TreeTemplateDetails", + "parameters": [ + { + "name": "planter_id", + "in": "path", + "x-ms-summary": "Planter ID", + "x-ms-url-encoding": "single", + "description": "The planter identifier.", + "type": "string", + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "schema": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32", + "description": "The identifier.", + "title": "ID" + }, + "planter_id": { + "type": "integer", + "format": "int32", + "description": "The planter identifier.", + "title": "Planter ID" + }, + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "image": { + "type": "string", + "description": "The image.", + "title": "Image" + }, + "video": { + "type": "string", + "description": "The video.", + "title": "Video" + }, + "species_id": { + "type": "integer", + "format": "int32", + "description": "The species identifier.", + "title": "Species ID" + }, + "package_quantity": { + "type": "integer", + "format": "int32", + "description": "The package quantity.", + "title": "Package Quantity" + }, + "price_per_tree": { + "type": "integer", + "format": "int32", + "description": "The price per tree.", + "title": "Price Per Tree" + }, + "total_price": { + "type": "integer", + "format": "int32", + "description": "The total price.", + "title": "Total Price" + } + } + } + } + } + }, + "post": { + "summary": "Update tree template", + "description": "Modify the message of a tree template.", + "operationId": "UpdateTreeTemplate", + "parameters": [ + { + "name": "planter_id", + "in": "path", + "x-ms-summary": "Planter ID", + "x-ms-url-encoding": "single", + "description": "The planter identifier.", + "type": "string", + "required": true + }, + { + "name": "body", + "in": "body", + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + } + } + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "schema": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32", + "description": "The identifier.", + "title": "ID" + }, + "planter_id": { + "type": "integer", + "format": "int32", + "description": "The planter identifier.", + "title": "Planter ID" + }, + "video": { + "type": "string", + "description": "The video.", + "title": "Video" + }, + "species_id": { + "type": "integer", + "format": "int32", + "description": "The species identifier.", + "title": "Species ID" + }, + "package_quantity": { + "type": "integer", + "format": "int32", + "description": "The package quantity.", + "title": "Package Quantity" + }, + "price_per_tree": { + "type": "integer", + "format": "int32", + "description": "The price per tree.", + "title": "Price Per Tree" + }, + "total_price": { + "type": "integer", + "format": "int32", + "description": "The total price.", + "title": "Total Price" + }, + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "image": { + "type": "string", + "description": "The image.", + "title": "Image" + } + } + } + } + } + } + }, + "/api/credit": { + "post": { + "summary": "Buy credit", + "description": "Buy credit.", + "operationId": "BuyCredit", + "parameters": [ + { + "name": "body", + "in": "body", + "schema": { + "type": "object", + "properties": { + "planter_id": { + "type": "integer", + "format": "int32", + "description": "The planter identifier.", + "title": "Planter ID" + }, + "amount": { + "type": "integer", + "format": "int32", + "description": "The amount.", + "title": "Amount" + } + } + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "schema": { + "type": "object", + "properties": { + "status": { + "type": "string", + "description": "The status.", + "title": "Status" + }, + "payment_id": { + "type": "integer", + "format": "int32", + "description": "The payment identifier.", + "title": "Payment ID" + } + } + } + } + } + } + } + }, + "definitions": {}, + "parameters": {}, + "responses": {}, + "securityDefinitions": { + "API Key": { + "type": "apiKey", + "in": "header", + "name": "Authorization" + } + }, + "security": [ + { + "API Key": [] + } + ], + "tags": [], + "x-ms-connector-metadata": [ + { + "propertyName": "Website", + "propertyValue": "https://tree-nation.com/" + }, + { + "propertyName": "Privacy policy", + "propertyValue": "https://tree-nation.com/legal/privacy-policy" + }, + { + "propertyName": "Categories", + "propertyValue": "Lifestyle and Entertainment" + } + ] + +} \ No newline at end of file diff --git a/independent-publisher-connectors/Tree-Nation/apiProperties.json b/independent-publisher-connectors/Tree-Nation/apiProperties.json new file mode 100644 index 0000000000..45a7a3a182 --- /dev/null +++ b/independent-publisher-connectors/Tree-Nation/apiProperties.json @@ -0,0 +1,23 @@ +{ + "properties": { + "connectionParameters": { + "api_key": { + "type": "securestring", + "uiDefinition": { + "displayName": "API Key (in the form 'Bearer API_Token')", + "description": "The API Key (in the form 'Bearer API_Token') for this api", + "tooltip": "Provide your API Key (in the form 'Bearer API_Token')", + "constraints": { + "tabIndex": 2, + "clearText": false, + "required": "true" + } + } + } + }, + "iconBrandColor": "#da3b01", + "capabilities": [], + "publisher": "Troy Taylor", + "stackOwner": "Tree-Nation" + } +} \ No newline at end of file diff --git a/independent-publisher-connectors/Tree-Nation/readme.md b/independent-publisher-connectors/Tree-Nation/readme.md new file mode 100644 index 0000000000..08a23ec3dc --- /dev/null +++ b/independent-publisher-connectors/Tree-Nation/readme.md @@ -0,0 +1,39 @@ +# Tree-Nation +The simplest way for citizens and companies to plant trees around the world and offset their CO2 emissions. Tree-Nation is on a mission to plant 1 trillion trees by 2050. + +## Publisher: Troy Taylor, Hitachi Solutions + +## Prerequisites +You will need to create an account with [Tree-Nation](https://tree-nation.com/) and request access to the API. + +## Obtaining Credentials +Tree-Nation will email you an API token to use when your API access has been approved. + +## Supported Operations +### Project list +If the parameter status=active is passed, only active projects (those where a tree can be planted) will be listed. +### Project details +Retrieve the details about a project. +### Sites list +Retrieve the available planting sites in a project. +### Species list +Retrieve the available species in a project. Only those species with stock > 0 can be used for planting. +### Species details +Retrieve the details about a species. +### Forest details +Retrieve a user forest details. +### Forest tree count +Retrieve a user forest tree count (by slug). Period is optional and can be one of: day, week, month, quarter, year. If period is not passed, the all time value will be returned. +### Plant +Plant a tree. +### Create user +Create a new user. +### Tree template details +Retrieve the details about the tree template of a planter. +### Update tree template +Modify the message of a tree template. +### Buy credit +Buy credit. + +## Known Issues and Limitations +There are no known issues at this time. From d18fd3576afe77a091f3e205a8025bd83fb179c2 Mon Sep 17 00:00:00 2001 From: Troy Taylor <44444967+troystaylor@users.noreply.github.com> Date: Wed, 30 Nov 2022 15:33:06 -0500 Subject: [PATCH 11/21] Add files via upload --- .../apiDefinition.swagger.json | 417 ++++++++++++++++++ .../Today in History/apiProperties.json | 9 + .../Today in History/readme.md | 19 + 3 files changed, 445 insertions(+) create mode 100644 independent-publisher-connectors/Today in History/apiDefinition.swagger.json create mode 100644 independent-publisher-connectors/Today in History/apiProperties.json create mode 100644 independent-publisher-connectors/Today in History/readme.md diff --git a/independent-publisher-connectors/Today in History/apiDefinition.swagger.json b/independent-publisher-connectors/Today in History/apiDefinition.swagger.json new file mode 100644 index 0000000000..244dad5eb9 --- /dev/null +++ b/independent-publisher-connectors/Today in History/apiDefinition.swagger.json @@ -0,0 +1,417 @@ +{ + "swagger": "2.0", + "info": { + "title": "Today in History", + "description": "Today in History retrieves some basic historical information for any given day. All date entries are parsed from Wikipedia.", + "version": "1.0", + "contact": { + "name": "Troy Taylor", + "url": "https://www.hitachisolutions.com", + "email": "ttaylor@hitachisolutions.com" + } + }, + "host": "history.muffinlabs.com", + "basePath": "/", + "schemes": [ + "https" + ], + "consumes": [], + "produces": [], + "paths": { + "/date": { + "get": { + "responses": { + "200": { + "description": "default", + "schema": { + "type": "object", + "properties": { + "date": { + "type": "string", + "description": "The date.", + "title": "Date" + }, + "url": { + "type": "string", + "description": "The Wikipedia URL address.", + "title": "URL" + }, + "data": { + "type": "object", + "properties": { + "Events": { + "type": "array", + "items": { + "type": "object", + "properties": { + "year": { + "type": "string", + "description": "The year.", + "title": "Year" + }, + "text": { + "type": "string", + "description": "The event text.", + "title": "Text" + }, + "html": { + "type": "string", + "description": "The HTML.", + "title": "HTML" + }, + "no_year_html": { + "type": "string", + "description": "The no year HTML.", + "title": "No Year HTML" + }, + "links": { + "type": "array", + "items": { + "type": "object", + "properties": { + "title": { + "type": "string", + "description": "The title.", + "title": "Title" + }, + "link": { + "type": "string", + "description": "The link address.", + "title": "Link" + } + } + }, + "title": "Links" + } + } + }, + "title": "Events" + }, + "Births": { + "type": "array", + "items": { + "type": "object", + "properties": { + "year": { + "type": "string", + "description": "The year.", + "title": "Year" + }, + "text": { + "type": "string", + "description": "The event text.", + "title": "Text" + }, + "html": { + "type": "string", + "description": "The HTML.", + "title": "HTML" + }, + "no_year_html": { + "type": "string", + "description": "The no year HTML.", + "title": "No Year HTML" + }, + "links": { + "type": "array", + "items": { + "type": "object", + "properties": { + "title": { + "type": "string", + "description": "The title.", + "title": "Title" + }, + "link": { + "type": "string", + "description": "The link address.", + "title": "Link" + } + } + }, + "title": "Links" + } + } + }, + "title": "Births" + }, + "Deaths": { + "type": "array", + "items": { + "type": "object", + "properties": { + "year": { + "type": "string", + "description": "The year.", + "title": "Year" + }, + "text": { + "type": "string", + "description": "The event text.", + "title": "Text" + }, + "html": { + "type": "string", + "description": "The HTML.", + "title": "HTML" + }, + "no_year_html": { + "type": "string", + "description": "The no year HTML.", + "title": "No Year HTML" + }, + "links": { + "type": "array", + "items": { + "type": "object", + "properties": { + "title": { + "type": "string", + "description": "The title.", + "title": "Title" + }, + "link": { + "type": "string", + "description": "The link address.", + "title": "Link" + } + } + }, + "title": "Links" + } + } + }, + "title": "Deaths" + } + }, + "title": "Data" + } + } + } + } + }, + "summary": "Get events for today", + "description": "Retrieve a list of events that happened on this day in history.", + "operationId": "TodayGet", + "parameters": [] + } + }, + "/date/{month}/{day}": { + "get": { + "responses": { + "200": { + "description": "default", + "schema": { + "type": "object", + "properties": { + "date": { + "type": "string", + "description": "The date.", + "title": "Date" + }, + "url": { + "type": "string", + "description": "The Wikipedia URL address.", + "title": "URL" + }, + "data": { + "type": "object", + "properties": { + "Events": { + "type": "array", + "items": { + "type": "object", + "properties": { + "year": { + "type": "string", + "description": "The year.", + "title": "Year" + }, + "text": { + "type": "string", + "description": "The event text.", + "title": "Text" + }, + "html": { + "type": "string", + "description": "The HTML.", + "title": "HTML" + }, + "no_year_html": { + "type": "string", + "description": "The no year HTML.", + "title": "No Year HTML" + }, + "links": { + "type": "array", + "items": { + "type": "object", + "properties": { + "title": { + "type": "string", + "description": "The title.", + "title": "Title" + }, + "link": { + "type": "string", + "description": "The link address.", + "title": "Link" + } + } + }, + "title": "Links" + } + } + }, + "title": "Events" + }, + "Births": { + "type": "array", + "items": { + "type": "object", + "properties": { + "year": { + "type": "string", + "description": "The year.", + "title": "Year" + }, + "text": { + "type": "string", + "description": "The event text.", + "title": "Text" + }, + "html": { + "type": "string", + "description": "The HTML.", + "title": "HTML" + }, + "no_year_html": { + "type": "string", + "description": "The no year HTML.", + "title": "No Year HTML" + }, + "links": { + "type": "array", + "items": { + "type": "object", + "properties": { + "title": { + "type": "string", + "description": "The title.", + "title": "Title" + }, + "link": { + "type": "string", + "description": "The link address.", + "title": "Link" + } + } + }, + "title": "Links" + } + } + }, + "title": "Births" + }, + "Deaths": { + "type": "array", + "items": { + "type": "object", + "properties": { + "year": { + "type": "string", + "description": "The year.", + "title": "Year" + }, + "text": { + "type": "string", + "description": "The event text.", + "title": "Text" + }, + "html": { + "type": "string", + "description": "The HTML.", + "title": "HTML" + }, + "no_year_html": { + "type": "string", + "description": "The no year HTML.", + "title": "No Year HTML" + }, + "links": { + "type": "array", + "items": { + "type": "object", + "properties": { + "title": { + "type": "string", + "description": "The title.", + "title": "Title" + }, + "link": { + "type": "string", + "description": "The link address.", + "title": "Link" + } + } + }, + "title": "Links" + } + } + }, + "title": "Deaths" + } + }, + "title": "Data" + } + } + } + } + }, + "summary": "Get events for a different day", + "description": "Retrieve a list of events that happened on a specific day in history.", + "operationId": "DayGet", + "parameters": [ + { + "name": "month", + "in": "path", + "x-ms-url-encoding": "single", + "required": true, + "type": "string", + "description": "The month in M format.", + "x-ms-summary": "Month" + }, + { + "name": "day", + "in": "path", + "x-ms-url-encoding": "single", + "required": true, + "type": "string", + "description": "The day in the D format.", + "x-ms-summary": "Day" + } + ] + } + } + }, + "definitions": {}, + "parameters": {}, + "responses": {}, + "securityDefinitions": {}, + "security": [], + "tags": [], + "x-ms-connector-metadata": [ + { + "propertyName": "Website", + "propertyValue": "https://history.muffinlabs.com/" + }, + { + "propertyName": "Privacy policy", + "propertyValue": "https://history.muffinlabs.com/" + }, + { + "propertyName": "Categories", + "propertyValue": "Lifestyle and Entertainment" + } + ] +} \ No newline at end of file diff --git a/independent-publisher-connectors/Today in History/apiProperties.json b/independent-publisher-connectors/Today in History/apiProperties.json new file mode 100644 index 0000000000..20f47f46a4 --- /dev/null +++ b/independent-publisher-connectors/Today in History/apiProperties.json @@ -0,0 +1,9 @@ +{ + "properties": { + "connectionParameters": {}, + "iconBrandColor": "#da3b01", + "capabilities": [], + "publisher": "Troy Taylor", + "stackOwner": "muffinlabs" + } +} \ No newline at end of file diff --git a/independent-publisher-connectors/Today in History/readme.md b/independent-publisher-connectors/Today in History/readme.md new file mode 100644 index 0000000000..f70d7ed68a --- /dev/null +++ b/independent-publisher-connectors/Today in History/readme.md @@ -0,0 +1,19 @@ +# Today in History +Today in History retrieves some basic historical information for any given day. All date entries are parsed from Wikipedia. + +## Publisher: Troy Taylor, Hitachi Solutions + +## Prerequisites +There are no prerequisites to use this service. + +## Obtaining Credentials +There are no credentials needed to use this service. + +## Supported Operations +### Get events for today +Retrieve a list of events that happened on this day in history. +### Get events for a different day +Retrieve a list of events that happened on a specific day in history. + +## Known Issues and Limitations +There are no known issues at this time. From 1d855069580b1ee4670c7c8e3b2edec4e0d63cd5 Mon Sep 17 00:00:00 2001 From: Troy Taylor <44444967+troystaylor@users.noreply.github.com> Date: Fri, 28 Apr 2023 14:57:46 -0400 Subject: [PATCH 12/21] Add files via upload --- .../apiDefinition.swagger.json | 1115 +++++++++++++++++ .../MessageBird SMS/apiProperties.json | 23 + .../MessageBird SMS/readme.md | 23 + 3 files changed, 1161 insertions(+) create mode 100644 independent-publisher-connectors/MessageBird SMS/apiDefinition.swagger.json create mode 100644 independent-publisher-connectors/MessageBird SMS/apiProperties.json create mode 100644 independent-publisher-connectors/MessageBird SMS/readme.md diff --git a/independent-publisher-connectors/MessageBird SMS/apiDefinition.swagger.json b/independent-publisher-connectors/MessageBird SMS/apiDefinition.swagger.json new file mode 100644 index 0000000000..8604a24c20 --- /dev/null +++ b/independent-publisher-connectors/MessageBird SMS/apiDefinition.swagger.json @@ -0,0 +1,1115 @@ +{ + "swagger": "2.0", + "info": { + "title": "MessageBird SMS", + "description": "messagebird's SMS service allows you to send and receive SMS messages to and from any country in the world.", + "version": "1.0", + "contact": { + "name": "Troy Taylor", + "url": "https://www.hitachisolutions.com", + "email": "ttaylor@hitachisolutions.com" + } + }, + "host": "rest.messagebird.com", + "basePath": "/", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/messages": { + "get": { + "responses": { + "200": { + "description": "default", + "schema": { + "type": "object", + "properties": { + "offset": { + "type": "integer", + "format": "int32", + "description": "The offset.", + "title": "Offset" + }, + "limit": { + "type": "integer", + "format": "int32", + "description": "The limit.", + "title": "Limit" + }, + "count": { + "type": "integer", + "format": "int32", + "description": "The count.", + "title": "Count" + }, + "totalCount": { + "type": "integer", + "format": "int32", + "description": "The total count.", + "title": "Total Count" + }, + "links": { + "type": "object", + "properties": { + "first": { + "type": "string", + "description": "The first.", + "title": "First" + }, + "previous": { + "type": "string", + "description": "The previous.", + "title": "Previous" + }, + "next": { + "type": "string", + "description": "The next.", + "title": "Next" + }, + "last": { + "type": "string", + "description": "The last.", + "title": "Last" + } + }, + "title": "Links" + }, + "items": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "href": { + "type": "string", + "description": "The HREF.", + "title": "HREF" + }, + "direction": { + "type": "string", + "description": "The direction.", + "title": "Direction" + }, + "type": { + "type": "string", + "description": "The type.", + "title": "Type" + }, + "originator": { + "type": "string", + "description": "The originator.", + "title": "Originator" + }, + "body": { + "type": "string", + "description": "The body.", + "title": "Body" + }, + "reference": { + "type": "string", + "description": "The reference.", + "title": "Reference" + }, + "validity": { + "type": "string", + "description": "The validity.", + "title": "Validity" + }, + "gateway": { + "type": "integer", + "format": "int32", + "description": "The gateway.", + "title": "Gateway" + }, + "typeDetails": { + "type": "object", + "properties": {}, + "description": "The type details.", + "title": "Type Details" + }, + "datacoding": { + "type": "string", + "description": "The data coding.", + "title": "Data Coding" + }, + "mclass": { + "type": "integer", + "format": "int32", + "description": "The message class.", + "title": "Message Class" + }, + "scheduledDatetime": { + "type": "string", + "description": "The scheduled datetime.", + "title": "Scheduled Datetime" + }, + "createdDatetime": { + "type": "string", + "description": "When created datetime.", + "title": "Created Datetime" + }, + "recipients": { + "type": "object", + "properties": { + "totalCount": { + "type": "integer", + "format": "int32", + "description": "The total count.", + "title": "Total Count" + }, + "totalSentCount": { + "type": "integer", + "format": "int32", + "description": "The total sent count.", + "title": "Total Sent Count" + }, + "totalDeliveredCount": { + "type": "integer", + "format": "int32", + "description": "The total delivered count.", + "title": "Total Delivered Count" + }, + "totalDeliveryFailedCount": { + "type": "integer", + "format": "int32", + "description": "The total delivery failed count.", + "title": "Total Delivery Failed Count" + }, + "items": { + "type": "array", + "items": { + "type": "object", + "properties": { + "recipient": { + "type": "integer", + "format": "int32", + "description": "The recipient.", + "title": "Recipient" + }, + "originator": { + "type": "string", + "description": "The originator.", + "title": "Originator" + }, + "status": { + "type": "string", + "description": "The status.", + "title": "Status" + }, + "statusReason": { + "type": "string", + "description": "The status reason.", + "title": "Status Reason" + }, + "statusErrorCode": { + "type": "string", + "description": "The status error code.", + "title": "Status Error Code" + }, + "statusDatetime": { + "type": "string", + "description": "The status datetime.", + "title": "Status Datetime" + }, + "recipientCountry": { + "type": "string", + "description": "The recipient country.", + "title": "Recipient Country" + }, + "recipientCountryPrefix": { + "type": "integer", + "format": "int32", + "description": "The recipient country prefix.", + "title": "Recipient Country Prefix" + }, + "recipientOperator": { + "type": "string", + "description": "The recipient operator.", + "title": "Recipient Operator" + }, + "mccmnc": { + "type": "string", + "description": "The code of the operator of the message sender.", + "title": "MCCMNC" + }, + "mcc": { + "type": "string", + "description": "The MCC.", + "title": "MCC" + }, + "mnc": { + "type": "string", + "description": "The MNC.", + "title": "MNC" + }, + "messageLength": { + "type": "integer", + "format": "int32", + "description": "The message length.", + "title": "Message Length" + }, + "messagePartCount": { + "type": "integer", + "format": "int32", + "description": "The message part count.", + "title": "Message Part Count" + }, + "price": { + "type": "object", + "properties": { + "amount": { + "type": "number", + "format": "float", + "description": "The amount.", + "title": "Amount" + }, + "currency": { + "type": "string", + "description": "The currency.", + "title": "Currency" + } + }, + "title": "Price" + } + } + }, + "title": "Items" + } + }, + "title": "Recipients" + } + } + }, + "title": "Items" + } + } + } + } + }, + "summary": "List messages", + "description": "Retrieve a list of all inbound and outbound SMS messages.", + "operationId": "MessagesGet", + "parameters": [ + { + "name": "originator", + "in": "query", + "x-ms-summary": "Originator", + "description": "The originator.", + "required": false, + "type": "string" + }, + { + "name": "recipient", + "in": "query", + "x-ms-summary": "Recipient", + "description": "The recipient.", + "required": false, + "type": "string" + }, + { + "name": "direction", + "in": "query", + "x-ms-summary": "Direction", + "description": "The direction.", + "required": false, + "type": "string", + "default": "mt", + "enum": [ + "mt", + "mo" + ] + }, + { + "name": "limit", + "in": "query", + "x-ms-summary": "Limit", + "description": "The limit.", + "required": false, + "type": "string" + }, + { + "name": "offset", + "in": "query", + "x-ms-summary": "Offset", + "description": "The offset.", + "required": false, + "type": "integer" + }, + { + "name": "searchterm", + "in": "query", + "x-ms-summary": "Search terms", + "description": "The search terms.", + "required": false, + "type": "string" + }, + { + "name": "type", + "in": "query", + "x-ms-summary": "Type", + "description": "The type.", + "required": false, + "type": "string", + "default": "sms", + "enum": [ + "sms", + "binary", + "flash" + ] + }, + { + "name": "contact_id", + "in": "query", + "x-ms-summary": "Contact ID", + "description": "The contact identifier.", + "required": false, + "type": "integer" + }, + { + "name": "status", + "in": "query", + "x-ms-summary": "Status", + "description": "The status.", + "required": false, + "type": "string", + "default": "sent", + "enum": [ + "sent", + "scheduled", + "buffered", + "delivered", + "expired", + "delivery_failed" + ] + }, + { + "name": "from", + "in": "query", + "x-ms-summary": "From", + "description": "The from.", + "required": false, + "type": "string" + }, + { + "name": "until", + "in": "query", + "x-ms-summary": "Until", + "description": "The until.", + "required": false, + "type": "string" + } + ] + }, + "post": { + "responses": { + "200": { + "description": "default", + "schema": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "href": { + "type": "string", + "description": "The HREF.", + "title": "HREF" + }, + "direction": { + "type": "string", + "description": "The direction.", + "title": "Direction" + }, + "type": { + "type": "string", + "description": "The type.", + "title": "Type" + }, + "originator": { + "type": "string", + "description": "The originator.", + "title": "Originator" + }, + "body": { + "type": "string", + "description": "The message body.", + "title": "Body" + }, + "reference": { + "type": "string", + "description": "The reference.", + "title": "Reference" + }, + "validity": { + "type": "string", + "description": "The validity.", + "title": "Validity" + }, + "gateway": { + "type": "integer", + "format": "int32", + "description": "The gateway.", + "title": "Gateway" + }, + "typeDetails": { + "type": "object", + "properties": {}, + "description": "The type details.", + "title": "Type Details" + }, + "datacoding": { + "type": "string", + "description": "The data coding.", + "title": "Data Coding" + }, + "mclass": { + "type": "integer", + "format": "int32", + "description": "The message class.", + "title": "Message Class" + }, + "scheduledDatetime": { + "type": "string", + "description": "The scheduled datetime.", + "title": "Scheduled Datetime" + }, + "createdDatetime": { + "type": "string", + "description": "When created datetime.", + "title": "Created Datetime" + }, + "recipients": { + "type": "object", + "properties": { + "totalCount": { + "type": "integer", + "format": "int32", + "description": "The total count.", + "title": "Total Count" + }, + "totalSentCount": { + "type": "integer", + "format": "int32", + "description": "The total sent count.", + "title": "Total Sent Count" + }, + "totalDeliveredCount": { + "type": "integer", + "format": "int32", + "description": "The total delivered count.", + "title": "Total Delivered Count" + }, + "totalDeliveryFailedCount": { + "type": "integer", + "format": "int32", + "description": "The total delivery failed count.", + "title": "Total Delivery Failed Count" + }, + "items": { + "type": "array", + "items": { + "type": "object", + "properties": { + "recipient": { + "type": "integer", + "format": "int32", + "description": "The recipient.", + "title": "Recipient" + }, + "status": { + "type": "string", + "description": "The status.", + "title": "Status" + }, + "statusDatetime": { + "type": "string", + "description": "The status datetime.", + "title": "Status Datetime" + } + } + }, + "title": "Items" + } + }, + "title": "Recipients" + } + } + } + } + }, + "summary": "Send SMS", + "description": "Create and send a SMS message.", + "operationId": "MessagesPost", + "parameters": [ + { + "name": "body", + "in": "body", + "required": false, + "schema": { + "type": "object", + "properties": { + "recipients": { + "type": "array", + "description": "The recipients.", + "title": "Recipients", + "items": { + "type": "string" + } + }, + "originator": { + "type": "string", + "description": "The originator.", + "title": "Originator" + }, + "shortcode": { + "type": "integer", + "format": "int32", + "description": "The shortcode.", + "title": "Shortcode" + }, + "body": { + "type": "string", + "description": "The message body.", + "title": "Body" + }, + "groupIds": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The group identifiers.", + "title": "Group IDs" + }, + "type": { + "type": "string", + "description": "The type.", + "title": "Type", + "default": "sms", + "enum": [ + "sms", + "flash" + ] + }, + "reference": { + "type": "string", + "description": "The reference.", + "title": "Reference" + }, + "reportUrl": { + "type": "string", + "description": "The report URL address.", + "title": "Report URL" + }, + "validity": { + "type": "integer", + "format": "int32", + "description": "The validity.", + "title": "Validity" + }, + "gateway": { + "type": "integer", + "format": "int32", + "description": "The gateway.", + "title": "Gateway" + }, + "datacoding": { + "type": "string", + "description": "The data coding.", + "title": "Data Coding" + }, + "mclass": { + "type": "integer", + "format": "int32", + "description": "The message class.", + "title": "Message Class", + "default": 1, + "enum": [ + 1, + 0 + ] + }, + "shortenUrls": { + "type": "boolean", + "description": "Whether the URLs are shortened.", + "title": "Shorten URLs" + }, + "scheduledDatetime": { + "type": "string", + "description": "The scheduled datetime.", + "title": "Scheduled Datetime" + }, + "createdDatetime": { + "type": "string", + "description": "When created datetime.", + "title": "Created Datetime" + } + }, + "required": [ + "body", + "originator", + "recipients" + ] + } + } + ], + "x-ms-visibility": "important" + } + }, + "/messages/{messageId}": { + "get": { + "responses": { + "200": { + "description": "default", + "schema": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "href": { + "type": "string", + "description": "The HREF.", + "title": "HREF" + }, + "direction": { + "type": "string", + "description": "The direction.", + "title": "Direction" + }, + "type": { + "type": "string", + "description": "The type.", + "title": "Type" + }, + "originator": { + "type": "string", + "description": "The originator.", + "title": "Originator" + }, + "body": { + "type": "string", + "description": "The message body.", + "title": "Body" + }, + "reference": { + "type": "string", + "description": "The reference.", + "title": "Reference" + }, + "validity": { + "type": "string", + "description": "The validity.", + "title": "Validity" + }, + "gateway": { + "type": "integer", + "format": "int32", + "description": "The gateway.", + "title": "Gateway" + }, + "typeDetails": { + "type": "object", + "properties": {}, + "description": "The type details.", + "title": "Type Details" + }, + "datacoding": { + "type": "string", + "description": "The data coding.", + "title": "Data Coding" + }, + "mclass": { + "type": "integer", + "format": "int32", + "description": "The message class.", + "title": "Message Class" + }, + "scheduledDatetime": { + "type": "string", + "description": "The scheduled datetime.", + "title": "Scheduled Datetime" + }, + "createdDatetime": { + "type": "string", + "description": "When created datetime.", + "title": "Created Datetime" + }, + "recipients": { + "type": "object", + "properties": { + "totalCount": { + "type": "integer", + "format": "int32", + "description": "The total count.", + "title": "Total Count" + }, + "totalSentCount": { + "type": "integer", + "format": "int32", + "description": "The total sent count.", + "title": "Total Sent Count" + }, + "totalDeliveredCount": { + "type": "integer", + "format": "int32", + "description": "The total delivered count.", + "title": "Total Delivered Count" + }, + "totalDeliveryFailedCount": { + "type": "integer", + "format": "int32", + "description": "The total delivery failed count.", + "title": "Total Delivery Failed Count" + }, + "items": { + "type": "array", + "items": { + "type": "object", + "properties": { + "recipient": { + "type": "integer", + "format": "int32", + "description": "The recipient.", + "title": "Recipient" + }, + "status": { + "type": "string", + "description": "The status.", + "title": "Status" + }, + "statusReason": { + "type": "string", + "description": "The status reason.", + "title": "Status Reason" + }, + "statusErrorCode": { + "type": "string", + "description": "The status error code.", + "title": "Status Error Code" + }, + "statusDatetime": { + "type": "string", + "description": "The status datetime.", + "title": "Status Datetime" + }, + "recipientCountry": { + "type": "string", + "description": "The recipient country.", + "title": "Recipient Country" + }, + "recipientCountryPrefix": { + "type": "integer", + "format": "int32", + "description": "The recipient country prefix.", + "title": "Recipient Country Prefix" + }, + "recipientOperator": { + "type": "string", + "description": "The recipient operator.", + "title": "Recipient Operator" + }, + "mccmnc": { + "type": "string", + "description": "The MCCMNC.", + "title": "MCCMNC" + }, + "mcc": { + "type": "string", + "description": "The MCC.", + "title": "MCC" + }, + "mnc": { + "type": "string", + "description": "The MNC.", + "title": "MNC" + }, + "messageLength": { + "type": "integer", + "format": "int32", + "description": "The message length.", + "title": "Message Length" + }, + "messagePartCount": { + "type": "integer", + "format": "int32", + "description": "The message part count.", + "title": "Message Part Count" + }, + "price": { + "type": "object", + "properties": { + "amount": { + "type": "number", + "format": "float", + "description": "The amount.", + "title": "Amount" + }, + "currency": { + "type": "string", + "description": "The currency.", + "title": "Currency" + } + }, + "title": "Price" + } + } + }, + "title": "Items" + } + }, + "title": "Recipients" + } + } + } + } + }, + "summary": "View a message", + "description": "Retrieve the information of an existing inbound or outbound SMS message.", + "operationId": "MessageGet", + "parameters": [ + { + "name": "messageId", + "in": "path", + "x-ms-summary": "Message ID", + "x-ms-url-encoding": "single", + "description": "The message identifier.", + "required": true, + "type": "string" + } + ], + "x-ms-visibility": "important" + } + }, + "/messages/batches": { + "post": { + "responses": { + "200": { + "description": "default", + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "href": { + "type": "string", + "description": "The HREF.", + "title": "HREF" + }, + "direction": { + "type": "string", + "description": "The direction.", + "title": "Direction" + }, + "type": { + "type": "string", + "description": "The type.", + "title": "Type" + }, + "originator": { + "type": "string", + "description": "The originator.", + "title": "Originator" + }, + "body": { + "type": "string", + "description": "The body.", + "title": "Body" + }, + "reference": { + "type": "string", + "description": "The reference.", + "title": "Reference" + }, + "validity": { + "type": "string", + "description": "The validity.", + "title": "Validity" + }, + "gateway": { + "type": "integer", + "format": "int32", + "description": "The gateway.", + "title": "Gateway" + }, + "typeDetails": { + "type": "object", + "properties": {}, + "description": "The type details.", + "title": "Type Details" + }, + "datacoding": { + "type": "string", + "description": "The data coding.", + "title": "Data Coding" + }, + "mclass": { + "type": "integer", + "format": "int32", + "description": "The message class.", + "title": "Message Class" + }, + "scheduledDatetime": { + "type": "string", + "description": "The schedule datetime.", + "title": "Scheduled Datetime" + }, + "createdDatetime": { + "type": "string", + "description": "When created datetime.", + "title": "Created Datetime" + }, + "recipients": { + "type": "object", + "properties": { + "totalCount": { + "type": "integer", + "format": "int32", + "description": "The total count.", + "title": "Total Count" + }, + "totalSentCount": { + "type": "integer", + "format": "int32", + "description": "The total sent count.", + "title": "Total Sent Count" + }, + "totalDeliveredCount": { + "type": "integer", + "format": "int32", + "description": "The total delivered count.", + "title": "Total Delivered Count" + }, + "totalDeliveryFailedCount": { + "type": "integer", + "format": "int32", + "description": "The total delivery failed count.", + "title": "Total Delivery Failed Count" + }, + "items": { + "type": "array", + "items": { + "type": "object", + "properties": { + "recipient": { + "type": "integer", + "format": "int32", + "description": "The recipient.", + "title": "Recipient" + }, + "status": { + "type": "string", + "description": "The status.", + "title": "Status" + }, + "statusDatetime": { + "type": "string", + "description": "The status datetime.", + "title": "Status Datetime" + } + } + }, + "title": "Items" + } + }, + "title": "Recipients" + } + } + } + } + } + }, + "summary": "Send a batch SMS", + "description": "Sends a batch of SMS messages.", + "operationId": "BatchPost", + "parameters": [ + { + "name": "body", + "in": "body", + "required": false, + "schema": { + "type": "object", + "properties": { + "messages": { + "type": "array", + "items": { + "type": "object", + "properties": { + "recipients": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The recipients.", + "title": "Recipients" + }, + "originator": { + "type": "string", + "description": "The originator.", + "title": "Originator" + }, + "body": { + "type": "string", + "description": "The body.", + "title": "Body" + } + } + }, + "title": "Messages" + } + } + } + } + ] + } + } + }, + "definitions": {}, + "parameters": {}, + "responses": {}, + "securityDefinitions": { + "API Key": { + "type": "apiKey", + "in": "header", + "name": "Authorization" + } + }, + "security": [ + { + "API Key": [] + } + ], + "tags": [], + "x-ms-connector-metadata": [ + { + "propertyName": "Website", + "propertyValue": "https://messagebird.com/" + }, + { + "propertyName": "Privacy policy", + "propertyValue": "https://messagebird.com/legal/terms" + }, + { + "propertyName": "Categories", + "propertyValue": "Communication" + } + ] +} \ No newline at end of file diff --git a/independent-publisher-connectors/MessageBird SMS/apiProperties.json b/independent-publisher-connectors/MessageBird SMS/apiProperties.json new file mode 100644 index 0000000000..6e7345c56c --- /dev/null +++ b/independent-publisher-connectors/MessageBird SMS/apiProperties.json @@ -0,0 +1,23 @@ +{ + "properties": { + "connectionParameters": { + "api_key": { + "type": "securestring", + "uiDefinition": { + "displayName": "Access Key (in the form \"AccessKey yourAccessKey\")", + "description": "The Access Key (in the form \"AccessKey yourAccessKey\") for this api", + "tooltip": "Provide your Access Key (in the form \"AccessKey yourAccessKey\")", + "constraints": { + "tabIndex": 2, + "clearText": false, + "required": "true" + } + } + } + }, + "iconBrandColor": "#da3b01", + "capabilities": [], + "publisher": "Troy Taylor", + "stackOwner": "MesssageBird" + } +} \ No newline at end of file diff --git a/independent-publisher-connectors/MessageBird SMS/readme.md b/independent-publisher-connectors/MessageBird SMS/readme.md new file mode 100644 index 0000000000..fb55057d15 --- /dev/null +++ b/independent-publisher-connectors/MessageBird SMS/readme.md @@ -0,0 +1,23 @@ +# MessageBird SMS +MessageBird’s SMS service allows you to send and receive SMS messages to and from any country in the world. + +## Publisher: Troy Taylor, Hitachi Solutions + +## Prerequisites +You will need to sign up for an account with [MessageBird](https://dashboard.messagebird.com/sign-up). You will also need to verify a mobile telephone number. + +## Obtaining Credentials +Once your number has been verified, you can go to the dashboard to retrieve your API keys for both testing and live usage. + +## Supported Operations +### List messages +Retrieve a list of all inbound and outbound SMS messages. +### Send SMS +Create and send a SMS message. +### View a message +Retrieve the information of an existing inbound or outbound SMS message. +### Send a batch SMS +Sends a batch of SMS messages. + +## Known Issues and Limitations +There are no known issues at this time. From c5fb50434635d55808dddd90d469bd852f67cb18 Mon Sep 17 00:00:00 2001 From: Troy Taylor Date: Fri, 28 Apr 2023 14:59:13 -0400 Subject: [PATCH 13/21] Revert "Add files via upload" This reverts commit 1d855069580b1ee4670c7c8e3b2edec4e0d63cd5. --- .../apiDefinition.swagger.json | 1115 ----------------- .../MessageBird SMS/apiProperties.json | 23 - .../MessageBird SMS/readme.md | 23 - 3 files changed, 1161 deletions(-) delete mode 100644 independent-publisher-connectors/MessageBird SMS/apiDefinition.swagger.json delete mode 100644 independent-publisher-connectors/MessageBird SMS/apiProperties.json delete mode 100644 independent-publisher-connectors/MessageBird SMS/readme.md diff --git a/independent-publisher-connectors/MessageBird SMS/apiDefinition.swagger.json b/independent-publisher-connectors/MessageBird SMS/apiDefinition.swagger.json deleted file mode 100644 index 8604a24c20..0000000000 --- a/independent-publisher-connectors/MessageBird SMS/apiDefinition.swagger.json +++ /dev/null @@ -1,1115 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "MessageBird SMS", - "description": "messagebird's SMS service allows you to send and receive SMS messages to and from any country in the world.", - "version": "1.0", - "contact": { - "name": "Troy Taylor", - "url": "https://www.hitachisolutions.com", - "email": "ttaylor@hitachisolutions.com" - } - }, - "host": "rest.messagebird.com", - "basePath": "/", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "paths": { - "/messages": { - "get": { - "responses": { - "200": { - "description": "default", - "schema": { - "type": "object", - "properties": { - "offset": { - "type": "integer", - "format": "int32", - "description": "The offset.", - "title": "Offset" - }, - "limit": { - "type": "integer", - "format": "int32", - "description": "The limit.", - "title": "Limit" - }, - "count": { - "type": "integer", - "format": "int32", - "description": "The count.", - "title": "Count" - }, - "totalCount": { - "type": "integer", - "format": "int32", - "description": "The total count.", - "title": "Total Count" - }, - "links": { - "type": "object", - "properties": { - "first": { - "type": "string", - "description": "The first.", - "title": "First" - }, - "previous": { - "type": "string", - "description": "The previous.", - "title": "Previous" - }, - "next": { - "type": "string", - "description": "The next.", - "title": "Next" - }, - "last": { - "type": "string", - "description": "The last.", - "title": "Last" - } - }, - "title": "Links" - }, - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The identifier.", - "title": "ID" - }, - "href": { - "type": "string", - "description": "The HREF.", - "title": "HREF" - }, - "direction": { - "type": "string", - "description": "The direction.", - "title": "Direction" - }, - "type": { - "type": "string", - "description": "The type.", - "title": "Type" - }, - "originator": { - "type": "string", - "description": "The originator.", - "title": "Originator" - }, - "body": { - "type": "string", - "description": "The body.", - "title": "Body" - }, - "reference": { - "type": "string", - "description": "The reference.", - "title": "Reference" - }, - "validity": { - "type": "string", - "description": "The validity.", - "title": "Validity" - }, - "gateway": { - "type": "integer", - "format": "int32", - "description": "The gateway.", - "title": "Gateway" - }, - "typeDetails": { - "type": "object", - "properties": {}, - "description": "The type details.", - "title": "Type Details" - }, - "datacoding": { - "type": "string", - "description": "The data coding.", - "title": "Data Coding" - }, - "mclass": { - "type": "integer", - "format": "int32", - "description": "The message class.", - "title": "Message Class" - }, - "scheduledDatetime": { - "type": "string", - "description": "The scheduled datetime.", - "title": "Scheduled Datetime" - }, - "createdDatetime": { - "type": "string", - "description": "When created datetime.", - "title": "Created Datetime" - }, - "recipients": { - "type": "object", - "properties": { - "totalCount": { - "type": "integer", - "format": "int32", - "description": "The total count.", - "title": "Total Count" - }, - "totalSentCount": { - "type": "integer", - "format": "int32", - "description": "The total sent count.", - "title": "Total Sent Count" - }, - "totalDeliveredCount": { - "type": "integer", - "format": "int32", - "description": "The total delivered count.", - "title": "Total Delivered Count" - }, - "totalDeliveryFailedCount": { - "type": "integer", - "format": "int32", - "description": "The total delivery failed count.", - "title": "Total Delivery Failed Count" - }, - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "recipient": { - "type": "integer", - "format": "int32", - "description": "The recipient.", - "title": "Recipient" - }, - "originator": { - "type": "string", - "description": "The originator.", - "title": "Originator" - }, - "status": { - "type": "string", - "description": "The status.", - "title": "Status" - }, - "statusReason": { - "type": "string", - "description": "The status reason.", - "title": "Status Reason" - }, - "statusErrorCode": { - "type": "string", - "description": "The status error code.", - "title": "Status Error Code" - }, - "statusDatetime": { - "type": "string", - "description": "The status datetime.", - "title": "Status Datetime" - }, - "recipientCountry": { - "type": "string", - "description": "The recipient country.", - "title": "Recipient Country" - }, - "recipientCountryPrefix": { - "type": "integer", - "format": "int32", - "description": "The recipient country prefix.", - "title": "Recipient Country Prefix" - }, - "recipientOperator": { - "type": "string", - "description": "The recipient operator.", - "title": "Recipient Operator" - }, - "mccmnc": { - "type": "string", - "description": "The code of the operator of the message sender.", - "title": "MCCMNC" - }, - "mcc": { - "type": "string", - "description": "The MCC.", - "title": "MCC" - }, - "mnc": { - "type": "string", - "description": "The MNC.", - "title": "MNC" - }, - "messageLength": { - "type": "integer", - "format": "int32", - "description": "The message length.", - "title": "Message Length" - }, - "messagePartCount": { - "type": "integer", - "format": "int32", - "description": "The message part count.", - "title": "Message Part Count" - }, - "price": { - "type": "object", - "properties": { - "amount": { - "type": "number", - "format": "float", - "description": "The amount.", - "title": "Amount" - }, - "currency": { - "type": "string", - "description": "The currency.", - "title": "Currency" - } - }, - "title": "Price" - } - } - }, - "title": "Items" - } - }, - "title": "Recipients" - } - } - }, - "title": "Items" - } - } - } - } - }, - "summary": "List messages", - "description": "Retrieve a list of all inbound and outbound SMS messages.", - "operationId": "MessagesGet", - "parameters": [ - { - "name": "originator", - "in": "query", - "x-ms-summary": "Originator", - "description": "The originator.", - "required": false, - "type": "string" - }, - { - "name": "recipient", - "in": "query", - "x-ms-summary": "Recipient", - "description": "The recipient.", - "required": false, - "type": "string" - }, - { - "name": "direction", - "in": "query", - "x-ms-summary": "Direction", - "description": "The direction.", - "required": false, - "type": "string", - "default": "mt", - "enum": [ - "mt", - "mo" - ] - }, - { - "name": "limit", - "in": "query", - "x-ms-summary": "Limit", - "description": "The limit.", - "required": false, - "type": "string" - }, - { - "name": "offset", - "in": "query", - "x-ms-summary": "Offset", - "description": "The offset.", - "required": false, - "type": "integer" - }, - { - "name": "searchterm", - "in": "query", - "x-ms-summary": "Search terms", - "description": "The search terms.", - "required": false, - "type": "string" - }, - { - "name": "type", - "in": "query", - "x-ms-summary": "Type", - "description": "The type.", - "required": false, - "type": "string", - "default": "sms", - "enum": [ - "sms", - "binary", - "flash" - ] - }, - { - "name": "contact_id", - "in": "query", - "x-ms-summary": "Contact ID", - "description": "The contact identifier.", - "required": false, - "type": "integer" - }, - { - "name": "status", - "in": "query", - "x-ms-summary": "Status", - "description": "The status.", - "required": false, - "type": "string", - "default": "sent", - "enum": [ - "sent", - "scheduled", - "buffered", - "delivered", - "expired", - "delivery_failed" - ] - }, - { - "name": "from", - "in": "query", - "x-ms-summary": "From", - "description": "The from.", - "required": false, - "type": "string" - }, - { - "name": "until", - "in": "query", - "x-ms-summary": "Until", - "description": "The until.", - "required": false, - "type": "string" - } - ] - }, - "post": { - "responses": { - "200": { - "description": "default", - "schema": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The identifier.", - "title": "ID" - }, - "href": { - "type": "string", - "description": "The HREF.", - "title": "HREF" - }, - "direction": { - "type": "string", - "description": "The direction.", - "title": "Direction" - }, - "type": { - "type": "string", - "description": "The type.", - "title": "Type" - }, - "originator": { - "type": "string", - "description": "The originator.", - "title": "Originator" - }, - "body": { - "type": "string", - "description": "The message body.", - "title": "Body" - }, - "reference": { - "type": "string", - "description": "The reference.", - "title": "Reference" - }, - "validity": { - "type": "string", - "description": "The validity.", - "title": "Validity" - }, - "gateway": { - "type": "integer", - "format": "int32", - "description": "The gateway.", - "title": "Gateway" - }, - "typeDetails": { - "type": "object", - "properties": {}, - "description": "The type details.", - "title": "Type Details" - }, - "datacoding": { - "type": "string", - "description": "The data coding.", - "title": "Data Coding" - }, - "mclass": { - "type": "integer", - "format": "int32", - "description": "The message class.", - "title": "Message Class" - }, - "scheduledDatetime": { - "type": "string", - "description": "The scheduled datetime.", - "title": "Scheduled Datetime" - }, - "createdDatetime": { - "type": "string", - "description": "When created datetime.", - "title": "Created Datetime" - }, - "recipients": { - "type": "object", - "properties": { - "totalCount": { - "type": "integer", - "format": "int32", - "description": "The total count.", - "title": "Total Count" - }, - "totalSentCount": { - "type": "integer", - "format": "int32", - "description": "The total sent count.", - "title": "Total Sent Count" - }, - "totalDeliveredCount": { - "type": "integer", - "format": "int32", - "description": "The total delivered count.", - "title": "Total Delivered Count" - }, - "totalDeliveryFailedCount": { - "type": "integer", - "format": "int32", - "description": "The total delivery failed count.", - "title": "Total Delivery Failed Count" - }, - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "recipient": { - "type": "integer", - "format": "int32", - "description": "The recipient.", - "title": "Recipient" - }, - "status": { - "type": "string", - "description": "The status.", - "title": "Status" - }, - "statusDatetime": { - "type": "string", - "description": "The status datetime.", - "title": "Status Datetime" - } - } - }, - "title": "Items" - } - }, - "title": "Recipients" - } - } - } - } - }, - "summary": "Send SMS", - "description": "Create and send a SMS message.", - "operationId": "MessagesPost", - "parameters": [ - { - "name": "body", - "in": "body", - "required": false, - "schema": { - "type": "object", - "properties": { - "recipients": { - "type": "array", - "description": "The recipients.", - "title": "Recipients", - "items": { - "type": "string" - } - }, - "originator": { - "type": "string", - "description": "The originator.", - "title": "Originator" - }, - "shortcode": { - "type": "integer", - "format": "int32", - "description": "The shortcode.", - "title": "Shortcode" - }, - "body": { - "type": "string", - "description": "The message body.", - "title": "Body" - }, - "groupIds": { - "type": "array", - "items": { - "type": "string" - }, - "description": "The group identifiers.", - "title": "Group IDs" - }, - "type": { - "type": "string", - "description": "The type.", - "title": "Type", - "default": "sms", - "enum": [ - "sms", - "flash" - ] - }, - "reference": { - "type": "string", - "description": "The reference.", - "title": "Reference" - }, - "reportUrl": { - "type": "string", - "description": "The report URL address.", - "title": "Report URL" - }, - "validity": { - "type": "integer", - "format": "int32", - "description": "The validity.", - "title": "Validity" - }, - "gateway": { - "type": "integer", - "format": "int32", - "description": "The gateway.", - "title": "Gateway" - }, - "datacoding": { - "type": "string", - "description": "The data coding.", - "title": "Data Coding" - }, - "mclass": { - "type": "integer", - "format": "int32", - "description": "The message class.", - "title": "Message Class", - "default": 1, - "enum": [ - 1, - 0 - ] - }, - "shortenUrls": { - "type": "boolean", - "description": "Whether the URLs are shortened.", - "title": "Shorten URLs" - }, - "scheduledDatetime": { - "type": "string", - "description": "The scheduled datetime.", - "title": "Scheduled Datetime" - }, - "createdDatetime": { - "type": "string", - "description": "When created datetime.", - "title": "Created Datetime" - } - }, - "required": [ - "body", - "originator", - "recipients" - ] - } - } - ], - "x-ms-visibility": "important" - } - }, - "/messages/{messageId}": { - "get": { - "responses": { - "200": { - "description": "default", - "schema": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The identifier.", - "title": "ID" - }, - "href": { - "type": "string", - "description": "The HREF.", - "title": "HREF" - }, - "direction": { - "type": "string", - "description": "The direction.", - "title": "Direction" - }, - "type": { - "type": "string", - "description": "The type.", - "title": "Type" - }, - "originator": { - "type": "string", - "description": "The originator.", - "title": "Originator" - }, - "body": { - "type": "string", - "description": "The message body.", - "title": "Body" - }, - "reference": { - "type": "string", - "description": "The reference.", - "title": "Reference" - }, - "validity": { - "type": "string", - "description": "The validity.", - "title": "Validity" - }, - "gateway": { - "type": "integer", - "format": "int32", - "description": "The gateway.", - "title": "Gateway" - }, - "typeDetails": { - "type": "object", - "properties": {}, - "description": "The type details.", - "title": "Type Details" - }, - "datacoding": { - "type": "string", - "description": "The data coding.", - "title": "Data Coding" - }, - "mclass": { - "type": "integer", - "format": "int32", - "description": "The message class.", - "title": "Message Class" - }, - "scheduledDatetime": { - "type": "string", - "description": "The scheduled datetime.", - "title": "Scheduled Datetime" - }, - "createdDatetime": { - "type": "string", - "description": "When created datetime.", - "title": "Created Datetime" - }, - "recipients": { - "type": "object", - "properties": { - "totalCount": { - "type": "integer", - "format": "int32", - "description": "The total count.", - "title": "Total Count" - }, - "totalSentCount": { - "type": "integer", - "format": "int32", - "description": "The total sent count.", - "title": "Total Sent Count" - }, - "totalDeliveredCount": { - "type": "integer", - "format": "int32", - "description": "The total delivered count.", - "title": "Total Delivered Count" - }, - "totalDeliveryFailedCount": { - "type": "integer", - "format": "int32", - "description": "The total delivery failed count.", - "title": "Total Delivery Failed Count" - }, - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "recipient": { - "type": "integer", - "format": "int32", - "description": "The recipient.", - "title": "Recipient" - }, - "status": { - "type": "string", - "description": "The status.", - "title": "Status" - }, - "statusReason": { - "type": "string", - "description": "The status reason.", - "title": "Status Reason" - }, - "statusErrorCode": { - "type": "string", - "description": "The status error code.", - "title": "Status Error Code" - }, - "statusDatetime": { - "type": "string", - "description": "The status datetime.", - "title": "Status Datetime" - }, - "recipientCountry": { - "type": "string", - "description": "The recipient country.", - "title": "Recipient Country" - }, - "recipientCountryPrefix": { - "type": "integer", - "format": "int32", - "description": "The recipient country prefix.", - "title": "Recipient Country Prefix" - }, - "recipientOperator": { - "type": "string", - "description": "The recipient operator.", - "title": "Recipient Operator" - }, - "mccmnc": { - "type": "string", - "description": "The MCCMNC.", - "title": "MCCMNC" - }, - "mcc": { - "type": "string", - "description": "The MCC.", - "title": "MCC" - }, - "mnc": { - "type": "string", - "description": "The MNC.", - "title": "MNC" - }, - "messageLength": { - "type": "integer", - "format": "int32", - "description": "The message length.", - "title": "Message Length" - }, - "messagePartCount": { - "type": "integer", - "format": "int32", - "description": "The message part count.", - "title": "Message Part Count" - }, - "price": { - "type": "object", - "properties": { - "amount": { - "type": "number", - "format": "float", - "description": "The amount.", - "title": "Amount" - }, - "currency": { - "type": "string", - "description": "The currency.", - "title": "Currency" - } - }, - "title": "Price" - } - } - }, - "title": "Items" - } - }, - "title": "Recipients" - } - } - } - } - }, - "summary": "View a message", - "description": "Retrieve the information of an existing inbound or outbound SMS message.", - "operationId": "MessageGet", - "parameters": [ - { - "name": "messageId", - "in": "path", - "x-ms-summary": "Message ID", - "x-ms-url-encoding": "single", - "description": "The message identifier.", - "required": true, - "type": "string" - } - ], - "x-ms-visibility": "important" - } - }, - "/messages/batches": { - "post": { - "responses": { - "200": { - "description": "default", - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The identifier.", - "title": "ID" - }, - "href": { - "type": "string", - "description": "The HREF.", - "title": "HREF" - }, - "direction": { - "type": "string", - "description": "The direction.", - "title": "Direction" - }, - "type": { - "type": "string", - "description": "The type.", - "title": "Type" - }, - "originator": { - "type": "string", - "description": "The originator.", - "title": "Originator" - }, - "body": { - "type": "string", - "description": "The body.", - "title": "Body" - }, - "reference": { - "type": "string", - "description": "The reference.", - "title": "Reference" - }, - "validity": { - "type": "string", - "description": "The validity.", - "title": "Validity" - }, - "gateway": { - "type": "integer", - "format": "int32", - "description": "The gateway.", - "title": "Gateway" - }, - "typeDetails": { - "type": "object", - "properties": {}, - "description": "The type details.", - "title": "Type Details" - }, - "datacoding": { - "type": "string", - "description": "The data coding.", - "title": "Data Coding" - }, - "mclass": { - "type": "integer", - "format": "int32", - "description": "The message class.", - "title": "Message Class" - }, - "scheduledDatetime": { - "type": "string", - "description": "The schedule datetime.", - "title": "Scheduled Datetime" - }, - "createdDatetime": { - "type": "string", - "description": "When created datetime.", - "title": "Created Datetime" - }, - "recipients": { - "type": "object", - "properties": { - "totalCount": { - "type": "integer", - "format": "int32", - "description": "The total count.", - "title": "Total Count" - }, - "totalSentCount": { - "type": "integer", - "format": "int32", - "description": "The total sent count.", - "title": "Total Sent Count" - }, - "totalDeliveredCount": { - "type": "integer", - "format": "int32", - "description": "The total delivered count.", - "title": "Total Delivered Count" - }, - "totalDeliveryFailedCount": { - "type": "integer", - "format": "int32", - "description": "The total delivery failed count.", - "title": "Total Delivery Failed Count" - }, - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "recipient": { - "type": "integer", - "format": "int32", - "description": "The recipient.", - "title": "Recipient" - }, - "status": { - "type": "string", - "description": "The status.", - "title": "Status" - }, - "statusDatetime": { - "type": "string", - "description": "The status datetime.", - "title": "Status Datetime" - } - } - }, - "title": "Items" - } - }, - "title": "Recipients" - } - } - } - } - } - }, - "summary": "Send a batch SMS", - "description": "Sends a batch of SMS messages.", - "operationId": "BatchPost", - "parameters": [ - { - "name": "body", - "in": "body", - "required": false, - "schema": { - "type": "object", - "properties": { - "messages": { - "type": "array", - "items": { - "type": "object", - "properties": { - "recipients": { - "type": "array", - "items": { - "type": "string" - }, - "description": "The recipients.", - "title": "Recipients" - }, - "originator": { - "type": "string", - "description": "The originator.", - "title": "Originator" - }, - "body": { - "type": "string", - "description": "The body.", - "title": "Body" - } - } - }, - "title": "Messages" - } - } - } - } - ] - } - } - }, - "definitions": {}, - "parameters": {}, - "responses": {}, - "securityDefinitions": { - "API Key": { - "type": "apiKey", - "in": "header", - "name": "Authorization" - } - }, - "security": [ - { - "API Key": [] - } - ], - "tags": [], - "x-ms-connector-metadata": [ - { - "propertyName": "Website", - "propertyValue": "https://messagebird.com/" - }, - { - "propertyName": "Privacy policy", - "propertyValue": "https://messagebird.com/legal/terms" - }, - { - "propertyName": "Categories", - "propertyValue": "Communication" - } - ] -} \ No newline at end of file diff --git a/independent-publisher-connectors/MessageBird SMS/apiProperties.json b/independent-publisher-connectors/MessageBird SMS/apiProperties.json deleted file mode 100644 index 6e7345c56c..0000000000 --- a/independent-publisher-connectors/MessageBird SMS/apiProperties.json +++ /dev/null @@ -1,23 +0,0 @@ -{ - "properties": { - "connectionParameters": { - "api_key": { - "type": "securestring", - "uiDefinition": { - "displayName": "Access Key (in the form \"AccessKey yourAccessKey\")", - "description": "The Access Key (in the form \"AccessKey yourAccessKey\") for this api", - "tooltip": "Provide your Access Key (in the form \"AccessKey yourAccessKey\")", - "constraints": { - "tabIndex": 2, - "clearText": false, - "required": "true" - } - } - } - }, - "iconBrandColor": "#da3b01", - "capabilities": [], - "publisher": "Troy Taylor", - "stackOwner": "MesssageBird" - } -} \ No newline at end of file diff --git a/independent-publisher-connectors/MessageBird SMS/readme.md b/independent-publisher-connectors/MessageBird SMS/readme.md deleted file mode 100644 index fb55057d15..0000000000 --- a/independent-publisher-connectors/MessageBird SMS/readme.md +++ /dev/null @@ -1,23 +0,0 @@ -# MessageBird SMS -MessageBird’s SMS service allows you to send and receive SMS messages to and from any country in the world. - -## Publisher: Troy Taylor, Hitachi Solutions - -## Prerequisites -You will need to sign up for an account with [MessageBird](https://dashboard.messagebird.com/sign-up). You will also need to verify a mobile telephone number. - -## Obtaining Credentials -Once your number has been verified, you can go to the dashboard to retrieve your API keys for both testing and live usage. - -## Supported Operations -### List messages -Retrieve a list of all inbound and outbound SMS messages. -### Send SMS -Create and send a SMS message. -### View a message -Retrieve the information of an existing inbound or outbound SMS message. -### Send a batch SMS -Sends a batch of SMS messages. - -## Known Issues and Limitations -There are no known issues at this time. From b94447a14268a503fa5224ab942d8bbbdf443111 Mon Sep 17 00:00:00 2001 From: Troy Taylor <44444967+troystaylor@users.noreply.github.com> Date: Fri, 25 Aug 2023 17:35:58 -0400 Subject: [PATCH 14/21] Update readme.md --- independent-publisher-connectors/OpenAI GPT-4/readme.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/independent-publisher-connectors/OpenAI GPT-4/readme.md b/independent-publisher-connectors/OpenAI GPT-4/readme.md index 0856633544..ebab704efa 100644 --- a/independent-publisher-connectors/OpenAI GPT-4/readme.md +++ b/independent-publisher-connectors/OpenAI GPT-4/readme.md @@ -18,6 +18,11 @@ The connector supports the following operations: - `Edit prompt`: Creates a new edit for the provided input, instruction, and parameters. - `Create an image`: Dall-E creates an image from your prompt. - `List models`: Lists the currently available models, and provides basic information about each one such as the owner and availability. +- `Create fine-tuning job`: Creates a job that fine-tunes a specified model from a given dataset. +- `Retrieve fine-tuning job`: Retrieve info about a fine-tuning job. +- `Cancel fine-tuning`: Immediately cancel a fine-tune job. +- `List fine-tuning events`: Retrieve status updates for a fine-tuning job. +- `Create moderation`: Classifies if text violates OpenAI's Content Policy. ## Obtaining Credentials From 6016a1e20b50c7a0b8b5206e053cc3f575ccdea0 Mon Sep 17 00:00:00 2001 From: Troy Taylor Date: Sat, 26 Aug 2023 15:25:51 -0400 Subject: [PATCH 15/21] Revert "Update readme.md" This reverts commit b94447a14268a503fa5224ab942d8bbbdf443111. --- independent-publisher-connectors/OpenAI GPT-4/readme.md | 5 ----- 1 file changed, 5 deletions(-) diff --git a/independent-publisher-connectors/OpenAI GPT-4/readme.md b/independent-publisher-connectors/OpenAI GPT-4/readme.md index ebab704efa..0856633544 100644 --- a/independent-publisher-connectors/OpenAI GPT-4/readme.md +++ b/independent-publisher-connectors/OpenAI GPT-4/readme.md @@ -18,11 +18,6 @@ The connector supports the following operations: - `Edit prompt`: Creates a new edit for the provided input, instruction, and parameters. - `Create an image`: Dall-E creates an image from your prompt. - `List models`: Lists the currently available models, and provides basic information about each one such as the owner and availability. -- `Create fine-tuning job`: Creates a job that fine-tunes a specified model from a given dataset. -- `Retrieve fine-tuning job`: Retrieve info about a fine-tuning job. -- `Cancel fine-tuning`: Immediately cancel a fine-tune job. -- `List fine-tuning events`: Retrieve status updates for a fine-tuning job. -- `Create moderation`: Classifies if text violates OpenAI's Content Policy. ## Obtaining Credentials From 12cb17f15539745892830327cf94eba1e657b595 Mon Sep 17 00:00:00 2001 From: Troy Taylor <44444967+troystaylor@users.noreply.github.com> Date: Mon, 6 Nov 2023 16:26:55 -0500 Subject: [PATCH 16/21] Add files via upload --- .../apiDefinition.swagger.json | 198 ++++++++++++++++++ .../apiProperties.json | 23 ++ .../ApyHub Document Readability/readme.md | 17 ++ 3 files changed, 238 insertions(+) create mode 100644 independent-publisher-connectors/ApyHub Document Readability/apiDefinition.swagger.json create mode 100644 independent-publisher-connectors/ApyHub Document Readability/apiProperties.json create mode 100644 independent-publisher-connectors/ApyHub Document Readability/readme.md diff --git a/independent-publisher-connectors/ApyHub Document Readability/apiDefinition.swagger.json b/independent-publisher-connectors/ApyHub Document Readability/apiDefinition.swagger.json new file mode 100644 index 0000000000..8e26603421 --- /dev/null +++ b/independent-publisher-connectors/ApyHub Document Readability/apiDefinition.swagger.json @@ -0,0 +1,198 @@ +{ + "swagger": "2.0", + "info": { + "title": "ApyHub", + "description": "ApyHub is a service utility belt that helps developers save time and boost efficiency. Included are actions for calculating the readability score of PDF or Word documents, providing insights into their ease of comprehension. Includes Flesh-Kincaid reading ease score and grade level.", + "version": "1.0", + "contact": { + "name": "Troy Taylor", + "url": "https://www.hitachisolutions.com", + "email": "ttaylor@hitachisolutions.com" + } + }, + "host": "api.apyhub.com", + "basePath": "/", + "schemes": [ + "https" + ], + "consumes": [], + "produces": [], + "paths": { + "/extract/document/readability-score/file": { + "post": { + "responses": { + "200": { + "description": "default", + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "flesh_kincaid_reading_ease": { + "type": "object", + "properties": { + "score": { + "type": "number", + "format": "float", + "description": "The score.", + "title": "Score" + }, + "level": { + "type": "number", + "format": "float", + "description": "The level.", + "title": "Level" + }, + "label": { + "type": "boolean", + "description": "Whether the ease score is greater than 70.", + "title": "Label" + }, + "class": { + "type": "string", + "description": "The class.", + "title": "Class" + }, + "class_label": { + "type": "string", + "description": "The full class label.", + "title": "Class Label" + } + }, + "title": "Flesh-Kincaid Reading Ease" + }, + "stats": { + "type": "object", + "properties": { + "paragraphs": { + "type": "integer", + "format": "int32", + "description": "The paragraphs.", + "title": "Paragraphs" + }, + "sentences": { + "type": "integer", + "format": "int32", + "description": "The sentences.", + "title": "Sentences" + }, + "words": { + "type": "integer", + "format": "int32", + "description": "The words.", + "title": "Words" + }, + "characters": { + "type": "integer", + "format": "int32", + "description": "The characters.", + "title": "Characters" + }, + "reading_time": { + "type": "number", + "format": "float", + "description": "The reading time in seconds.", + "title": "Reading Time" + }, + "speaking_time": { + "type": "number", + "format": "float", + "description": "The speaking time in seconds.", + "title": "Speaking Time" + }, + "avg_word_length": { + "type": "number", + "format": "float", + "description": "The average word length.", + "title": "Avg Word Length" + }, + "avg_sentence_length": { + "type": "number", + "format": "float", + "description": "The average sentence length.", + "title": "Avg Sentence Length" + }, + "avg_paragraph_length": { + "type": "number", + "format": "float", + "description": "The average paragraph length.", + "title": "Avg Paragraph Length" + } + }, + "title": "Stats" + } + }, + "title": "File" + } + } + } + } + }, + "summary": "Get readability scores", + "description": "Retrieve the readability score of a PDF or Word document file.", + "operationId": "ScorePost", + "consumes": [ + "multipart/form-data" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "file", + "in": "formData", + "description": "The file content.", + "x-ms-summary": "File", + "required": true, + "type": "file" + }, + { + "name": "Content-Type", + "in": "formData", + "description": "The file content type.", + "x-ms-summary": "Content Type", + "required": true, + "type": "string", + "default": "application/pdf", + "enum": [ + "application/pdf", + "application/vnd.openxmlformats-officedocument.wordprocessingml.document", + "application/msword" + ] + } + ] + } + } + }, + "definitions": {}, + "parameters": {}, + "responses": {}, + "securityDefinitions": { + "API Key": { + "type": "apiKey", + "in": "header", + "name": "apy-token" + } + }, + "security": [ + { + "API Key": [] + } + ], + "tags": [], + "x-ms-connector-metadata": [ + { + "propertyName": "Website", + "propertyValue": "https://apyhub.com/" + }, + { + "propertyName": "Privacy policy", + "propertyValue": "https://apyhub.com/privacy" + }, + { + "propertyName": "Categories", + "propertyValue": "Content and Files;AI" + } + ] +} \ No newline at end of file diff --git a/independent-publisher-connectors/ApyHub Document Readability/apiProperties.json b/independent-publisher-connectors/ApyHub Document Readability/apiProperties.json new file mode 100644 index 0000000000..1eaf1962c8 --- /dev/null +++ b/independent-publisher-connectors/ApyHub Document Readability/apiProperties.json @@ -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", + "constraints": { + "tabIndex": 2, + "clearText": false, + "required": "true" + } + } + } + }, + "iconBrandColor": "#da3b01", + "capabilities": [], + "publisher": "Troy Taylor", + "stackOwner": "ApyHub" + } +} \ No newline at end of file diff --git a/independent-publisher-connectors/ApyHub Document Readability/readme.md b/independent-publisher-connectors/ApyHub Document Readability/readme.md new file mode 100644 index 0000000000..39b3de5451 --- /dev/null +++ b/independent-publisher-connectors/ApyHub Document Readability/readme.md @@ -0,0 +1,17 @@ +# ApyHub Document Readability +ApyHub is a service utility belt that helps developers save time and boost efficiency. Included are actions for calculating the readability score of PDF or Word documents, providing insights into their ease of comprehension. Includes Flesh-Kincaid reading ease score and grade level. + +## Publisher: Troy Taylor, Hitachi Solutions + +## Prerequisites +You must sign up for an account with [ApyHub](https://apyhub.com/auth/signup). + +## Obtaining Credentials +Once logged in to your dashboard, go to the API Keys page under My Workspace to create a new API key. + +## Supported Operations +### Get readability scores +Retrieve the readability score of a PDF or Word document file. + +## Known Issues and Limitations +There are no known issues at this time. From 0c1c9db46e04ca98ab44abff2101d05663cf5940 Mon Sep 17 00:00:00 2001 From: Troy Taylor Date: Fri, 8 Dec 2023 09:34:30 -0500 Subject: [PATCH 17/21] Remove ApyHub --- .../apiDefinition.swagger.json | 198 ------------------ .../apiProperties.json | 23 -- .../ApyHub Document Readability/readme.md | 17 -- 3 files changed, 238 deletions(-) delete mode 100644 independent-publisher-connectors/ApyHub Document Readability/apiDefinition.swagger.json delete mode 100644 independent-publisher-connectors/ApyHub Document Readability/apiProperties.json delete mode 100644 independent-publisher-connectors/ApyHub Document Readability/readme.md diff --git a/independent-publisher-connectors/ApyHub Document Readability/apiDefinition.swagger.json b/independent-publisher-connectors/ApyHub Document Readability/apiDefinition.swagger.json deleted file mode 100644 index 8e26603421..0000000000 --- a/independent-publisher-connectors/ApyHub Document Readability/apiDefinition.swagger.json +++ /dev/null @@ -1,198 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "ApyHub", - "description": "ApyHub is a service utility belt that helps developers save time and boost efficiency. Included are actions for calculating the readability score of PDF or Word documents, providing insights into their ease of comprehension. Includes Flesh-Kincaid reading ease score and grade level.", - "version": "1.0", - "contact": { - "name": "Troy Taylor", - "url": "https://www.hitachisolutions.com", - "email": "ttaylor@hitachisolutions.com" - } - }, - "host": "api.apyhub.com", - "basePath": "/", - "schemes": [ - "https" - ], - "consumes": [], - "produces": [], - "paths": { - "/extract/document/readability-score/file": { - "post": { - "responses": { - "200": { - "description": "default", - "schema": { - "type": "object", - "properties": { - "data": { - "type": "object", - "properties": { - "flesh_kincaid_reading_ease": { - "type": "object", - "properties": { - "score": { - "type": "number", - "format": "float", - "description": "The score.", - "title": "Score" - }, - "level": { - "type": "number", - "format": "float", - "description": "The level.", - "title": "Level" - }, - "label": { - "type": "boolean", - "description": "Whether the ease score is greater than 70.", - "title": "Label" - }, - "class": { - "type": "string", - "description": "The class.", - "title": "Class" - }, - "class_label": { - "type": "string", - "description": "The full class label.", - "title": "Class Label" - } - }, - "title": "Flesh-Kincaid Reading Ease" - }, - "stats": { - "type": "object", - "properties": { - "paragraphs": { - "type": "integer", - "format": "int32", - "description": "The paragraphs.", - "title": "Paragraphs" - }, - "sentences": { - "type": "integer", - "format": "int32", - "description": "The sentences.", - "title": "Sentences" - }, - "words": { - "type": "integer", - "format": "int32", - "description": "The words.", - "title": "Words" - }, - "characters": { - "type": "integer", - "format": "int32", - "description": "The characters.", - "title": "Characters" - }, - "reading_time": { - "type": "number", - "format": "float", - "description": "The reading time in seconds.", - "title": "Reading Time" - }, - "speaking_time": { - "type": "number", - "format": "float", - "description": "The speaking time in seconds.", - "title": "Speaking Time" - }, - "avg_word_length": { - "type": "number", - "format": "float", - "description": "The average word length.", - "title": "Avg Word Length" - }, - "avg_sentence_length": { - "type": "number", - "format": "float", - "description": "The average sentence length.", - "title": "Avg Sentence Length" - }, - "avg_paragraph_length": { - "type": "number", - "format": "float", - "description": "The average paragraph length.", - "title": "Avg Paragraph Length" - } - }, - "title": "Stats" - } - }, - "title": "File" - } - } - } - } - }, - "summary": "Get readability scores", - "description": "Retrieve the readability score of a PDF or Word document file.", - "operationId": "ScorePost", - "consumes": [ - "multipart/form-data" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "file", - "in": "formData", - "description": "The file content.", - "x-ms-summary": "File", - "required": true, - "type": "file" - }, - { - "name": "Content-Type", - "in": "formData", - "description": "The file content type.", - "x-ms-summary": "Content Type", - "required": true, - "type": "string", - "default": "application/pdf", - "enum": [ - "application/pdf", - "application/vnd.openxmlformats-officedocument.wordprocessingml.document", - "application/msword" - ] - } - ] - } - } - }, - "definitions": {}, - "parameters": {}, - "responses": {}, - "securityDefinitions": { - "API Key": { - "type": "apiKey", - "in": "header", - "name": "apy-token" - } - }, - "security": [ - { - "API Key": [] - } - ], - "tags": [], - "x-ms-connector-metadata": [ - { - "propertyName": "Website", - "propertyValue": "https://apyhub.com/" - }, - { - "propertyName": "Privacy policy", - "propertyValue": "https://apyhub.com/privacy" - }, - { - "propertyName": "Categories", - "propertyValue": "Content and Files;AI" - } - ] -} \ No newline at end of file diff --git a/independent-publisher-connectors/ApyHub Document Readability/apiProperties.json b/independent-publisher-connectors/ApyHub Document Readability/apiProperties.json deleted file mode 100644 index 1eaf1962c8..0000000000 --- a/independent-publisher-connectors/ApyHub Document Readability/apiProperties.json +++ /dev/null @@ -1,23 +0,0 @@ -{ - "properties": { - "connectionParameters": { - "api_key": { - "type": "securestring", - "uiDefinition": { - "displayName": "API Key", - "description": "The API Key for this api", - "tooltip": "Provide your API Key", - "constraints": { - "tabIndex": 2, - "clearText": false, - "required": "true" - } - } - } - }, - "iconBrandColor": "#da3b01", - "capabilities": [], - "publisher": "Troy Taylor", - "stackOwner": "ApyHub" - } -} \ No newline at end of file diff --git a/independent-publisher-connectors/ApyHub Document Readability/readme.md b/independent-publisher-connectors/ApyHub Document Readability/readme.md deleted file mode 100644 index 39b3de5451..0000000000 --- a/independent-publisher-connectors/ApyHub Document Readability/readme.md +++ /dev/null @@ -1,17 +0,0 @@ -# ApyHub Document Readability -ApyHub is a service utility belt that helps developers save time and boost efficiency. Included are actions for calculating the readability score of PDF or Word documents, providing insights into their ease of comprehension. Includes Flesh-Kincaid reading ease score and grade level. - -## Publisher: Troy Taylor, Hitachi Solutions - -## Prerequisites -You must sign up for an account with [ApyHub](https://apyhub.com/auth/signup). - -## Obtaining Credentials -Once logged in to your dashboard, go to the API Keys page under My Workspace to create a new API key. - -## Supported Operations -### Get readability scores -Retrieve the readability score of a PDF or Word document file. - -## Known Issues and Limitations -There are no known issues at this time. From 0faa5f1662db5adbf0d75f685fd1b43b3bb5f139 Mon Sep 17 00:00:00 2001 From: Troy Taylor <44444967+troystaylor@users.noreply.github.com> Date: Fri, 8 Dec 2023 09:35:10 -0500 Subject: [PATCH 18/21] Add files via upload --- .../Perplexity AI/apiDefinition.swagger.json | 280 ++++++++++++++++++ .../Perplexity AI/apiProperties.json | 23 ++ .../Perplexity AI/readme.md | 17 ++ 3 files changed, 320 insertions(+) create mode 100644 independent-publisher-connectors/Perplexity AI/apiDefinition.swagger.json create mode 100644 independent-publisher-connectors/Perplexity AI/apiProperties.json create mode 100644 independent-publisher-connectors/Perplexity AI/readme.md diff --git a/independent-publisher-connectors/Perplexity AI/apiDefinition.swagger.json b/independent-publisher-connectors/Perplexity AI/apiDefinition.swagger.json new file mode 100644 index 0000000000..c64749d4f4 --- /dev/null +++ b/independent-publisher-connectors/Perplexity AI/apiDefinition.swagger.json @@ -0,0 +1,280 @@ +{ + "swagger": "2.0", + "info": { + "title": "Perplexity AI", + "description": "Unlock the most powerful AI research assistant. Raise Perplexity to the next level with more Copilot, upgraded AI, unlimited file upload, and web service access. Upgrade to Claude-2 or GPT-4 for more accurate answers, will pplx, Mistral, and Llama language models also available.", + "version": "1.0", + "contact": { + "name": "Troy Taylor", + "url": "https://www.hitachisolutions.com", + "email": "ttaylor@hitachisolutions.com" + } + }, + "host": "api.perplexity.ai", + "basePath": "/", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/chat/completions": { + "post": { + "responses": { + "200": { + "description": "default", + "schema": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "model": { + "type": "string", + "description": "The model.", + "title": "Model" + }, + "object": { + "type": "string", + "description": "The object.", + "title": "Object" + }, + "created": { + "type": "integer", + "format": "int32", + "description": "When created.", + "title": "Created" + }, + "choices": { + "type": "array", + "items": { + "type": "object", + "properties": { + "index": { + "type": "integer", + "format": "int32", + "description": "The index.", + "title": "Index" + }, + "finish_reason": { + "type": "string", + "description": "The finish reason", + "title": "Finish Reason" + }, + "message": { + "type": "object", + "properties": { + "content": { + "type": "string", + "description": "The content.", + "title": "Content" + }, + "role": { + "type": "string", + "description": "The role.", + "title": "Role" + } + }, + "title": "Message" + }, + "delta": { + "type": "object", + "properties": { + "content": { + "type": "string", + "description": "The content.", + "title": "Content" + }, + "role": { + "type": "string", + "description": "The role.", + "title": "Role" + } + }, + "title": "Delta" + } + } + }, + "title": "Choices" + }, + "usage": { + "type": "object", + "properties": { + "prompt_tokens": { + "type": "integer", + "format": "int32", + "description": "The prompt tokens used.", + "title": "Prompt Tokens" + }, + "completion_tokens": { + "type": "integer", + "format": "int32", + "description": "The completion tokens used.", + "title": "Completion Tokens" + }, + "total_tokens": { + "type": "integer", + "format": "int32", + "description": "The total tokens used.", + "title": "Total Tokens" + } + }, + "title": "Usage" + } + } + } + } + }, + "summary": "Get chat completion", + "parameters": [ + { + "name": "body", + "in": "body", + "required": false, + "schema": { + "type": "object", + "properties": { + "model": { + "type": "string", + "description": "The name of the model that will complete your prompt.", + "title": "Model", + "default": "mistral-7b-instruct", + "enum": [ + "mistral-7b-instruct", + "pplx-7b-chat", + "pplx-70b-chat", + "pplx-7b-online", + "pplx-70b-online", + "llama-2-70b-chat", + "codellama-34b-instruct" + ] + }, + "messages": { + "type": "array", + "items": { + "type": "object", + "properties": { + "role": { + "type": "string", + "description": "The role of the speaker in this turn of conversation. After the (optional) system message, user and assistant roles should alternate with user then assistant, ending in user.", + "title": "Role", + "default": "system", + "enum": [ + "system", + "user", + "assistant" + ] + }, + "content": { + "type": "string", + "description": "The contents of the message in this turn of conversation.", + "title": "Content" + } + }, + "required": [ + "content", + "role" + ] + }, + "description": "messages" + }, + "max_tokens": { + "type": "integer", + "format": "int32", + "description": "The maximum number of completion tokens returned by the API. The total number of tokens requested in max_tokens plus the number of prompt tokens sent in messages must not exceed the context window token limit of model requested. If left unspecified, then the model will generate tokens until either it reaches its stop token or the end of its context window.", + "title": "Max Tokens" + }, + "temperature": { + "type": "number", + "format": "double", + "description": "The amount of randomness in the response, valued between 0 inclusive and 2 exclusive. Higher values are more random, and lower values are more deterministic. You should either set temperature or top_p, but not both.", + "title": "Temperature" + }, + "top_p": { + "type": "number", + "format": "double", + "description": "The nucleus sampling threshold, valued between 0 and 1 inclusive. For each subsequent token, the model considers the results of the tokens with top_p probability mass. You should either alter temperature or top_p, but not both.", + "title": "Top P" + }, + "top_k": { + "type": "number", + "format": "double", + "description": "The number of tokens to keep for highest top-k filtering, specified as an integer between 0 and 2048 inclusive. If set to 0, top-k filtering is disabled.", + "title": "Top K" + }, + "presence_penalty": { + "type": "number", + "format": "double", + "description": "A value between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics. Incompatible with frequency penalty.", + "title": "Presence Penalty" + }, + "frequency_penalty": { + "type": "number", + "format": "double", + "description": "A multiplicative penalty greater than 0. Values greater than 1.0 penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim. A value of 1.0 means no penalty. Incompatible with presence penalty.", + "title": "Frequency Penalty" + } + }, + "required": [ + "model", + "messages" + ] + } + } + ], + "description": "Generates a model's response for the given chat conversation.", + "operationId": "CompletionPost", + "x-ms-openai-data": { + "openai-enabled": true, + "operations": [ + { + "operationId": "CompletionPost", + "x-ms-require-user-confirmation": true + } + ] + } + } + } + }, + "definitions": {}, + "parameters": {}, + "responses": {}, + "securityDefinitions": { + "API Key (in the form 'Bearer YOUR_API_KEY')": { + "type": "apiKey", + "in": "header", + "name": "Authorization" + } + }, + "security": [ + { + "API Key (in the form 'Bearer YOUR_API_KEY')": [] + } + ], + "tags": [], + "x-ms-openai-manifest": { + "humanName": "Perplexity AI", + "modelDescription": "This is a Copilot plugin for Perplexity AI to retrieve chat completions.", + "contactEmail": "ttaylor@hitachisolutions.com" + }, + "x-ms-connector-metadata": [ + { + "propertyName": "Website", + "propertyValue": "https://www.perplexity.ai/" + }, + { + "propertyName": "Privacy policy", + "propertyValue": "https://blog.perplexity.ai/legal/privacy-policy" + }, + { + "propertyName": "Categories", + "propertyValue": "AI" + } + ] +} \ No newline at end of file diff --git a/independent-publisher-connectors/Perplexity AI/apiProperties.json b/independent-publisher-connectors/Perplexity AI/apiProperties.json new file mode 100644 index 0000000000..0def527296 --- /dev/null +++ b/independent-publisher-connectors/Perplexity AI/apiProperties.json @@ -0,0 +1,23 @@ +{ + "properties": { + "connectionParameters": { + "api_key": { + "type": "securestring", + "uiDefinition": { + "displayName": "API Key (in the form 'Bearer YOUR_API_KEY')", + "description": "The API Key (in the form 'Bearer YOUR_API_KEY') for this api", + "tooltip": "Provide your API Key (in the form 'Bearer YOUR_API_KEY')", + "constraints": { + "tabIndex": 2, + "clearText": false, + "required": "true" + } + } + } + }, + "iconBrandColor": "#da3b01", + "capabilities": [], + "publisher": "Troy Taylor", + "stackOwner": "Perplexity AI" + } +} \ No newline at end of file diff --git a/independent-publisher-connectors/Perplexity AI/readme.md b/independent-publisher-connectors/Perplexity AI/readme.md new file mode 100644 index 0000000000..58e574381c --- /dev/null +++ b/independent-publisher-connectors/Perplexity AI/readme.md @@ -0,0 +1,17 @@ +# Perplexity AI +Unlock the most powerful AI research assistant. Raise Perplexity to the next level with more Copilot, upgraded AI, unlimited file upload, and web service access. Upgrade to Claude-2 or GPT-4 for more accurate answers, will pplx, Mistral, and Llama language models also available. + +## Publisher: Troy Taylor, Hitachi Solutions + +## Prerequisites +You must sign up for an account [Perplexity AI](https://www.perplexity.ai/) and add a credit card to the account. + +## Obtaining Credentials +Once logged in to your account, you can generate an API key in the Settings API section. + +## Supported Operations +### Get chat completion +Generates a model's response for the given chat conversation. + +## Known Issues and Limitations +There are no known issues at this time. From 4c02cc0b238a7af4f16b36eaa6f48b047f9a1e97 Mon Sep 17 00:00:00 2001 From: Troy Taylor <44444967+troystaylor@users.noreply.github.com> Date: Tue, 7 May 2024 13:40:29 -0400 Subject: [PATCH 19/21] Update apiDefinition.swagger.json --- .../Perplexity AI/apiDefinition.swagger.json | 683 ++++++++++++------ 1 file changed, 475 insertions(+), 208 deletions(-) diff --git a/independent-publisher-connectors/Perplexity AI/apiDefinition.swagger.json b/independent-publisher-connectors/Perplexity AI/apiDefinition.swagger.json index c64749d4f4..d31a1cc762 100644 --- a/independent-publisher-connectors/Perplexity AI/apiDefinition.swagger.json +++ b/independent-publisher-connectors/Perplexity AI/apiDefinition.swagger.json @@ -1,17 +1,24 @@ { "swagger": "2.0", "info": { - "title": "Perplexity AI", - "description": "Unlock the most powerful AI research assistant. Raise Perplexity to the next level with more Copilot, upgraded AI, unlimited file upload, and web service access. Upgrade to Claude-2 or GPT-4 for more accurate answers, will pplx, Mistral, and Llama language models also available.", - "version": "1.0", + "title": "Mistral", + "description": "Mistral is open and portable generative AI for devs and businesses. Mistral models strike an unmatched latency to performance ratio, and achieve top-tier reasoning performance on all common benchmarks. Mistral designed the models to be as unbiased and useful as possible, providing full modular control over moderation.", + "version": "1.1", "contact": { "name": "Troy Taylor", "url": "https://www.hitachisolutions.com", "email": "ttaylor@hitachisolutions.com" - } + }, + "x-ms-keywords": [ + "Mistral", + "AI", + "chat", + "completions", + "embedding" + ] }, - "host": "api.perplexity.ai", - "basePath": "/", + "host": "api.mistral.ai", + "basePath": "/v1", "schemes": [ "https" ], @@ -24,229 +31,489 @@ "paths": { "/chat/completions": { "post": { + "summary": "Create chat completions", + "operationId": "CreateChatCompletion", + "parameters": [ + { + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ChatCompletionRequest" + } + } + ], "responses": { "200": { - "description": "default", + "description": "OK", "schema": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The identifier.", - "title": "ID" - }, - "model": { - "type": "string", - "description": "The model.", - "title": "Model" - }, - "object": { - "type": "string", - "description": "The object.", - "title": "Object" - }, - "created": { - "type": "integer", - "format": "int32", - "description": "When created.", - "title": "Created" - }, - "choices": { - "type": "array", - "items": { - "type": "object", - "properties": { - "index": { - "type": "integer", - "format": "int32", - "description": "The index.", - "title": "Index" - }, - "finish_reason": { - "type": "string", - "description": "The finish reason", - "title": "Finish Reason" - }, - "message": { - "type": "object", - "properties": { - "content": { - "type": "string", - "description": "The content.", - "title": "Content" - }, - "role": { - "type": "string", - "description": "The role.", - "title": "Role" - } - }, - "title": "Message" - }, - "delta": { - "type": "object", - "properties": { - "content": { - "type": "string", - "description": "The content.", - "title": "Content" - }, - "role": { - "type": "string", - "description": "The role.", - "title": "Role" - } - }, - "title": "Delta" - } - } - }, - "title": "Choices" - }, - "usage": { - "type": "object", - "properties": { - "prompt_tokens": { - "type": "integer", - "format": "int32", - "description": "The prompt tokens used.", - "title": "Prompt Tokens" - }, - "completion_tokens": { - "type": "integer", - "format": "int32", - "description": "The completion tokens used.", - "title": "Completion Tokens" - }, - "total_tokens": { - "type": "integer", - "format": "int32", - "description": "The total tokens used.", - "title": "Total Tokens" - } - }, - "title": "Usage" - } - } + "$ref": "#/definitions/ChatCompletionResponse" } } }, - "summary": "Get chat completion", + "description": "Creates a chat completion.", + "x-ms-openai-data": { + "openai-enabled": true, + "operations": [ + { + "operationId": "CreateChatCompletion", + "x-ms-require-user-confirmation": true + } + ] + } + } + }, + "/embeddings": { + "post": { + "summary": "Create embeddings", + "operationId": "CreateEmbedding", "parameters": [ { - "name": "body", "in": "body", - "required": false, + "name": "body", + "required": true, "schema": { - "type": "object", - "properties": { - "model": { - "type": "string", - "description": "The name of the model that will complete your prompt.", - "title": "Model", - "default": "mistral-7b-instruct", - "enum": [ - "mistral-7b-instruct", - "pplx-7b-chat", - "pplx-70b-chat", - "pplx-7b-online", - "pplx-70b-online", - "llama-2-70b-chat", - "codellama-34b-instruct" - ] - }, - "messages": { - "type": "array", - "items": { - "type": "object", - "properties": { - "role": { - "type": "string", - "description": "The role of the speaker in this turn of conversation. After the (optional) system message, user and assistant roles should alternate with user then assistant, ending in user.", - "title": "Role", - "default": "system", - "enum": [ - "system", - "user", - "assistant" - ] - }, - "content": { - "type": "string", - "description": "The contents of the message in this turn of conversation.", - "title": "Content" - } - }, - "required": [ - "content", - "role" - ] - }, - "description": "messages" - }, - "max_tokens": { - "type": "integer", - "format": "int32", - "description": "The maximum number of completion tokens returned by the API. The total number of tokens requested in max_tokens plus the number of prompt tokens sent in messages must not exceed the context window token limit of model requested. If left unspecified, then the model will generate tokens until either it reaches its stop token or the end of its context window.", - "title": "Max Tokens" - }, - "temperature": { - "type": "number", - "format": "double", - "description": "The amount of randomness in the response, valued between 0 inclusive and 2 exclusive. Higher values are more random, and lower values are more deterministic. You should either set temperature or top_p, but not both.", - "title": "Temperature" - }, - "top_p": { - "type": "number", - "format": "double", - "description": "The nucleus sampling threshold, valued between 0 and 1 inclusive. For each subsequent token, the model considers the results of the tokens with top_p probability mass. You should either alter temperature or top_p, but not both.", - "title": "Top P" - }, - "top_k": { - "type": "number", - "format": "double", - "description": "The number of tokens to keep for highest top-k filtering, specified as an integer between 0 and 2048 inclusive. If set to 0, top-k filtering is disabled.", - "title": "Top K" - }, - "presence_penalty": { - "type": "number", - "format": "double", - "description": "A value between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics. Incompatible with frequency penalty.", - "title": "Presence Penalty" - }, - "frequency_penalty": { - "type": "number", - "format": "double", - "description": "A multiplicative penalty greater than 0. Values greater than 1.0 penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim. A value of 1.0 means no penalty. Incompatible with presence penalty.", - "title": "Frequency Penalty" - } - }, - "required": [ - "model", - "messages" - ] + "$ref": "#/definitions/EmbeddingRequest" } } ], - "description": "Generates a model's response for the given chat conversation.", - "operationId": "CompletionPost", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/EmbeddingResponse" + } + } + }, + "description": "Creates an embedding.", "x-ms-openai-data": { "openai-enabled": true, "operations": [ { - "operationId": "CompletionPost", + "operationId": "CreateEmbedding", "x-ms-require-user-confirmation": true } ] } } + }, + "/models": { + "get": { + "summary": "List available models", + "operationId": "ListModels", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ModelList" + } + } + }, + "description": "Retrieve a list of available models.", + "x-ms-openai-data": { + "openai-enabled": true, + "operations": [ + { + "operationId": "ListModels", + "x-ms-require-user-confirmation": false + } + ] + } + } + } + }, + "definitions": { + "Error": { + "required": [ + "type", + "message", + "param", + "code" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type.", + "title": "Type" + }, + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "param": { + "type": "string", + "description": "The parameter.", + "title": "Parameter" + }, + "code": { + "type": "string", + "description": "The code.", + "title": "Code" + } + } + }, + "ErrorResponse": { + "required": [ + "error" + ], + "type": "object", + "properties": { + "error": { + "$ref": "#/definitions/Error" + } + } + }, + "ModelList": { + "required": [ + "object", + "data" + ], + "type": "object", + "properties": { + "object": { + "type": "string", + "description": "The object.", + "title": "Object" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/definitions/Model" + } + } + } + }, + "ChatCompletionRequest": { + "required": [ + "model", + "messages" + ], + "type": "object", + "properties": { + "model": { + "description": "ID of the model to use.", + "type": "string", + "title": "Model", + "x-ms-dynamic-values": { + "operationId": "ListModels", + "value-path": "id", + "value-collection": "data", + "value-title": "id" + } + }, + "messages": { + "description": "The prompt(s) to generate completions for, encoded as a list of dict with role and content. The first prompt role should be user or system.", + "type": "array", + "items": { + "type": "object", + "properties": { + "role": { + "enum": [ + "system", + "user", + "assistant", + "tool" + ], + "type": "string", + "description": "The role.", + "title": "Role", + "default": "user" + }, + "content": { + "type": "string", + "description": "The content.", + "title": "Content" + } + } + } + }, + "temperature": { + "description": "What sampling temperature to use, between 0.0 and 1.0. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. We generally recommend altering this or top_p but not both.", + "title": "Temperature", + "default": 0.7, + "maximum": 1, + "minimum": 0, + "type": "number" + }, + "top_p": { + "description": "Nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or temperature but not both.", + "title": "Top P", + "default": 1, + "maximum": 1, + "minimum": 0, + "type": "number" + }, + "max_tokens": { + "description": "The maximum number of tokens to generate in the completion. The token count of your prompt plus max_tokens cannot exceed the model's context length.", + "title": "Max Tokens", + "minimum": 0, + "type": "integer", + "format": "int32" + }, + "stream": { + "description": "Whether to stream back partial progress. If set, tokens will be sent as data-only server-sent events as they become available, with the stream terminated by a data: [DONE] message. Otherwise, the server will hold the request open until the timeout or until completion, with the response containing the full result as JSON.", + "title": "Stream", + "default": false, + "type": "boolean" + }, + "safe_prompt": { + "description": "Whether to inject a safety prompt before all conversations.", + "title": "Safe Prompt", + "default": false, + "type": "boolean" + }, + "random_seed": { + "description": "The seed to use for random sampling. If set, different calls will generate deterministic results.", + "title": "Random Seed", + "type": "integer", + "format": "int32" + } + } + }, + "ChatCompletionResponse": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "object": { + "type": "string", + "description": "The object.", + "title": "Object" + }, + "created": { + "type": "integer", + "format": "int32", + "description": "The created.", + "title": "Created" + }, + "model": { + "type": "string", + "description": "The model.", + "title": "Model" + }, + "choices": { + "type": "array", + "items": { + "required": [ + "index", + "message", + "finish_reason" + ], + "type": "object", + "properties": { + "index": { + "type": "integer", + "format": "int32", + "description": "The index.", + "title": "Index" + }, + "message": { + "type": "object", + "properties": { + "role": { + "enum": [ + "user", + "assistant" + ], + "type": "string", + "description": "The role.", + "title": "Role" + }, + "content": { + "type": "string", + "description": "The content.", + "title": "Content" + } + } + }, + "finish_reason": { + "enum": [ + "stop", + "length", + "model_length" + ], + "type": "string", + "description": "The finish reason.", + "title": "Finish Reason" + } + } + } + }, + "usage": { + "required": [ + "prompt_tokens", + "completion_tokens", + "total_tokens" + ], + "type": "object", + "properties": { + "prompt_tokens": { + "type": "integer", + "format": "int32", + "description": "The prompt tokens.", + "title": "Prompt Tokens" + }, + "completion_tokens": { + "type": "integer", + "format": "int32", + "description": "The completion tokens.", + "title": "Completion Tokens" + }, + "total_tokens": { + "type": "integer", + "format": "int32", + "description": "The total tokens.", + "title": "Total Tokens" + } + } + } + } + }, + "EmbeddingRequest": { + "type": "object", + "properties": { + "model": { + "description": "The ID of the model to use for this request.", + "type": "string", + "title": "model", + "default": "mistral-embed" + }, + "input": { + "description": "The list of strings to embed.", + "type": "array", + "title": "Input", + "items": { + "type": "string" + } + }, + "encoding_format": { + "description": "The format of the output data.", + "enum": [ + "float" + ], + "type": "string", + "title": "Encoding Format" + } + } + }, + "EmbeddingResponse": { + "required": [ + "id", + "object", + "data", + "model", + "usage" + ], + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "object": { + "type": "string", + "description": "The object.", + "title": "Object" + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "object": { + "type": "string", + "description": "The object.", + "title": "Object" + }, + "embedding": { + "type": "array", + "description": "The embedding.", + "title": "Embedding", + "items": { + "type": "number", + "format": "double" + } + }, + "index": { + "type": "integer", + "description": "The index.", + "title": "Index" + } + } + } + }, + "model": { + "type": "string", + "description": "The model.", + "title": "Model" + }, + "usage": { + "required": [ + "prompt_tokens", + "total_tokens" + ], + "type": "object", + "properties": { + "prompt_tokens": { + "type": "integer", + "format": "int32", + "description": "The prompt tokens.", + "title": "Prompt Tokens" + }, + "total_tokens": { + "type": "integer", + "format": "int32", + "description": "The total tokens.", + "title": "Total Tokens" + } + } + } + } + }, + "Model": { + "title": "Model", + "required": [ + "id", + "object", + "created", + "owned_by" + ], + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "object": { + "type": "string", + "description": "The object.", + "title": "Object" + }, + "created": { + "type": "integer", + "format": "int32", + "description": "The created.", + "title": "Created" + }, + "owned_by": { + "type": "string", + "description": "The owned by.", + "title": "Owned By" + } + } } }, - "definitions": {}, "parameters": {}, "responses": {}, "securityDefinitions": { - "API Key (in the form 'Bearer YOUR_API_KEY')": { + "API Key": { "type": "apiKey", "in": "header", "name": "Authorization" @@ -254,27 +521,27 @@ }, "security": [ { - "API Key (in the form 'Bearer YOUR_API_KEY')": [] + "API Key": [] } ], "tags": [], "x-ms-openai-manifest": { - "humanName": "Perplexity AI", - "modelDescription": "This is a Copilot plugin for Perplexity AI to retrieve chat completions.", + "humanName": "Mistral", + "modelDescription": "This is a Copilot plugin for the Mistral AI service.", "contactEmail": "ttaylor@hitachisolutions.com" }, "x-ms-connector-metadata": [ { "propertyName": "Website", - "propertyValue": "https://www.perplexity.ai/" + "propertyValue": "https://mistral.ai/" }, { "propertyName": "Privacy policy", - "propertyValue": "https://blog.perplexity.ai/legal/privacy-policy" + "propertyValue": "https://mistral.ai/terms#privacy-policy" }, { "propertyName": "Categories", "propertyValue": "AI" } ] -} \ No newline at end of file +} From 255433862b14a2462cf4d39665b24b49717d316f Mon Sep 17 00:00:00 2001 From: Troy Taylor Date: Tue, 7 May 2024 13:44:13 -0400 Subject: [PATCH 20/21] Revert "Update apiDefinition.swagger.json" This reverts commit 4c02cc0b238a7af4f16b36eaa6f48b047f9a1e97. --- .../Perplexity AI/apiDefinition.swagger.json | 683 ++++++------------ 1 file changed, 208 insertions(+), 475 deletions(-) diff --git a/independent-publisher-connectors/Perplexity AI/apiDefinition.swagger.json b/independent-publisher-connectors/Perplexity AI/apiDefinition.swagger.json index d31a1cc762..c64749d4f4 100644 --- a/independent-publisher-connectors/Perplexity AI/apiDefinition.swagger.json +++ b/independent-publisher-connectors/Perplexity AI/apiDefinition.swagger.json @@ -1,24 +1,17 @@ { "swagger": "2.0", "info": { - "title": "Mistral", - "description": "Mistral is open and portable generative AI for devs and businesses. Mistral models strike an unmatched latency to performance ratio, and achieve top-tier reasoning performance on all common benchmarks. Mistral designed the models to be as unbiased and useful as possible, providing full modular control over moderation.", - "version": "1.1", + "title": "Perplexity AI", + "description": "Unlock the most powerful AI research assistant. Raise Perplexity to the next level with more Copilot, upgraded AI, unlimited file upload, and web service access. Upgrade to Claude-2 or GPT-4 for more accurate answers, will pplx, Mistral, and Llama language models also available.", + "version": "1.0", "contact": { "name": "Troy Taylor", "url": "https://www.hitachisolutions.com", "email": "ttaylor@hitachisolutions.com" - }, - "x-ms-keywords": [ - "Mistral", - "AI", - "chat", - "completions", - "embedding" - ] + } }, - "host": "api.mistral.ai", - "basePath": "/v1", + "host": "api.perplexity.ai", + "basePath": "/", "schemes": [ "https" ], @@ -31,489 +24,229 @@ "paths": { "/chat/completions": { "post": { - "summary": "Create chat completions", - "operationId": "CreateChatCompletion", - "parameters": [ - { - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ChatCompletionRequest" - } - } - ], "responses": { "200": { - "description": "OK", + "description": "default", "schema": { - "$ref": "#/definitions/ChatCompletionResponse" + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "model": { + "type": "string", + "description": "The model.", + "title": "Model" + }, + "object": { + "type": "string", + "description": "The object.", + "title": "Object" + }, + "created": { + "type": "integer", + "format": "int32", + "description": "When created.", + "title": "Created" + }, + "choices": { + "type": "array", + "items": { + "type": "object", + "properties": { + "index": { + "type": "integer", + "format": "int32", + "description": "The index.", + "title": "Index" + }, + "finish_reason": { + "type": "string", + "description": "The finish reason", + "title": "Finish Reason" + }, + "message": { + "type": "object", + "properties": { + "content": { + "type": "string", + "description": "The content.", + "title": "Content" + }, + "role": { + "type": "string", + "description": "The role.", + "title": "Role" + } + }, + "title": "Message" + }, + "delta": { + "type": "object", + "properties": { + "content": { + "type": "string", + "description": "The content.", + "title": "Content" + }, + "role": { + "type": "string", + "description": "The role.", + "title": "Role" + } + }, + "title": "Delta" + } + } + }, + "title": "Choices" + }, + "usage": { + "type": "object", + "properties": { + "prompt_tokens": { + "type": "integer", + "format": "int32", + "description": "The prompt tokens used.", + "title": "Prompt Tokens" + }, + "completion_tokens": { + "type": "integer", + "format": "int32", + "description": "The completion tokens used.", + "title": "Completion Tokens" + }, + "total_tokens": { + "type": "integer", + "format": "int32", + "description": "The total tokens used.", + "title": "Total Tokens" + } + }, + "title": "Usage" + } + } } } }, - "description": "Creates a chat completion.", - "x-ms-openai-data": { - "openai-enabled": true, - "operations": [ - { - "operationId": "CreateChatCompletion", - "x-ms-require-user-confirmation": true - } - ] - } - } - }, - "/embeddings": { - "post": { - "summary": "Create embeddings", - "operationId": "CreateEmbedding", + "summary": "Get chat completion", "parameters": [ { - "in": "body", "name": "body", - "required": true, + "in": "body", + "required": false, "schema": { - "$ref": "#/definitions/EmbeddingRequest" + "type": "object", + "properties": { + "model": { + "type": "string", + "description": "The name of the model that will complete your prompt.", + "title": "Model", + "default": "mistral-7b-instruct", + "enum": [ + "mistral-7b-instruct", + "pplx-7b-chat", + "pplx-70b-chat", + "pplx-7b-online", + "pplx-70b-online", + "llama-2-70b-chat", + "codellama-34b-instruct" + ] + }, + "messages": { + "type": "array", + "items": { + "type": "object", + "properties": { + "role": { + "type": "string", + "description": "The role of the speaker in this turn of conversation. After the (optional) system message, user and assistant roles should alternate with user then assistant, ending in user.", + "title": "Role", + "default": "system", + "enum": [ + "system", + "user", + "assistant" + ] + }, + "content": { + "type": "string", + "description": "The contents of the message in this turn of conversation.", + "title": "Content" + } + }, + "required": [ + "content", + "role" + ] + }, + "description": "messages" + }, + "max_tokens": { + "type": "integer", + "format": "int32", + "description": "The maximum number of completion tokens returned by the API. The total number of tokens requested in max_tokens plus the number of prompt tokens sent in messages must not exceed the context window token limit of model requested. If left unspecified, then the model will generate tokens until either it reaches its stop token or the end of its context window.", + "title": "Max Tokens" + }, + "temperature": { + "type": "number", + "format": "double", + "description": "The amount of randomness in the response, valued between 0 inclusive and 2 exclusive. Higher values are more random, and lower values are more deterministic. You should either set temperature or top_p, but not both.", + "title": "Temperature" + }, + "top_p": { + "type": "number", + "format": "double", + "description": "The nucleus sampling threshold, valued between 0 and 1 inclusive. For each subsequent token, the model considers the results of the tokens with top_p probability mass. You should either alter temperature or top_p, but not both.", + "title": "Top P" + }, + "top_k": { + "type": "number", + "format": "double", + "description": "The number of tokens to keep for highest top-k filtering, specified as an integer between 0 and 2048 inclusive. If set to 0, top-k filtering is disabled.", + "title": "Top K" + }, + "presence_penalty": { + "type": "number", + "format": "double", + "description": "A value between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics. Incompatible with frequency penalty.", + "title": "Presence Penalty" + }, + "frequency_penalty": { + "type": "number", + "format": "double", + "description": "A multiplicative penalty greater than 0. Values greater than 1.0 penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim. A value of 1.0 means no penalty. Incompatible with presence penalty.", + "title": "Frequency Penalty" + } + }, + "required": [ + "model", + "messages" + ] } } ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/EmbeddingResponse" - } - } - }, - "description": "Creates an embedding.", + "description": "Generates a model's response for the given chat conversation.", + "operationId": "CompletionPost", "x-ms-openai-data": { "openai-enabled": true, "operations": [ { - "operationId": "CreateEmbedding", + "operationId": "CompletionPost", "x-ms-require-user-confirmation": true } ] } } - }, - "/models": { - "get": { - "summary": "List available models", - "operationId": "ListModels", - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ModelList" - } - } - }, - "description": "Retrieve a list of available models.", - "x-ms-openai-data": { - "openai-enabled": true, - "operations": [ - { - "operationId": "ListModels", - "x-ms-require-user-confirmation": false - } - ] - } - } - } - }, - "definitions": { - "Error": { - "required": [ - "type", - "message", - "param", - "code" - ], - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type.", - "title": "Type" - }, - "message": { - "type": "string", - "description": "The message.", - "title": "Message" - }, - "param": { - "type": "string", - "description": "The parameter.", - "title": "Parameter" - }, - "code": { - "type": "string", - "description": "The code.", - "title": "Code" - } - } - }, - "ErrorResponse": { - "required": [ - "error" - ], - "type": "object", - "properties": { - "error": { - "$ref": "#/definitions/Error" - } - } - }, - "ModelList": { - "required": [ - "object", - "data" - ], - "type": "object", - "properties": { - "object": { - "type": "string", - "description": "The object.", - "title": "Object" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/definitions/Model" - } - } - } - }, - "ChatCompletionRequest": { - "required": [ - "model", - "messages" - ], - "type": "object", - "properties": { - "model": { - "description": "ID of the model to use.", - "type": "string", - "title": "Model", - "x-ms-dynamic-values": { - "operationId": "ListModels", - "value-path": "id", - "value-collection": "data", - "value-title": "id" - } - }, - "messages": { - "description": "The prompt(s) to generate completions for, encoded as a list of dict with role and content. The first prompt role should be user or system.", - "type": "array", - "items": { - "type": "object", - "properties": { - "role": { - "enum": [ - "system", - "user", - "assistant", - "tool" - ], - "type": "string", - "description": "The role.", - "title": "Role", - "default": "user" - }, - "content": { - "type": "string", - "description": "The content.", - "title": "Content" - } - } - } - }, - "temperature": { - "description": "What sampling temperature to use, between 0.0 and 1.0. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. We generally recommend altering this or top_p but not both.", - "title": "Temperature", - "default": 0.7, - "maximum": 1, - "minimum": 0, - "type": "number" - }, - "top_p": { - "description": "Nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or temperature but not both.", - "title": "Top P", - "default": 1, - "maximum": 1, - "minimum": 0, - "type": "number" - }, - "max_tokens": { - "description": "The maximum number of tokens to generate in the completion. The token count of your prompt plus max_tokens cannot exceed the model's context length.", - "title": "Max Tokens", - "minimum": 0, - "type": "integer", - "format": "int32" - }, - "stream": { - "description": "Whether to stream back partial progress. If set, tokens will be sent as data-only server-sent events as they become available, with the stream terminated by a data: [DONE] message. Otherwise, the server will hold the request open until the timeout or until completion, with the response containing the full result as JSON.", - "title": "Stream", - "default": false, - "type": "boolean" - }, - "safe_prompt": { - "description": "Whether to inject a safety prompt before all conversations.", - "title": "Safe Prompt", - "default": false, - "type": "boolean" - }, - "random_seed": { - "description": "The seed to use for random sampling. If set, different calls will generate deterministic results.", - "title": "Random Seed", - "type": "integer", - "format": "int32" - } - } - }, - "ChatCompletionResponse": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The identifier.", - "title": "ID" - }, - "object": { - "type": "string", - "description": "The object.", - "title": "Object" - }, - "created": { - "type": "integer", - "format": "int32", - "description": "The created.", - "title": "Created" - }, - "model": { - "type": "string", - "description": "The model.", - "title": "Model" - }, - "choices": { - "type": "array", - "items": { - "required": [ - "index", - "message", - "finish_reason" - ], - "type": "object", - "properties": { - "index": { - "type": "integer", - "format": "int32", - "description": "The index.", - "title": "Index" - }, - "message": { - "type": "object", - "properties": { - "role": { - "enum": [ - "user", - "assistant" - ], - "type": "string", - "description": "The role.", - "title": "Role" - }, - "content": { - "type": "string", - "description": "The content.", - "title": "Content" - } - } - }, - "finish_reason": { - "enum": [ - "stop", - "length", - "model_length" - ], - "type": "string", - "description": "The finish reason.", - "title": "Finish Reason" - } - } - } - }, - "usage": { - "required": [ - "prompt_tokens", - "completion_tokens", - "total_tokens" - ], - "type": "object", - "properties": { - "prompt_tokens": { - "type": "integer", - "format": "int32", - "description": "The prompt tokens.", - "title": "Prompt Tokens" - }, - "completion_tokens": { - "type": "integer", - "format": "int32", - "description": "The completion tokens.", - "title": "Completion Tokens" - }, - "total_tokens": { - "type": "integer", - "format": "int32", - "description": "The total tokens.", - "title": "Total Tokens" - } - } - } - } - }, - "EmbeddingRequest": { - "type": "object", - "properties": { - "model": { - "description": "The ID of the model to use for this request.", - "type": "string", - "title": "model", - "default": "mistral-embed" - }, - "input": { - "description": "The list of strings to embed.", - "type": "array", - "title": "Input", - "items": { - "type": "string" - } - }, - "encoding_format": { - "description": "The format of the output data.", - "enum": [ - "float" - ], - "type": "string", - "title": "Encoding Format" - } - } - }, - "EmbeddingResponse": { - "required": [ - "id", - "object", - "data", - "model", - "usage" - ], - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The identifier.", - "title": "ID" - }, - "object": { - "type": "string", - "description": "The object.", - "title": "Object" - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "object": { - "type": "string", - "description": "The object.", - "title": "Object" - }, - "embedding": { - "type": "array", - "description": "The embedding.", - "title": "Embedding", - "items": { - "type": "number", - "format": "double" - } - }, - "index": { - "type": "integer", - "description": "The index.", - "title": "Index" - } - } - } - }, - "model": { - "type": "string", - "description": "The model.", - "title": "Model" - }, - "usage": { - "required": [ - "prompt_tokens", - "total_tokens" - ], - "type": "object", - "properties": { - "prompt_tokens": { - "type": "integer", - "format": "int32", - "description": "The prompt tokens.", - "title": "Prompt Tokens" - }, - "total_tokens": { - "type": "integer", - "format": "int32", - "description": "The total tokens.", - "title": "Total Tokens" - } - } - } - } - }, - "Model": { - "title": "Model", - "required": [ - "id", - "object", - "created", - "owned_by" - ], - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The identifier.", - "title": "ID" - }, - "object": { - "type": "string", - "description": "The object.", - "title": "Object" - }, - "created": { - "type": "integer", - "format": "int32", - "description": "The created.", - "title": "Created" - }, - "owned_by": { - "type": "string", - "description": "The owned by.", - "title": "Owned By" - } - } } }, + "definitions": {}, "parameters": {}, "responses": {}, "securityDefinitions": { - "API Key": { + "API Key (in the form 'Bearer YOUR_API_KEY')": { "type": "apiKey", "in": "header", "name": "Authorization" @@ -521,27 +254,27 @@ }, "security": [ { - "API Key": [] + "API Key (in the form 'Bearer YOUR_API_KEY')": [] } ], "tags": [], "x-ms-openai-manifest": { - "humanName": "Mistral", - "modelDescription": "This is a Copilot plugin for the Mistral AI service.", + "humanName": "Perplexity AI", + "modelDescription": "This is a Copilot plugin for Perplexity AI to retrieve chat completions.", "contactEmail": "ttaylor@hitachisolutions.com" }, "x-ms-connector-metadata": [ { "propertyName": "Website", - "propertyValue": "https://mistral.ai/" + "propertyValue": "https://www.perplexity.ai/" }, { "propertyName": "Privacy policy", - "propertyValue": "https://mistral.ai/terms#privacy-policy" + "propertyValue": "https://blog.perplexity.ai/legal/privacy-policy" }, { "propertyName": "Categories", "propertyValue": "AI" } ] -} +} \ No newline at end of file From 6d9f8a75b66bd92ce4c233522d7fd6283035fe18 Mon Sep 17 00:00:00 2001 From: Troy Taylor <44444967+troystaylor@users.noreply.github.com> Date: Tue, 7 May 2024 13:50:32 -0400 Subject: [PATCH 21/21] Update apiDefinition.swagger.json --- .../Perplexity AI/apiDefinition.swagger.json | 23 +++++++++++-------- 1 file changed, 14 insertions(+), 9 deletions(-) diff --git a/independent-publisher-connectors/Perplexity AI/apiDefinition.swagger.json b/independent-publisher-connectors/Perplexity AI/apiDefinition.swagger.json index c64749d4f4..737274f5b6 100644 --- a/independent-publisher-connectors/Perplexity AI/apiDefinition.swagger.json +++ b/independent-publisher-connectors/Perplexity AI/apiDefinition.swagger.json @@ -3,12 +3,17 @@ "info": { "title": "Perplexity AI", "description": "Unlock the most powerful AI research assistant. Raise Perplexity to the next level with more Copilot, upgraded AI, unlimited file upload, and web service access. Upgrade to Claude-2 or GPT-4 for more accurate answers, will pplx, Mistral, and Llama language models also available.", - "version": "1.0", + "version": "1.1", "contact": { "name": "Troy Taylor", "url": "https://www.hitachisolutions.com", "email": "ttaylor@hitachisolutions.com" - } + }, + "x-ms-keywords": [ + "Perplexity", + "AI", + "completion" + ] }, "host": "api.perplexity.ai", "basePath": "/", @@ -147,12 +152,12 @@ "default": "mistral-7b-instruct", "enum": [ "mistral-7b-instruct", - "pplx-7b-chat", - "pplx-70b-chat", - "pplx-7b-online", - "pplx-70b-online", - "llama-2-70b-chat", - "codellama-34b-instruct" + "sonar-small-chat", + "sonar-small-online", + "sonar-medium-chat", + "sonar-medium-online", + "mistral-7b-instruct", + "mixtral-8x7b-instruct" ] }, "messages": { @@ -277,4 +282,4 @@ "propertyValue": "AI" } ] -} \ No newline at end of file +}