Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ref(doc): updated GIG DNS API swagger doc #1103

Merged
merged 1 commit into from
Jan 17, 2024

Conversation

QiluXie
Copy link
Contributor

@QiluXie QiluXie commented Jan 10, 2024

Problem

Closes IS-812

The GIG DNS API swagger doc is outdated with a few new incoming requirements from GIG team.

Solution

Updated the API swagger doc to reflect the latest requirements from GIG team:

  • Added PUT call to the API suite for updating DNS records
  • Added an optional field rootDomain to PUT and POST calls in the request body
  • Added an optional query parameter rootDomain and a required parameter email to DELETE call

Breaking Changes

  • Yes - this PR contains breaking changes
    • Details ...
  • No - this PR is backwards compatible with ALL of the following feature flags in this doc

Improvements:

  • Updated the API swagger doc to reflect the latest requirements from GIG team.

Before & After Screenshots

AFTER:

  • The swagger file can be loaded manually on swagger.io

Tests

  • The swagger file can be loaded manually on swagger.io

@QiluXie QiluXie requested review from harishv7, kishore03109 and a team January 10, 2024 09:36
@alexanderleegs alexanderleegs merged commit ec28c2e into develop Jan 17, 2024
17 checks passed
@mergify mergify bot deleted the IS-812-update-gig-swagger-doc branch January 17, 2024 08:12
@alexanderleegs alexanderleegs mentioned this pull request Jan 17, 2024
9 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants