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.

Sign up for GitHub

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

Jump to bottom

Fixed major consistency issues in API readme #1244

Merged
merged 4 commits into from
Jun 8, 2023
Merged

Fixed major consistency issues in API readme #1244

merged 4 commits into from
Jun 8, 2023

Conversation

sunithasomanna
Copy link
Collaborator

Fixed the following consistency issues in API readme:

  • Headings and TOCs
  • Description of API URI
  • Returns of API URI
  • Case sensitivity of ID from id, for all variables like {SessionID} etc
  • Usage information section

Also made styleguide fixes w.r.t minimalism, removed repeated responses, added missed out "Returns" row in API URI tables and so on.

@sunithasomanna sunithasomanna added prio:normal normal priority, can be taken up after high priority issues are addressed status:in-progress issue has been accepted previously and now taken up for implementation type:doc This tag is for documentation labels Jun 8, 2023
@sunithasomanna sunithasomanna self-assigned this Jun 8, 2023
ashraf-vazeer
ashraf-vazeer approved these changes Jun 8, 2023
View reviewed changes
Copy link
Contributor

@ashraf-vazeer ashraf-vazeer left a comment

Choose a reason for hiding this comment

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

LGTM

@amar-shalgar amar-shalgar merged commit 5caffa7 into ODIM-Project:development Jun 8, 2023
@amar-shalgar amar-shalgar deleted the odim-7474 branch June 8, 2023 10:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jeevan-kamkar jeevan-kamkar jeevan-kamkar approved these changes

@ashraf-vazeer ashraf-vazeer ashraf-vazeer approved these changes

@amar-shalgar amar-shalgar Awaiting requested review from amar-shalgar

Assignees

@sunithasomanna sunithasomanna

Labels
prio:normal normal priority, can be taken up after high priority issues are addressed status:in-progress issue has been accepted previously and now taken up for implementation type:doc This tag is for documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@sunithasomanna @ashraf-vazeer @jeevan-kamkar @amar-shalgar