Skip to content
This repository was archived by the owner on Sep 6, 2019. It is now read-only.
This repository was archived by the owner on Sep 6, 2019. It is now read-only.

In RAML 1 to OAS3 conversion, resource description should not be a lost semantic #48

@jsamr

Description

@jsamr

From OAS3 specifications:

Paths may have an optional short summary and a longer description for documentation purposes. This information is supposed to be relevant to all operations in this path. description can be multi-line and supports Markdown (CommonMark) for rich text representation.

Example

paths:
  /users/{id}:
    summary: Represents a user
    description: >
      This resource represents an individual user in the system.
      Each user is identified by a numeric `id`.
    get:
      ...
    patch:
      ...
    delete:
      ...

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions