在AsyncAPI规范中,您可以使用枚举来提供可选值的列表。有时,您可能需要为每个枚举值提供更多的描述信息。这可以通过在枚举中使用对象来完成。以下是一个示例:
channels:
exampleChannel:
publish:
message:
payload:
type: object
properties:
status:
type: string
enum:
- pass
- fail
- blocked
enumDescriptions:
pass: Description of the pass status
fail: Description of the fail status
blocked: Description of the blocked status
在这个例子中,我们定义了一个payload对象,其中有一个status属性,它是一个字符串类型的枚举。我们使用了enumDescriptions属性来提供关于每个枚举值的详细描述。
在您的实现中,您可以根据需要添加更多的属性来提供更多的描述信息。这些描述可以帮助其他人更好地理解您的API规范。