Skip to content

feat: Update API docs to v2#239

Merged
jpmcb merged 1 commit intomainfrom
v2-api-update
Jan 30, 2024
Merged

feat: Update API docs to v2#239
jpmcb merged 1 commit intomainfrom
v2-api-update

Conversation

@jpmcb
Copy link
Copy Markdown
Member

@jpmcb jpmcb commented Jan 24, 2024

Description

This is a small change to upgrade the v1 API docs to the new v2


⚠️ We'll probably want to not merge/deploy this until we do the v1 --> v2 cutover

What type of PR is this? (check all applicable)

  • 🍕 Feature
  • 🐛 Bug Fix
  • 📝 Documentation Update
  • 🎨 Style
  • 🧑‍💻 Code Refactor
  • 🔥 Performance Improvements
  • ✅ Test
  • 🤖 Build
  • 🔁 CI
  • 📦 Chore (Release)
  • ⏩ Revert

Related Tickets & Documents

Closes: #238
Related to: https://github.com/open-sauced/api/issues/478

Mobile & Desktop Screenshots/Recordings

Steps to QA

N/a - no other "v1" references for the API found

Added to documentation?

  • 📜 README.md
  • 📓 docs.opensauced.pizza
  • 🍕 dev.to/opensauced
  • 📕 storybook
  • 🙅 no documentation needed

[optional] Are there any post-deployment tasks we need to perform?

[optional] What gif best describes this PR or how it makes you feel?

Signed-off-by: John McBride <john@opensauced.pizza>
@netlify
Copy link
Copy Markdown

netlify bot commented Jan 24, 2024

Deploy Preview for docs-open ready!

Name Link
🔨 Latest commit 0be40cb
🔍 Latest deploy log https://app.netlify.com/sites/docs-open/deploys/65b16884a39bdc00081feb5d
😎 Deploy Preview https://deploy-preview-239--docs-open.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Copy Markdown
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Congrats on making your first Pull Request and thanks for taking the time to improve Open Sauced! ❤️! 🎉🍕
Say hello by joining the conversation in our Discord

@jpmcb jpmcb marked this pull request as draft January 24, 2024 19:55
@jpmcb
Copy link
Copy Markdown
Member Author

jpmcb commented Jan 25, 2024

We cut over the alpha --> beta for the v2 changes on the API. But we probably want to hold off on this until these changes are in prod since most doc consumers will be using prod opensauced.

@jpmcb jpmcb marked this pull request as ready for review January 30, 2024 20:37
@jpmcb
Copy link
Copy Markdown
Member Author

jpmcb commented Jan 30, 2024

V2 has released: https://github.com/open-sauced/api/pull/524

Merging!

@jpmcb jpmcb merged commit de93e7a into main Jan 30, 2024
@jpmcb jpmcb deleted the v2-api-update branch January 30, 2024 20:37
github-actions bot pushed a commit that referenced this pull request Jan 30, 2024
## [1.62.0](v1.61.0...v1.62.0) (2024-01-30)

### Features

* Update API docs to v2 ([#239](#239)) ([de93e7a](de93e7a))
@github-actions
Copy link
Copy Markdown
Contributor

🎉 This PR is included in version 1.62.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

github-actions bot pushed a commit that referenced this pull request Jan 30, 2024
Signed-off-by: John McBride <john@opensauced.pizza> de93e7a
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Feature: Cut over to v2 API

1 participant