diff --git a/README.md b/README.md index b7e7889..98f7228 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ # Docs Starter -Learn how to create beautiful documentation in under 5 minutes using an OpenAPI specification (formerly Swagger). +Learn how to create beautiful documentation in under 5 minutes using an OpenAPI Specification (formerly Swagger). @@ -100,10 +100,10 @@ You must run `fern generate --docs` after any modifications to re-generate and p To preview updates to your documentation before publishing changes, run `fern generate --docs --preview`. -To use your own OpenAPI specification file or to update the existing one: +To use your own OpenAPI Specification file or to update the existing one: -- Update or replace the OpenAPI specification file in the `openapi/` folder. -- _Note: Don't have an OpenAPI spec? Use Fern's simpler format to define your API._ [_Learn more_](https://github.com/fern-api/docs-starter-fern-definition?utm_source=github&utm_medium=readme&utm_campaign=docs-starter-openapi&utm_content=step7). +- Update or replace the OpenAPI Specification file in the `openapi/` folder. +- _Note: Don't have an OpenAPI Specification? Use Fern's simpler format to define your API._ [_Learn more_](https://github.com/fern-api/docs-starter-fern-definition?utm_source=github&utm_medium=readme&utm_campaign=docs-starter-openapi&utm_content=step7). To modify the other docs pages: @@ -140,4 +140,4 @@ Need help? [Set up a call](https://buildwithfern.com/contact?utm_source=github&u ## About OpenAPI (formerly Swagger) -The OpenAPI specification is a format for describing REST APIs. The specification consists of a single JSON or YAML file. OpenAPI was previously known as Swagger. Fern supports both OpenAPI (3.x) and Swagger (2.x). We refer to the specification as OpenAPI throughout our documentation. +The OpenAPI Specification is a format for describing REST APIs. The specification consists of a single JSON or YAML file. OpenAPI was previously known as Swagger. Fern supports both OpenAPI (3.x) and Swagger (2.x). We refer to the specification as OpenAPI throughout our documentation. diff --git a/fern/docs/changelog/06-10-2024.md b/fern/docs/changelog/06-10-2024.md new file mode 100644 index 0000000..5ac7ad0 --- /dev/null +++ b/fern/docs/changelog/06-10-2024.md @@ -0,0 +1,17 @@ +## Summary + +This release focuses on improving user account management and streamlining plant orders. + +## What's New? + +New Endpoints: + +- `POST /user/createWithList` - Bulk create users by providing an input array. + +- `POST /plant/{plantId}/uploadImage` - Upload an image for a specific plant, enhancing visual data. + +## Fixes & Improvements + +Updated the `DELETE /plant/{plantId}` endpoint to handle invalid plant IDs more gracefully. + +Improved error handling in the order process, reducing the occurrence of 400 and 404 errors. \ No newline at end of file diff --git a/fern/docs/changelog/07-06-2024.md b/fern/docs/changelog/07-06-2024.md new file mode 100644 index 0000000..12e4323 --- /dev/null +++ b/fern/docs/changelog/07-06-2024.md @@ -0,0 +1,16 @@ +## Summary + +In this update, we’ve enhanced the plant management capabilities with new features and expanded support for status-based queries. + +## What's New? + +New Endpoints: + +- `GET /plant/findByStatus` - Retrieve plants based on their status (e.g., available, pending, sold). + +- `GET /plant/findByTags` - Filter plants by tags for more precise searches. + +## Improvements + +Enhanced response formats for status-based queries. +Expanded security requirements for all plant-related operations, ensuring more secure data handling. \ No newline at end of file diff --git a/fern/docs/changelog/08-23-2024.md b/fern/docs/changelog/08-23-2024.md new file mode 100644 index 0000000..4d249c3 --- /dev/null +++ b/fern/docs/changelog/08-23-2024.md @@ -0,0 +1,15 @@ +## Summary + +In the latest release, we've added endpoints to create a new Plant. + +### What's New? + +New endpoints: + +- `POST /plant` add a new plant to inventory. + +New object schemas: + +- `CreatePlantRequest` + +``` \ No newline at end of file diff --git a/fern/docs/pages/sdks.mdx b/fern/docs/pages/sdks.mdx index 541759f..51276b6 100644 --- a/fern/docs/pages/sdks.mdx +++ b/fern/docs/pages/sdks.mdx @@ -1,6 +1,6 @@ --- title: SDKs -subtitle: We offer client libraries for your favorite languages, generated by Fern from your OpenAPI specification file. +subtitle: We offer client libraries for your favorite languages, generated by Fern from your OpenAPI Specification file. slug: sdks --- @@ -48,4 +48,4 @@ bash nuget install plantstore.net ## Request a new SDK -If you'd like to request an SDK for a language that we don't currently support, [let us know](/welcome.mdx#get-support). We're always looking to expand our SDK offerings and would love to hear from you. +If you'd like to request an SDK for a language that we don't currently support, let us know by posting in our [community Slack](https://join.slack.com/t/fern-community/shared_invite/zt-2dpftfmif-MuAegl8AfP_PK8s2tx350Q). We're always looking to expand our SDK offerings and would love to hear from you. diff --git a/fern/docs/pages/welcome.mdx b/fern/docs/pages/welcome.mdx index aca05f5..3c8dfdd 100644 --- a/fern/docs/pages/welcome.mdx +++ b/fern/docs/pages/welcome.mdx @@ -1,8 +1,8 @@ --- -title: Welcome to our developer documentation -subtitle: Get started with the Plant Store API +title: Plant Store developer platform +subtitle: Make your first API request in minutes slug: welcome -description: Here you'll find information to get started, as well as a sample API Reference generated by Fern from an OpenAPI specification file. +description: Here you'll find information to get started, as well as a sample API Reference generated by Fern from an OpenAPI Specification file. --- Welcome to the Plant Store API docs! This site demonstrates how to use Fern to generate API documentation from an OpenAPI file. You can [use this site template](https://github.com/fern-api/docs-starter-openapi) as a starting point for your own API documentation. @@ -14,9 +14,9 @@ Here you'll find information about managing your plants, customers, and orders f