Skip to content

STORY-18957 Update API documentation with new behavior and examples#404

Merged
oleksiy merged 3 commits into2022-08-01from
STORY-18957-update-api-documentation-with-new-behavior-and-examples
Sep 16, 2024
Merged

STORY-18957 Update API documentation with new behavior and examples#404
oleksiy merged 3 commits into2022-08-01from
STORY-18957-update-api-documentation-with-new-behavior-and-examples

Conversation

@abhig10
Copy link
Contributor

@abhig10 abhig10 commented Sep 5, 2024

STORY-18957 Update API documentation with new behavior and examples

Update description around required_params and adds examples for GET, POST and PUT API requests.

Screenshot 2024-09-06 at 1 40 06 PM

GET API

Screenshot 2024-09-06 at 1 46 38 PM

POST API

Screenshot 2024-09-06 at 1 51 47 PM

PUT API

Screenshot 2024-09-06 at 1 53 16 PM

Checklist

  • Find the Service owning team for these changes, and tag the team as "Reviewers" on this PR
  • Test the documentation changes on readthedocs as a private branch
  • If changing general content, have agreement on whether to apply to latest version or all versions (if all versions, provide links to the related PRs below)

@abhig10 abhig10 requested review from a team and fdisperati-invoca September 6, 2024 08:43
Copy link
Contributor

@fdisperati-invoca fdisperati-invoca left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 👍

@oleksiy oleksiy merged commit 9f85b85 into 2022-08-01 Sep 16, 2024
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