Skip to content

feat(docs): init changelog #54

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

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).

</div>

Expand Down Expand Up @@ -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:

Expand Down Expand Up @@ -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.
17 changes: 17 additions & 0 deletions fern/docs/changelog/06-10-2024.md
Original file line number Diff line number Diff line change
@@ -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.
16 changes: 16 additions & 0 deletions fern/docs/changelog/07-06-2024.md
Original file line number Diff line number Diff line change
@@ -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.
15 changes: 15 additions & 0 deletions fern/docs/changelog/08-23-2024.md
Original file line number Diff line number Diff line change
@@ -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`

```
4 changes: 2 additions & 2 deletions fern/docs/pages/sdks.mdx
Original file line number Diff line number Diff line change
@@ -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
---

Expand Down Expand Up @@ -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.
12 changes: 6 additions & 6 deletions fern/docs/pages/welcome.mdx
Original file line number Diff line number Diff line change
@@ -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.
Expand All @@ -14,9 +14,9 @@ Here you'll find information about managing your plants, customers, and orders f
<Cards>
<Card title="API Reference" icon="fa-solid fa-code" href="/api-reference" />
<Card
title="Discord Community"
icon="fa-brands fa-discord"
href="https://discord.com/invite/JkkXumPzcG"
title="Slack Community"
icon="fa-brands fa-slack"
href="https://join.slack.com/t/fern-community/shared_invite/zt-2dpftfmif-MuAegl8AfP_PK8s2tx350Q"
/>
<Card
title="Blog"
Expand Down
2 changes: 1 addition & 1 deletion fern/fern.config.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"organization": "plantstore",
"version": "0.37.6"
"version": "0.39.19"
}
1 change: 1 addition & 0 deletions fern/generators.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{}
Loading