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

chore(openapi): reformat and fix typos #263

Merged
merged 5 commits into from
Dec 30, 2022
Merged

Conversation

SanchithHegde
Copy link
Member

Type of Change

  • Bugfix
  • New feature
  • Enhancement
  • Refactoring
  • Dependency updates

Description

(If you're reviewing, it's better to follow changes in each commit, except for the first one. For the first commit, check diff without whitespace changes.)

This PR includes the following changes:

  • Re-formats the OpenAPI spec YAML file to use 2 spaces instead of 4 for indentation.
  • Updates the base URLs in the description to be clickable links.
  • Replaces some occurrences of jarnura and Arun Raj with placeholders.
  • Fixes typos in the OpenAPI spec file (~50 of them)
  • Re-generates the Postman collection from the OpenAPI spec file.

Motivation and Context

This PR paves the way for including a "quick start" section in the OpenAPI spec and the Postman collection, which will be made in a separate PR.

How did you test it?

N/A

Checklist

  • I formatted the code cargo +nightly fmt
  • I addressed lints thrown by cargo clippy
  • I reviewed submitted code
  • I added unit tests for my changes where possible
  • I added a CHANGELOG entry if applicable

@SanchithHegde SanchithHegde added C-doc Category: Documentation updates S-waiting-on-review Status: This PR has been implemented and needs to be reviewed labels Dec 29, 2022
@SanchithHegde SanchithHegde self-assigned this Dec 29, 2022
@jarnura jarnura removed the S-waiting-on-review Status: This PR has been implemented and needs to be reviewed label Dec 30, 2022
@jarnura jarnura merged commit bfc6858 into main Dec 30, 2022
@jarnura jarnura deleted the openapi-reformat-typos branch December 30, 2022 10:27
@bernard-eugine bernard-eugine added this to the Feb 23 release milestone Apr 18, 2023
@bernard-eugine bernard-eugine linked an issue Apr 18, 2023 that may be closed by this pull request
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-doc Category: Documentation updates
Projects
No open projects
Status: Candidate
Development

Successfully merging this pull request may close these issues.

Sync Open API specifications with latest additions
4 participants