Fern Definition 中的可用性

您可以在 Fern Definition 中向端点、类型或属性添加 availability。您可以在 docs.yml 文件中配置 API Reference 文档中各部分的 availability。

端点、类型和属性

可用性可以是：

值	描述	标签
`alpha`	早期实验性发布	`Alpha`
`in-development`	正在开发中	`Beta`
`beta`	可用但可能会改变	`Beta`
`pre-release`	可用	`Beta`
`preview`	功能完整但可能会改变	`Preview`
`generally-available`	稳定且可用	`GA`
`deprecated`	将来会被移除	`Deprecated`
`legacy`	已被替代但仍然支持	`Legacy`

端点

pet.yml

1 service:
2   base-path: /pet
3   auth: true
4   endpoints:
5     add:
6       availability: deprecated
7       display-name: Add pet
8       docs: Add a new Pet to the store
9       method: POST
10       path: ""
11       request: AddPetRequest
12       response: Pet

在 Fern Docs 中，这将显示为：

Screenshot showing a deprecated tag next to an endpoint in API Reference docs

类型

pet.yml

1   Pet:
2     properties:
3       id: 
4         type: integer
5         docs: A unique ID for the Pet
6       name: 
7         type: string
8         docs: The first name of the Pet
9       photoUrls: 
10         type: list<string>
11         docs: A list of publicly available URLs featuring the Pet
12         availability: generally-available
13       category: 
14         type: optional<Category>
15         availability: pre-release
16 
17   Category:
18     properties:
19       id: optional<integer>
20       name: optional<string>

在 Fern Docs 中，这将显示为：

Screenshot showing a beta tag next to a type in API Reference docs

属性

pet.yml

1   Pet:
2     properties:
3       id: 
4         type: integer
5         docs: A unique ID for the Pet
6       name: 
7         type: string
8         docs: The first name of the Pet
9       photoUrls: 
10         type: list<string>
11         docs: A list of publicly available URLs featuring the Pet
12         availability: deprecated
13       category: optional<Category>

在 Fern Docs 中，这将显示为：

Screenshot showing a deprecated tag next to a type's property in API Reference docs

部分

You can set the availability for the entire API reference or for specific sections in your docs.yml configuration. Options are: stable, generally-available, in-development, pre-release, deprecated, alpha, beta, preview, or legacy.

When you set the availability of a section, all of the endpoints in that section are automatically marked with that availability unless explicitly set otherwise.

docs.yml

1 navigation: 
2   - api: API Reference
3     availability: generally-available
4     layout: 
5       - section: My Section
6         availability: beta
7         icon: flower
8         contents: 
9         # endpoints here

您可以在 Fern Definition 中向端点、类型或属性添加 availability。您可以在 docs.yml 文件中配置 API Reference 文档中各部分的 availability。

端点、类型和属性

可用性可以是：

值	描述	标签
`alpha`	早期实验性发布	`Alpha`
`in-development`	正在开发中	`Beta`
`beta`	可用但可能会改变	`Beta`
`pre-release`	可用	`Beta`
`preview`	功能完整但可能会改变	`Preview`
`generally-available`	稳定且可用	`GA`
`deprecated`	将来会被移除	`Deprecated`
`legacy`	已被替代但仍然支持	`Legacy`

端点

pet.yml

1 service:
2   base-path: /pet
3   auth: true
4   endpoints:
5     add:
6       availability: deprecated
7       display-name: Add pet
8       docs: Add a new Pet to the store
9       method: POST
10       path: ""
11       request: AddPetRequest
12       response: Pet

在 Fern Docs 中，这将显示为：

类型

pet.yml

1   Pet:
2     properties:
3       id: 
4         type: integer
5         docs: A unique ID for the Pet
6       name: 
7         type: string
8         docs: The first name of the Pet
9       photoUrls: 
10         type: list<string>
11         docs: A list of publicly available URLs featuring the Pet
12         availability: generally-available
13       category: 
14         type: optional<Category>
15         availability: pre-release
16 
17   Category:
18     properties:
19       id: optional<integer>
20       name: optional<string>

在 Fern Docs 中，这将显示为：

属性

pet.yml

1   Pet:
2     properties:
3       id: 
4         type: integer
5         docs: A unique ID for the Pet
6       name: 
7         type: string
8         docs: The first name of the Pet
9       photoUrls: 
10         type: list<string>
11         docs: A list of publicly available URLs featuring the Pet
12         availability: deprecated
13       category: optional<Category>

在 Fern Docs 中，这将显示为：

部分

When you set the availability of a section, all of the endpoints in that section are automatically marked with that availability unless explicitly set otherwise.

docs.yml

1 navigation: 
2   - api: API Reference
3     availability: generally-available
4     layout: 
5       - section: My Section
6         availability: beta
7         icon: flower
8         contents: 
9         # endpoints here

1	service:
2	base-path: /pet
3	auth: true
4	endpoints:
5	add:
6	availability: deprecated
7	display-name: Add pet
8	docs: Add a new Pet to the store
9	method: POST
10	path: ""
11	request: AddPetRequest
12	response: Pet

1	Pet:
2	properties:
3	id:
4	type: integer
5	docs: A unique ID for the Pet
6	name:
7	type: string
8	docs: The first name of the Pet
9	photoUrls:
10	type: list<string>
11	docs: A list of publicly available URLs featuring the Pet
12	availability: generally-available
13	category:
14	type: optional<Category>
15	availability: pre-release
16
17	Category:
18	properties:
19	id: optional<integer>
20	name: optional<string>

1	navigation:
2	- api: API Reference
3	availability: generally-available
4	layout:
5	- section: My Section
6	availability: beta
7	icon: flower
8	contents:
9	# endpoints here