Skip to content

Instantly share code, notes, and snippets.

@raphaelcosta

raphaelcosta/teste

Created September 11, 2017 23:24
Show Gist options
  • Save raphaelcosta/67a4a50b3792bb72dda02ea177911d61 to your computer and use it in GitHub Desktop.
Save raphaelcosta/67a4a50b3792bb72dda02ea177911d61 to your computer and use it in GitHub Desktop.
Download ZIP
Teste
Raw
teste
{
"swagger": "2.0",
"info": {
"version": "1.0",
"title": "Pipefy API",
"description": "TODO: Add a description",
"license": {
"name": "MIT",
"url": "http://github.com/gruntjs/grunt/blob/master/LICENSE-MIT"
}
},
"host": "app.pipefy.com",
"basePath": "/",
"securityDefinitions": {
"auth": {
"type": "oauth2",
"flow": "implicit",
"authorizationUrl": "https://app.pipefy.com",
"scopes": {}
}
},
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"paths": {
"/queries": {
"post": {
"description": "Mutation to delete a webhook, in case of success `success: true` is returned.\n**Request Body**\n```\nmutation{\n deleteWebhook(input:{id: 206}) {\n success\n }\n}\n```",
"summary": "deleteWebhook(input: {webhook_id})",
"operationId": "deleteWebhook(input: {webhook_id})",
"produces": [
"application/json"
],
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/Deletewebhook(input: {webhookId}) request"
}
},
{
"name": "delete_webhook",
"in": "query",
"required": false,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/Deletewebhook(input: {webhookId}) response"
},
"examples": {
"application/json": {
"data": {
"deleteWebhook": {
"success": true
}
}
}
}
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/queries",
"headers": {
"Content-Type": "application/json"
},
"body": "{ \"query\": \"mutation { deleteWebhook(input: { id: 206 }) { success } }\"}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "RAW",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {
"Content-Type": "application/json; charset=utf-8"
},
"body": "{ \"data\": { \"deleteWebhook\": { \"success\": true } }}"
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "deleteWebhook(input: {webhook_id})1",
"x-testDescription": "Mutation to delete a webhook, in case of success `success: true` is returned.\n**Request Body**\n```\nmutation{\n deleteWebhook(input:{id: 206}) {\n success\n }\n}\n```"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
}
},
"definitions": {
"GetMeRequest": {
"title": "Get Me request",
"example": {
"query": "{ me { id name username email avatar_url created_at locale time_zone } }"
},
"type": "object",
"properties": {
"query": {
"description": "",
"type": "string"
}
},
"required": [
"query"
]
},
"GetMeResponse": {
"title": "Get Me response",
"example": {
"data": {
"me": {
"id": "68310",
"name": "Claudio Furini Jr.",
"username": "claudio.furini",
"email": "[email protected]",
"avatarUrl": "https://pipefy-production.s3-sa-east-1.amazonaws.com/avatar/store/user/68310/avatar/small-4b39bc357029daaba28f0691b28e96a5.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAJ6QQUS4NUNAOO6IA%2F20170821%2Fsa-east-1%2Fs3%2Faws4_request&X-Amz-Date=20170821T004712Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=31d200c15d62b74d27559a2ccb90398eaf404f3d92e4bed79ab1efa3cb17bd6f",
"created_at": "2017-02-06 10:49:01 -0200",
"locale": "pt-BR",
"timeZone": "America/Sao_Paulo"
}
}
},
"type": "object",
"properties": {
"data": {
"description": "",
"type": "object"
}
},
"required": [
"data"
]
},
"Organization(ids: [organizationIds]) request": {
"title": "organization(ids: [organization_ids]) request",
"example": {
"query": "{ organizations(ids: [65386, 67595]) { name created_at members { user { id name } role_name } only_admin_can_create_pipes only_admin_can_invite_users automations { id } pipes { id name } tables { edges { node { id name } } } } }"
},
"type": "object",
"properties": {
"query": {
"description": "",
"type": "string"
}
},
"required": [
"query"
]
},
"Organization(ids: [organizationIds]) response": {
"title": "organization(ids: [organization_ids]) response",
"example": {
"data": {
"organizations": [
{
"name": "Pipefy Organization 1",
"created_at": "2017-06-26T19:00:42+00:00",
"members": [
{
"user": {
"id": "91670",
"name": "Peter"
},
"role_name": "normal"
},
{
"user": {
"id": "87021",
"name": "Napoleon"
},
"role_name": "normal"
},
{
"user": {
"id": "83956",
"name": "David"
},
"role_name": "admin"
},
{
"user": {
"id": "68310",
"name": "Claudio Furini"
},
"role_name": "admin"
},
{
"user": {
"id": "77303",
"name": "Pedro"
},
"role_name": "normal"
}
],
"only_admin_can_create_pipes": false,
"only_admin_can_invite_users": true,
"automations": [
{
"id": "2468"
}
],
"pipes": [
{
"id": "211269",
"name": "Pipe 1"
},
{
"id": "211270",
"name": "Pipe 2"
},
{
"id": "219739",
"name": "Secret Project"
},
{
"id": "241213",
"name": "General"
},
{
"id": "243585",
"name": "Simple To-do List"
},
{
"id": "243587",
"name": "Sales Pipeline"
}
],
"tables": {
"edges": [
{
"node": {
"id": "12I_mAHB",
"name": "Companys"
}
},
{
"node": {
"id": "V4MT9cgD",
"name": "Table 1"
}
},
{
"node": {
"id": "InQQ7HK6",
"name": "Cities"
}
}
]
}
},
{
"name": "Pipefy Organization 2",
"created_at": "2017-07-14T18:47:18+00:00",
"members": [
{
"user": {
"id": "68310",
"name": "Claudio Furini Jr."
},
"role_name": "admin"
}
],
"only_admin_can_create_pipes": false,
"only_admin_can_invite_users": false,
"automations": [
{
"id": "2068"
},
{
"id": "2093"
},
{
"id": "2066"
}
],
"pipes": [
{
"id": "235094",
"name": "Vacation Requests"
},
{
"id": "235095",
"name": "HR"
}
],
"tables": {
"edges": []
}
}
]
}
},
"type": "object",
"properties": {
"data": {
"description": "",
"type": "object"
}
},
"required": [
"data"
]
},
"Organization(id: organizationId) request": {
"title": "organization(id: organization_id) request",
"example": {
"query": "{ organization(id: 65386){ name created_at members { user { id name } role_name } only_admin_can_create_pipes only_admin_can_invite_users automations { id } pipes { id name } tables { edges { node { id name } } } } }"
},
"type": "object",
"properties": {
"query": {
"description": "",
"type": "string"
}
},
"required": [
"query"
]
},
"Organization(id: organizationId) response": {
"title": "organization(id: organization_id) response",
"example": {
"data": {
"organization": {
"name": "Pipefy Support ",
"created_at": "2017-06-26T19:00:42+00:00",
"members": [
{
"user": {
"id": "77303",
"name": "Peter"
},
"role_name": "normal"
},
{
"user": {
"id": "87021",
"name": "Napoleon"
},
"role_name": "normal"
},
{
"user": {
"id": "68310",
"name": "Claudio Furini Jr."
},
"role_name": "admin"
}
],
"only_admin_can_create_pipes": false,
"only_admin_can_invite_users": true,
"automations": [
{
"id": "2468"
}
],
"pipes": [
{
"id": "211269",
"name": "Pipe 1"
},
{
"id": "211270",
"name": "Pipe 2"
},
{
"id": "219739",
"name": "Secret Project"
},
{
"id": "241213",
"name": "General"
},
{
"id": "243585",
"name": "Simple To-do List"
},
{
"id": "243587",
"name": "Sales Pipeline"
}
],
"tables": {
"edges": [
{
"node": {
"id": "12I_mAHB",
"name": "Company"
}
},
{
"node": {
"id": "V4MT9cgD",
"name": "Table 2"
}
},
{
"node": {
"id": "InQQ7HK6",
"name": "Cities"
}
}
]
}
}
}
},
"type": "object",
"properties": {
"data": {
"description": "",
"type": "object"
}
},
"required": [
"data"
]
},
"Createorganization(input:{params})Request": {
"title": "createOrganization(input: {params}) request",
"example": {
"query": "mutation { createOrganization(input: {industry: \"technology\", name: \"Oscorp\" }) { organization{ id, name } } }"
},
"type": "object",
"properties": {
"query": {
"description": "",
"type": "string"
}
},
"required": [
"query"
]
},
"Createorganization(input:{params})Response": {
"title": "createOrganization(input: {params}) response",
"example": {
"data": {
"createOrganization": {
"organization": {
"id": "73659",
"name": "Oscorp"
}
}
}
},
"type": "object",
"properties": {
"data": {
"description": "",
"type": "object"
}
},
"required": [
"data"
]
},
"Updateorganization(input:{params})Request": {
"title": "updateOrganization(input: {params}) request",
"example": {
"query": "mutation{ updateOrganization(input: {id: 73659 name: \"Capsule Corp.\" only_admin_can_invite_users: true only_admin_can_create_pipes: false force_omniauth_to_normal_users: true }) { organization { id name } } }"
},
"type": "object",
"properties": {
"query": {
"description": "",
"type": "string"
}
},
"required": [
"query"
]
},
"Updateorganization(input:{params})Response": {
"title": "updateOrganization(input: {params}) response",
"example": {
"data": {
"updateOrganization": {
"organization": {
"id": "73659",
"name": "Capsule Corp."
}
}
}
},
"type": "object",
"properties": {
"data": {
"description": "",
"type": "object"
}
},
"required": [
"data"
]
},
"Deleteorganization(input: {organizationId}) request": {
"title": "deleteOrganization(input: {organization_id}) request",
"example": {
"query": "mutation { deleteOrganization(input: {id: 73659}) { success } }"
},
"type": "object",
"properties": {
"query": {
"description": "",
"type": "string"
}
},
"required": [
"query"
]
},
"Deleteorganization(input: {organizationId}) response": {
"title": "deleteOrganization(input: {organization_id}) response",
"example": {
"data": {
"deleteOrganization": {
"success": true
}
}
},
"type": "object",
"properties": {
"data": {
"description": "",
"type": "object"
}
},
"required": [
"data"
]
},
"Createwebhook(input:{params})Request": {
"title": "createWebhook(input: {params}) request",
"example": {
"query": "mutation { createWebhook(input: { pipe_id: 219739 name: \"New Webhook\" email: \"[email protected]\" url: \"www.myurl.com/queries\" actions: [\"card.create\", \"card.done\"] headers: \"{\\\"foo\\\": \\\"bar\\\"}\" }) { webhook { id name } } }"
},
"type": "object",
"properties": {
"query": {
"description": "",
"type": "string"
}
},
"required": [
"query"
]
},
"Createwebhook(input:{params})Response": {
"title": "createWebhook(input: {params}) response",
"example": {
"data": {
"createWebhook": {
"webhook": {
"id": "206",
"name": "New Webhook"
}
}
}
},
"type": "object",
"properties": {
"data": {
"description": "",
"type": "object"
}
},
"required": [
"data"
]
},
"Updatewebhook(input:{params})Request": {
"title": "updateWebhook(input: {params}) request",
"example": {
"query": "mutation { updateWebhook(input: { id: 206 email: \"[email protected]\" actions: [\"card.create\", \"card.move\"]}) { webhook { id email actions } } }"
},
"type": "object",
"properties": {
"query": {
"description": "",
"type": "string"
}
},
"required": [
"query"
]
},
"Updatewebhook(input:{params})Response": {
"title": "updateWebhook(input: {params}) response",
"example": {
"data": {
"updateWebhook": {
"webhook": {
"id": "206",
"email": "[email protected]",
"actions": [
"card.create",
"card.move"
]
}
}
}
},
"type": "object",
"properties": {
"data": {
"description": "",
"type": "object"
}
},
"required": [
"data"
]
},
"Deletewebhook(input: {webhookId}) request": {
"title": "deleteWebhook(input: {webhook_id}) request",
"example": {
"query": "mutation { deleteWebhook(input: { id: 206 }) { success } }"
},
"type": "object",
"properties": {
"query": {
"description": "",
"type": "string"
}
},
"required": [
"query"
]
},
"Deletewebhook(input: {webhookId}) response": {
"title": "deleteWebhook(input: {webhook_id}) response",
"example": {
"data": {
"deleteWebhook": {
"success": true
}
}
},
"type": "object",
"properties": {
"data": {
"description": "",
"type": "object"
}
},
"required": [
"data"
]
}
}
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment