Skip to content

Latest commit

 

History

History
30 lines (27 loc) · 2.43 KB

UPDATING_OPENAPI_JSON.md

File metadata and controls

30 lines (27 loc) · 2.43 KB
Raw

Updating swagger.yml

This is a temporary measure. Feedback will be shared to fix upstream.

This project uses a modified openapi.json. Please maintain these instructions and follow them carefully.

  1. Take the latest openapi-external.json from netlify/bitballoon-openapi.
  2. Remove the billing_details property from the Account object (also from the required array).
  3. Remove all required properties from the Repo object (manual builds).
  4. Remove the domain property from the required array of the DnsZone object.
  5. Remove the values, scopes and is_secret parameters from the updateEnvVar operation.
  6. Add a request body schema to the updateEnvVar operation, by copying it from an earlier version of the openapi.json.
  7. Remove scopes from the required array of the updateEnvVar operation request body.
  8. Remove scopes from the required array of the EnvVar object.
  9. Add a functions_region property of type string to the Site object.
  10. Add a cdp_enabled_contexts property of type array of strings to the Site object.
  11. Add a hud_enabled property of type boolean to the Site object.
  12. Duplicate the Site object into PartialSite and remove the required properties.
  13. Change updateSite operation to use the PartialSite object as the request body schema (NOTE: not the response body schema).
  14. Change the type of LogDrain.id to string.
  15. Add the various log_drains paths from bitballoon-openapi's openapi.json file.
  16. Remove the required properties from the LogDrainServiceConfig object.
  17. Change the request body of the Log Drains-update operation to use the LogDrain object (copy from Log Drains-create).
  18. Add the various firewall_rule_set paths from bitballoon-openapi's openapi.json file (NOTE: both site and account level).
  19. Replace the response body of the getAccountFirewallRuleSet operation to use the SiteFirewallConfig object.
  20. Replace the request body of the updateAccountFirewallRuleSet operation to use the SiteFirewallConfig object.
  21. Add a rum_enabled property of type boolean to the Site object.
  22. Add a rum_enabled property of type boolean to the PartialSite object.
  23. Add an analytics_instance_id property of type string to the Site object.
  24. Add the various WAF paths and schemas, by copying them from an earlier version of the openapi.json.