Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The API Description may include information about basic instructions (e.g., Getting Started) to users on how to use the API, such as host port, authentication, common error codes, test environment, etc., as well as links to additional resources (such as ONAP Use Cases), plus other details that would help other developers start using the API.

might want to The API Description should provide some basic instructions to users on how to use a Swagger viewer (e.g., Redoc, Swagger UI, etc.).

The API Description may be multiline, and GitHub Flavored Markdown, GFM syntax, can be used for rich text representation.

...

The description field within a path operation may be multiline, and GitHub Flavored Markdown, GFM syntax, can be used for rich text representation.

The description field within a path may provide example calls or usages of the operation.

Operation Tags

The tags field within a path operation MUST be present and non-empty.

...