{"openapi":"3.0.1","info":{"title":"meta","version":"1.2.0.2337"},"servers":[{"url":"https://api.pushpay.com/"}],"paths":{"/swagger":{"get":{"tags":["meta"],"summary":"Retrieves a list of all swaggger resources exposed in the Pushpay API","operationId":"getSwaggerResourceList","responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceListing"}}}},"400":{"description":"The server will not process the request due to a client error","content":{}},"429":{"description":"Request was throttled due to too many requests from this client or IP address","content":{}}}}},"/swagger/{resourceName}":{"get":{"tags":["meta"],"summary":"Retrieves details of a swagger resource (this will return the list of API operations that exist for this resource)","operationId":"getSwaggerResource","parameters":[{"name":"resourceName","in":"path","description":"The name of the resource to fetch the swagger API declaration for","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiDeclaration"}}}},"400":{"description":"The server will not process the request due to a client error","content":{}},"404":{"description":"Could not find resource","content":{}},"429":{"description":"Request was throttled due to too many requests from this client or IP address","content":{}}}}}},"components":{"schemas":{"ApiDeclaration":{"required":["apiVersion","apis","basePath","models","resourcePath","swaggerVersion"],"type":"object","properties":{"swaggerVersion":{"type":"string"},"apiVersion":{"type":"string"},"basePath":{"type":"string"},"resourcePath":{"type":"string"},"apis":{"type":"array","items":{"$ref":"#/components/schemas/Api"}},"models":{"type":"object","properties":{}},"produces":{"type":"array","items":{"type":"string"}},"consumes":{"type":"array","items":{"type":"string"}}}},"Authorizations":{"required":["oauth2"],"type":"object","properties":{"oauth2":{"$ref":"#/components/schemas/OAuth2Authorization"}}},"ExampleParameter":{"required":["key","value"],"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"parameterType":{"type":"string"},"description":{"type":"string"}}},"ExampleRequest":{"required":["headers","httpMethod","parameters","url"],"type":"object","properties":{"parameters":{"type":"array","items":{"$ref":"#/components/schemas/ExampleParameter"}},"headers":{"type":"array","items":{"$ref":"#/components/schemas/ExampleParameter"}},"url":{"type":"string"},"requestBody":{"type":"string"},"httpMethod":{"type":"string"}}},"LoginEndpoint":{"required":["url"],"type":"object","properties":{"url":{"type":"object","properties":{}}}},"ExampleResponseStatus":{"required":["code","description"],"type":"object","properties":{"code":{"type":"integer"},"description":{"type":"string"}}},"Resource":{"required":["description","path"],"type":"object","properties":{"path":{"type":"string"},"description":{"type":"string"}}},"OAuth2Authorization":{"required":["grantTypes","scopes","type"],"type":"object","properties":{"type":{"type":"string"},"scopes":{"type":"array","items":{"$ref":"#/components/schemas/OAuth2Scope"}},"grantTypes":{"$ref":"#/components/schemas/GrantTypes"}}},"Operation":{"required":["method","nickname","parameters","responseMessages","summary","type"],"type":"object","properties":{"method":{"type":"string"},"nickname":{"type":"string"},"summary":{"type":"string"},"notes":{"type":"string"},"type":{"type":"string"},"format":{"type":"string"},"items":{"$ref":"#/components/schemas/DataType"},"enum":{"type":"array","items":{"type":"string"}},"parameters":{"type":"array","items":{"$ref":"#/components/schemas/Parameter"}},"responseMessages":{"type":"array","items":{"$ref":"#/components/schemas/ResponseMessage"}},"produces":{"type":"array","items":{"type":"string"}},"consumes":{"type":"array","items":{"type":"string"}},"authorizations":{"$ref":"#/components/schemas/OperationAuthorizations"},"examples":{"type":"array","items":{"$ref":"#/components/schemas/Example"}},"title":{"type":"string"}}},"ResponseMessage":{"required":["code","message"],"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"}}},"ImplicitGrantType":{"required":["loginEndpoint","tokenName"],"type":"object","properties":{"loginEndpoint":{"$ref":"#/components/schemas/LoginEndpoint"},"tokenName":{"type":"string"}}},"OperationAuthorizations":{"type":"object","properties":{"oauth2":{"type":"array","items":{"$ref":"#/components/schemas/OAuth2Scope"}}}},"TokenEndpoint":{"required":["tokenName","url"],"type":"object","properties":{"url":{"type":"object","properties":{}},"tokenName":{"type":"string"}}},"ResourceListing":{"required":["apiVersion","apis","authorizations","swaggerVersion"],"type":"object","properties":{"swaggerVersion":{"type":"string"},"apiVersion":{"type":"string"},"apis":{"type":"array","items":{"$ref":"#/components/schemas/Resource"}},"authorizations":{"$ref":"#/components/schemas/Authorizations"}}},"ExampleResponse":{"required":["headers","isErrorResponse","responseBody","status"],"type":"object","properties":{"responseBody":{"type":"string"},"headers":{"type":"array","items":{"$ref":"#/components/schemas/ExampleParameter"}},"status":{"$ref":"#/components/schemas/ExampleResponseStatus"},"isErrorResponse":{"type":"boolean"}}},"Example":{"required":["description","request","response","title"],"type":"object","properties":{"description":{"type":"string"},"title":{"type":"string"},"request":{"$ref":"#/components/schemas/ExampleRequest"},"response":{"$ref":"#/components/schemas/ExampleResponse"}}},"AuthorizationCodeGrantType":{"required":["tokenEndpoint","tokenRequestEndpoint"],"type":"object","properties":{"tokenRequestEndpoint":{"$ref":"#/components/schemas/TokenRequestEndpoint"},"tokenEndpoint":{"$ref":"#/components/schemas/TokenEndpoint"}}},"DataType":{"type":"object","properties":{"$ref":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"description":{"type":"string"},"format":{"type":"string"},"items":{"$ref":"#/components/schemas/DataType"},"enum":{"type":"array","items":{"type":"string"}},"properties":{"type":"object","properties":{}},"required":{"type":"array","items":{"type":"string"}},"subTypes":{"type":"array","items":{"type":"string"}},"discriminator":{"type":"string"},"title":{"type":"string"},"hidden":{"type":"boolean"},"transient":{"type":"boolean"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"minLength":{"type":"integer"},"maxLength":{"type":"integer"},"minItems":{"type":"integer"},"maxItems":{"type":"integer"},"divisibleBy":{"type":"number"},"pattern":{"type":"string"},"disallow":{"type":"string","enum":["Any","Array","Boolean","Float","Integer","None","Null","Object","String"]},"extends":{"type":"array","items":{"$ref":"#/components/schemas/DataType"}},"suggestedTypeName":{"type":"string"}}},"Parameter":{"required":["description","enum","format","items","name","paramType","required","type"],"type":"object","properties":{"paramType":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"required":{"type":"boolean"},"type":{"type":"string"},"format":{"type":"string"},"items":{"$ref":"#/components/schemas/DataType"},"enum":{"type":"array","items":{"type":"string"}},"suggestedTypeName":{"type":"string"}}},"TokenRequestEndpoint":{"required":["url"],"type":"object","properties":{"clientIdName":{"type":"string"},"clientSecretName":{"type":"string"},"url":{"type":"object","properties":{}}}},"Api":{"required":["description","operations","path"],"type":"object","properties":{"path":{"type":"string"},"description":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/components/schemas/Operation"}}}},"OAuth2Scope":{"required":["scope"],"type":"object","properties":{"scope":{"type":"string"},"description":{"type":"string"}}},"GrantTypes":{"required":["authorization_code"],"type":"object","properties":{"implicit":{"$ref":"#/components/schemas/ImplicitGrantType"},"authorization_code":{"$ref":"#/components/schemas/AuthorizationCodeGrantType"}}}}},"x-original-swagger-version":"2.0"}