UNPKG

openapi-directory

Version:

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

1 lines 10.4 kB
{"openapi":"3.0.0","info":{"description":"The posty_API is the core element of the posty softwarestack. It is developed to administrate a mailserver based on Postfix and Dovecot. It offers an easy REST interface which can be used in own applications or with the posty client applications, posty_CLI and posty_webUI.","title":"posty_API","version":"v1","x-apisguru-categories":["email"],"x-origin":[{"converter":{"url":"https://github.com/lucybot/api-spec-converter","version":"2.7.11"},"format":"swagger","url":"http://posty-api.herokuapp.com/api/v1/swagger_doc.json","version":"1.2"}],"x-providerName":"posty-api.herokuapp.com"},"tags":[{"name":"domains"},{"name":"summary"},{"name":"transports"},{"name":"v1"}],"paths":{"/api/v1/domains.json":{"get":{"operationId":"GET-api--version-domains---format-","responses":{"200":{"description":"No response was specified"}},"summary":"Returns all available domains","tags":["domains"]},"post":{"operationId":"POST-api--version-domains---format-","responses":{"200":{"description":"No response was specified"}},"summary":"Create new domain","tags":["domains"]}},"/api/v1/domains/{domain_name}.json":{"delete":{"operationId":"DELETE-api--version-domains--domain_name---format-","parameters":[{"in":"path","name":"domain_name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"No response was specified"}},"summary":"Delete the specified domain","tags":["domains"]},"get":{"operationId":"GET-api--version-domains--domain_name---format-","parameters":[{"in":"path","name":"domain_name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"No response was specified"}},"summary":"Returns the information to the specified domain","tags":["domains"]},"put":{"operationId":"PUT-api--version-domains--domain_name---format-","parameters":[{"in":"path","name":"domain_name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"No response was specified"}},"summary":"Update the specified domain","tags":["domains"]}},"/api/v1/domains/{domain_name}/aliases.json":{"get":{"operationId":"GET-api--version-domains--domain_name-aliases---format-","parameters":[{"in":"path","name":"domain_name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"No response was specified"}},"summary":"Returns all aliases for the specified domain","tags":["domains"]},"post":{"operationId":"POST-api--version-domains--domain_name-aliases---format-","parameters":[{"in":"path","name":"domain_name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"No response was specified"}},"summary":"Create new domain alias","tags":["domains"]}},"/api/v1/domains/{domain_name}/aliases/{alias_name}.json":{"delete":{"operationId":"DELETE-api--version-domains--domain_name-aliases--alias_name---format-","parameters":[{"in":"path","name":"domain_name","required":true,"schema":{"type":"string"}},{"in":"path","name":"alias_name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"No response was specified"}},"summary":"Delete the specified domain alias","tags":["domains"]},"get":{"operationId":"GET-api--version-domains--domain_name-aliases--alias_name---format-","parameters":[{"in":"path","name":"domain_name","required":true,"schema":{"type":"string"}},{"in":"path","name":"alias_name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"No response was specified"}},"summary":"Returns the information to the specified domain alias","tags":["domains"]},"put":{"operationId":"PUT-api--version-domains--domain_name-aliases--alias_name---format-","parameters":[{"in":"path","name":"domain_name","required":true,"schema":{"type":"string"}},{"in":"path","name":"alias_name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"No response was specified"}},"summary":"Update the specified domain alias","tags":["domains"]}},"/api/v1/domains/{domain_name}/users.json":{"get":{"operationId":"GET-api--version-domains--domain_name-users---format-","parameters":[{"in":"path","name":"domain_name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"No response was specified"}},"summary":"Returns all users for the specified domain","tags":["domains"]},"post":{"operationId":"POST-api--version-domains--domain_name-users---format-","parameters":[{"in":"path","name":"domain_name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"No response was specified"}},"summary":"Create new user","tags":["domains"]}},"/api/v1/domains/{domain_name}/users/{user_name}.json":{"delete":{"operationId":"DELETE-api--version-domains--domain_name-users--user_name---format-","parameters":[{"in":"path","name":"domain_name","required":true,"schema":{"type":"string"}},{"in":"path","name":"user_name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"No response was specified"}},"summary":"Delete the specified user","tags":["domains"]},"get":{"operationId":"GET-api--version-domains--domain_name-users--user_name---format-","parameters":[{"in":"path","name":"domain_name","required":true,"schema":{"type":"string"}},{"in":"path","name":"user_name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"No response was specified"}},"summary":"Returns the information to the specified user","tags":["domains"]},"put":{"operationId":"PUT-api--version-domains--domain_name-users--user_name---format-","parameters":[{"in":"path","name":"domain_name","required":true,"schema":{"type":"string"}},{"in":"path","name":"user_name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"No response was specified"}},"summary":"Update the specified user","tags":["domains"]}},"/api/v1/domains/{domain_name}/users/{user_name}/aliases.json":{"get":{"operationId":"GET-api--version-domains--domain_name-users--user_name-aliases---format-","parameters":[{"in":"path","name":"domain_name","required":true,"schema":{"type":"string"}},{"in":"path","name":"user_name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"No response was specified"}},"summary":"Returns all aliases for the specified user","tags":["domains"]},"post":{"operationId":"POST-api--version-domains--domain_name-users--user_name-aliases---format-","parameters":[{"in":"path","name":"domain_name","required":true,"schema":{"type":"string"}},{"in":"path","name":"user_name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"No response was specified"}},"summary":"Create new user alias","tags":["domains"]}},"/api/v1/domains/{domain_name}/users/{user_name}/aliases/{alias_name}.json":{"delete":{"operationId":"DELETE-api--version-domains--domain_name-users--user_name-aliases--alias_name---format-","parameters":[{"in":"path","name":"domain_name","required":true,"schema":{"type":"string"}},{"in":"path","name":"user_name","required":true,"schema":{"type":"string"}},{"in":"path","name":"alias_name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"No response was specified"}},"summary":"Delete the specified user alias","tags":["domains"]},"get":{"operationId":"GET-api--version-domains--domain_name-users--user_name-aliases--alias_name---format-","parameters":[{"in":"path","name":"domain_name","required":true,"schema":{"type":"string"}},{"in":"path","name":"user_name","required":true,"schema":{"type":"string"}},{"in":"path","name":"alias_name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"No response was specified"}},"summary":"Returns the information to the specified user alias","tags":["domains"]},"put":{"operationId":"PUT-api--version-domains--domain_name-users--user_name-aliases--alias_name---format-","parameters":[{"in":"path","name":"domain_name","required":true,"schema":{"type":"string"}},{"in":"path","name":"user_name","required":true,"schema":{"type":"string"}},{"in":"path","name":"alias_name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"No response was specified"}},"summary":"Update the specified user alias","tags":["domains"]}},"/api/v1/summary.json":{"get":{"operationId":"GET-api--version-summary---format-","responses":{"200":{"description":"No response was specified"}},"summary":"Returns a summary of all Resources","tags":["summary"]}},"/api/v1/swagger_doc.json":{"get":{"operationId":"GET-api-v1-swagger_doc---format-","responses":{"200":{"description":"No response was specified"}},"summary":"Swagger compatible API description","tags":["v1"]}},"/api/v1/swagger_doc/{name}.json":{"get":{"operationId":"GET-api-v1-swagger_doc--name---format-","parameters":[{"description":"Resource name of mounted API","in":"path","name":"name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"No response was specified"}},"summary":"Swagger compatible API description for specific API","tags":["v1"]}},"/api/v1/transports.json":{"get":{"operationId":"GET-api--version-transports---format-","responses":{"200":{"description":"No response was specified"}},"summary":"Returns all available transports","tags":["transports"]},"post":{"operationId":"POST-api--version-transports---format-","responses":{"200":{"description":"No response was specified"}},"summary":"Create new transport","tags":["transports"]}},"/api/v1/transports/{transport_name}.json":{"delete":{"operationId":"DELETE-api--version-transports--transport_name---format-","parameters":[{"in":"path","name":"transport_name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"No response was specified"}},"summary":"Delete the specified transport","tags":["transports"]},"get":{"operationId":"GET-api--version-transports--transport_name---format-","parameters":[{"in":"path","name":"transport_name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"No response was specified"}},"summary":"Returns the information to the specified transport","tags":["transports"]},"put":{"operationId":"PUT-api--version-transports--transport_name---format-","parameters":[{"in":"path","name":"transport_name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"No response was specified"}},"summary":"Update the specified transport","tags":["transports"]}}},"servers":[{"url":"http://posty-api.herokuapp.com/"}]}