Skip to content

chore: updating our openapi schema#1219

Merged
erunion merged 1 commit intonextfrom
chore/update-openapi-schema
Apr 21, 2025
Merged

chore: updating our openapi schema#1219
erunion merged 1 commit intonextfrom
chore/update-openapi-schema

Conversation

@erunion
Copy link
Member

@erunion erunion commented Apr 21, 2025

🧰 Changes

Updates our OpenAPI schema with some new additions and revisions to our public API.

tags: ['APIs'],
description:
"Get all API definitions from your ReadMe project. \n\n>📘\n> This route is only available to projects that are using [ReadMe Refactored](https://docs.readme.com/main/docs/welcome-to-readme-refactored).\n\n>🚧 ReadMe's API v2 is currently in beta.\n> This API and its docs are a work in progress. While we dont expect any major breaking changes, you may encounter occasional issues as we work toward a stable release. Make sure to [check out our API migration guide](https://docs.readme.com/main/reference/api-migration-guide), and [feel free to reach out](mailto:support@readme.io) if you have any questions or feedback!",
"Get all API definitions from your ReadMe project.\n\n>📘\n> This route is only available to projects that are using [ReadMe Refactored](https://docs.readme.com/main/docs/welcome-to-readme-refactored).\n\n>🚧 ReadMe's API v2 is currently in beta.\n >This API and its documentation are a work in progress. While we don't expect any major breaking changes, you may encounter occasional issues as we work toward a stable release. Make sure to [check out our API migration guide](https://docs.readme.com/main/reference/api-migration-guide), and [feel free to reach out](mailto:support@readme.io) if you have any questions or feedback!",
Copy link
Contributor

Choose a reason for hiding this comment

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

😬 we'll need to double check that that callout change (e.g., \n >This renders properly in our docs

@erunion erunion force-pushed the chore/update-openapi-schema branch from 69a9e56 to 7ba465d Compare April 21, 2025 18:02
@erunion erunion requested a review from kanadgupta April 21, 2025 18:02
@erunion erunion merged commit c9f9778 into next Apr 21, 2025
8 checks passed
@erunion erunion deleted the chore/update-openapi-schema branch April 21, 2025 18:03
@kanadgupta
Copy link
Contributor

🎉 This PR is included in version 10.2.0-next.13 🎉

The release is available on:

Your semantic-release bot 📦🚀

@kanadgupta
Copy link
Contributor

🎉 This PR is included in version 10.2.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants