How do I reference the same schema as a property?

Question

I have the following in my oas.yaml file:

components:
  schemas:
    ServiceError:
      type: object
      properties:
        Message:
          type: string
          description: "The exception message."
        ExceptionMessage:
          type: string
        Type:
          type: string
          description: "The exception type.""
        InnerError:
            $ref: '#/components/schemas/ServiceError'
             description: "If there's an inner exception, the InnerException.

    Property:
      type: object
      properties:
        Name:
          type: string
          description: Name of the property.

It does not like the line "description: "If there's an inner exception, the InnerException." and if I remove that, it does not like the line "Property:". I've tried a lot of things and nothing works. What am I not understanding?

It doesn't like `InnerError.description` because there's no ending quote in it. And, as Martin said, there's an extra quote at the end of `Type.descritption`. You need to fix the quotes. — Helen, May 11 '20 at 09:57

Martin Hauner · Accepted Answer · 2020-05-10T13:51:43.857

2

a description is not allowed at the $ref. See this answer.
Before InnnerError are two '"'. Not sure if this is just a copy paste bug.

edited May 10 '20 at 13:51

answered May 10 '20 at 06:44

Martin Hauner

1,593
1
9
15

If no description is allowed, how do I get a comment for that property in the generated code? Thanks – David Thielen May 10 '20 at 13:11
The `ServiceError` itself can have a `description`. https://stackoverflow.com/a/41752575/1262371 shows a workaround using `allOf`. – Martin Hauner May 10 '20 at 13:46

How do I reference the same schema as a property?

1 Answers1