From 6aaf585a3032404af1c3f9096343afa8a5c40d25 Mon Sep 17 00:00:00 2001 From: Danny Sheridan Date: Fri, 23 Aug 2024 17:00:43 -0600 Subject: [PATCH 1/5] feat(docs): init changelog --- fern/openapi/changelog/06-10-2024.md | 17 +++++++++++++++++ fern/openapi/changelog/07-06-2024.md | 16 ++++++++++++++++ fern/openapi/changelog/08-23-2024.mdx | 16 ++++++++++++++++ 3 files changed, 49 insertions(+) create mode 100644 fern/openapi/changelog/06-10-2024.md create mode 100644 fern/openapi/changelog/07-06-2024.md create mode 100644 fern/openapi/changelog/08-23-2024.mdx diff --git a/fern/openapi/changelog/06-10-2024.md b/fern/openapi/changelog/06-10-2024.md new file mode 100644 index 0000000..5726852 --- /dev/null +++ b/fern/openapi/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/openapi/changelog/07-06-2024.md b/fern/openapi/changelog/07-06-2024.md new file mode 100644 index 0000000..646da79 --- /dev/null +++ b/fern/openapi/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/openapi/changelog/08-23-2024.mdx b/fern/openapi/changelog/08-23-2024.mdx new file mode 100644 index 0000000..f2be99b --- /dev/null +++ b/fern/openapi/changelog/08-23-2024.mdx @@ -0,0 +1,16 @@ +## 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` + + Have questions? Reach out to your local botanist. +``` \ No newline at end of file From b1b385644fefb5d8b19304d972768e76150b02fb Mon Sep 17 00:00:00 2001 From: Danny Sheridan Date: Fri, 23 Aug 2024 17:03:46 -0600 Subject: [PATCH 2/5] formatting --- fern/openapi/changelog/06-10-2024.md | 6 +++--- fern/openapi/changelog/07-06-2024.md | 4 ++-- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/fern/openapi/changelog/06-10-2024.md b/fern/openapi/changelog/06-10-2024.md index 5726852..5ac7ad0 100644 --- a/fern/openapi/changelog/06-10-2024.md +++ b/fern/openapi/changelog/06-10-2024.md @@ -6,12 +6,12 @@ This release focuses on improving user account management and streamlining plant New Endpoints: -POST /user/createWithList - Bulk create users by providing an input array. +- `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. +- `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. +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/openapi/changelog/07-06-2024.md b/fern/openapi/changelog/07-06-2024.md index 646da79..12e4323 100644 --- a/fern/openapi/changelog/07-06-2024.md +++ b/fern/openapi/changelog/07-06-2024.md @@ -6,9 +6,9 @@ In this update, we’ve enhanced the plant management capabilities with new feat New Endpoints: -GET /plant/findByStatus - Retrieve plants based on their status (e.g., available, pending, sold). +- `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. +- `GET /plant/findByTags` - Filter plants by tags for more precise searches. ## Improvements From f0b8ce356c9c3749deaae6291c73210c38bc249e Mon Sep 17 00:00:00 2001 From: Danny Sheridan Date: Fri, 23 Aug 2024 17:04:17 -0600 Subject: [PATCH 3/5] upgrade fern version --- fern/fern.config.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/fern/fern.config.json b/fern/fern.config.json index 26d1b83..17fe01a 100644 --- a/fern/fern.config.json +++ b/fern/fern.config.json @@ -1,4 +1,4 @@ { "organization": "plantstore", - "version": "0.37.6" + "version": "0.39.18" } \ No newline at end of file From 09022f08a98baeb274e0589a3eb748b97a8f7358 Mon Sep 17 00:00:00 2001 From: Danny Sheridan Date: Mon, 26 Aug 2024 17:04:18 -0400 Subject: [PATCH 4/5] remove mdx file, add generators.yml --- README.md | 10 +++++----- fern/{openapi => }/changelog/06-10-2024.md | 0 fern/{openapi => }/changelog/07-06-2024.md | 0 .../08-23-2024.mdx => changelog/08-23-2024.md} | 1 - fern/docs/pages/sdks.mdx | 4 ++-- fern/docs/pages/welcome.mdx | 12 ++++++------ fern/fern.config.json | 2 +- fern/generators.yml | 1 + 8 files changed, 15 insertions(+), 15 deletions(-) rename fern/{openapi => }/changelog/06-10-2024.md (100%) rename fern/{openapi => }/changelog/07-06-2024.md (100%) rename fern/{openapi/changelog/08-23-2024.mdx => changelog/08-23-2024.md} (76%) create mode 100644 fern/generators.yml 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/openapi/changelog/06-10-2024.md b/fern/changelog/06-10-2024.md similarity index 100% rename from fern/openapi/changelog/06-10-2024.md rename to fern/changelog/06-10-2024.md diff --git a/fern/openapi/changelog/07-06-2024.md b/fern/changelog/07-06-2024.md similarity index 100% rename from fern/openapi/changelog/07-06-2024.md rename to fern/changelog/07-06-2024.md diff --git a/fern/openapi/changelog/08-23-2024.mdx b/fern/changelog/08-23-2024.md similarity index 76% rename from fern/openapi/changelog/08-23-2024.mdx rename to fern/changelog/08-23-2024.md index f2be99b..4d249c3 100644 --- a/fern/openapi/changelog/08-23-2024.mdx +++ b/fern/changelog/08-23-2024.md @@ -12,5 +12,4 @@ New object schemas: - `CreatePlantRequest` - Have questions? Reach out to your local botanist. ``` \ 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 Date: Mon, 26 Aug 2024 17:04:43 -0400 Subject: [PATCH 5/5] next changelog --- fern/{ => docs}/changelog/06-10-2024.md | 0 fern/{ => docs}/changelog/07-06-2024.md | 0 fern/{ => docs}/changelog/08-23-2024.md | 0 3 files changed, 0 insertions(+), 0 deletions(-) rename fern/{ => docs}/changelog/06-10-2024.md (100%) rename fern/{ => docs}/changelog/07-06-2024.md (100%) rename fern/{ => docs}/changelog/08-23-2024.md (100%) diff --git a/fern/changelog/06-10-2024.md b/fern/docs/changelog/06-10-2024.md similarity index 100% rename from fern/changelog/06-10-2024.md rename to fern/docs/changelog/06-10-2024.md diff --git a/fern/changelog/07-06-2024.md b/fern/docs/changelog/07-06-2024.md similarity index 100% rename from fern/changelog/07-06-2024.md rename to fern/docs/changelog/07-06-2024.md diff --git a/fern/changelog/08-23-2024.md b/fern/docs/changelog/08-23-2024.md similarity index 100% rename from fern/changelog/08-23-2024.md rename to fern/docs/changelog/08-23-2024.md