Skip to content

Commit

Permalink
docs(spec): clarify File Structure section
Browse files Browse the repository at this point in the history
  • Loading branch information
char0n committed Aug 4, 2021
1 parent 63dc25a commit 3a54b7e
Showing 1 changed file with 2 additions and 3 deletions.
5 changes: 2 additions & 3 deletions spec/asyncapi.md
Original file line number Diff line number Diff line change
Expand Up @@ -133,9 +133,8 @@ In order to preserve the ability to round-trip between YAML and JSON formats, YA

### <a name="file-structure"></a>File Structure

The A2S representation of the API is made of a single file.
However, parts of the definitions can be split into separate files, at the discretion of the user.
This is applicable for `$ref` fields in the specification as follows from the [JSON Schema](https://json-schema.org/understanding-json-schema/structuring.html) definitions.
An AsyncAPI document MAY be made up of a single document or be divided into multiple,
connected parts at the discretion of the author. In the latter case, [Reference Objects](#referenceObject) are used.

By convention, the AsyncAPI Specification (A2S) file is named `asyncapi.json` or `asyncapi.yaml`.

Expand Down

0 comments on commit 3a54b7e

Please sign in to comment.