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

docs(openapi): Align new endpoints with existing ones #259

Merged
merged 3 commits into from
Jan 30, 2024

Conversation

jvallesm
Copy link
Collaborator

@jvallesm jvallesm commented Jan 30, 2024

Because

This commit

  • Unifies the convention.
  • Fixes a typo due to copypaste (a organization -> an organization)

🗒️

cc @donch1989 I hope this PR doesn't read as nitpicky 😅 It's hard to enforce these conventions by e.g. linter but I think having consistency in our docs is good for the public image of Instill AI. I'd say the best way to keep consistent at this point is relying on existing documentation and on peer reviews (I doubt product / marketing will QA OpenAPI docs in the short term)

The format specification in the previously documented endpoints uses
brackets for placeholders and is surrounded by ticks (`).
@jvallesm jvallesm self-assigned this Jan 30, 2024
@jvallesm jvallesm marked this pull request as ready for review January 30, 2024 12:57
@donch1989
Copy link
Member

Great Thanks!

@donch1989 donch1989 merged commit 3047170 into main Jan 30, 2024
3 checks passed
@donch1989 donch1989 deleted the jvalles/fix-endpoint-public-description branch January 30, 2024 17:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
Status: 👋 Done
Development

Successfully merging this pull request may close these issues.

3 participants