Forum Discussion

Prasanna_Ailuri's avatar
Prasanna_Ailuri
New Contributor
3 years ago

Need $ref as a variable in open-api-spec.yml file

Hi Team,   I am using Open-API-SPEC 3.0 and have a requirement to build the below mentioned object          {             "value": "a12345",             "$ref": "https://example.com/v3/Resources...
Swagger Codegen
Swagger Core
frankkilcommins's avatar
frankkilcommins
Staff
3 years ago

Hi Prasanna_Ailuri 

 

Could you share your OpenAPI 3.0 definition? I'm not sure based on above what you are trying to achieve.

 

Thanks,

Frank

  • Prasanna_Ailuri's avatar
    Prasanna_Ailuri
    New Contributor
    3 years ago

    Hi frankkilcommins ,

     

    We have an endpoint which returns objects as an array of below mentioned JSON:

            {
                "value": "a12345",
                "$ref": "https://example.com/v3/Resources/a12345",
                "display": "Resource-a12345"
            }

    Thanks,

    Prasanna

    • Prasanna_Ailuri's avatar
      Prasanna_Ailuri
      New Contributor
      3 years ago

      paths:
      /users:
      get:
      summary: Returns a list of users.
      description: Optional extended description in CommonMark or HTML.
      responses:
      '200': # status code
      description: A JSON array of user names
      content:
      application/json:
      schema:
      type: array
      items:
      $ref: '#/components/schemas/Response'
      components:
      schemas:
      Response:
      type: object
      properties:
      id:
      type: string
      meta:
      type: array
      items:
      $ref: '#/components/schemas/Metadata'
      Metadata:
      required:
      - value
      type: object
      properties:
      value:
      type: string
      display:
      type: string
      $ref:
      type: string