Skip to content

Latest commit

 

History

History
41 lines (38 loc) · 1.5 KB

OASDIFF-SERVICE.md

File metadata and controls

41 lines (38 loc) · 1.5 KB
Raw

oasdiff-service

While oasdiff can run directly on your environment, it can also be used through a service so you don't need to install anything.
To use it you must first create a tenant, and then call the diff, breaking-changes or changelog commands.

Creating a tenant

Create a tenant and get a tenant ID:

curl -d '{"tenant": "my-company", "email": "james@my-company.com"}' https://register.oasdiff.com/tenants

You will get a response with your tenant ID:

{"id": "2ahh9d6a-2221-41d7-bbc5-a950958345"}

Run diff

curl -X POST \
    -F base=@data/openapi-test1.yaml \
    -F revision=@data/openapi-test3.yaml \
    http://api.oasdiff.com/tenants/{tenant-id}/diff

Run breaking-changes

curl -X POST \
    -F base=@data/openapi-test1.yaml \
    -F revision=@data/openapi-test3.yaml \
    https://api.oasdiff.com/tenants/{tenant-id}/breaking-changes

Run changelog

curl -X POST \
    -F base=@data/openapi-test1.yaml \
    -F revision=@data/openapi-test3.yaml \
    https://api.oasdiff.com/tenants/{tenant-id}/changelog

Errors

The service uses conventional HTTP response codes to indicate success or failure of an API request:

  • Codes in the 2xx range indicate success
  • Codes in the 4xx range indicate a failure with additional information provided (e.g., invalid OpenAPI spec format, a required parameter was missing, etc.)
  • Codes in the 5xx range indicate a server error (these are rare)