Skip to content
This repository has been 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

Open
jsamr opened this issue Aug 16, 2018 · 0 comments

Comments

@jsamr
Copy link

jsamr commented Aug 16, 2018

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:
      ...
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant