question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

How to use parameters list from the schema?

See original GitHub issue

Hello. Is there is any way to define the parameters list of the path by extending parameters from the schema?

openapi: "3.0.0"
info:
  title: Demo
  version: 1.0.0

paths:
  /api/v3/places/poi:
    get:
      tags:
        - places
      summary: 'Get POI data'
      operationId: poi
      parameters:
        # This causes an error
        $ref: '#/components/schemas/POIRequest'
      responses:
        '200':
          description: Success

components:
  schemas:
    POIRequest:
      title: 'Points of intereset search request'
      required:
        - lat
        - lng
      properties:
        lat:
          description: 'Point''s latitude'
          type: number
          format: float
          maximum: 90
          minimum: -90
        lng:
          description: 'Point''s longitude'
          type: number
          format: float
          maximum: 180
          minimum: -180
        lang:
          description: 'Prefered language for results'
          type: string
          default: en
          example: ru
      type: object

Issue Analytics

  • State:closed
  • Created 3 years ago
  • Comments:6 (4 by maintainers)

github_iconTop GitHub Comments

1reaction
hkosovacommented, Jun 9, 2020

@erickskrauch Do you maybe mean something like this?

      parameters:
        - in: query
          name: poi
          schema:
            $ref: '#/components/schemas/POIRequest'
          style: form
          explode: true

This is considered a single parameter with an object value, but this object will be sent as individual property=value query parameters in the request URL:

GET /api/v3/places/poi?lat=10&long=20&lang=en
0reactions
hkosovacommented, Jun 9, 2020
Read more comments on GitHub >

github_iconTop Results From Across the Web

Parameter List for all SQL Server Stored Procedures and ...
In this tip we look at a simple query you can use to get a list of parameters for all stored procedures and...
Read more >
Describing Parameters - Swagger
In OpenAPI, a path parameter is defined using in: path . ... To describe the parameter contents, you can use either the schema...
Read more >
Feature and table schemas for task parameters—ArcMap
When publishing geoprocessing tasks, the schema for feature and table parameters comes from the schema of the input.
Read more >
Django REST Framework Schema parameters list in the ...
Django REST Framework Schema parameters list in the ViewSet action ; # views.py class ; class Meta ; 'id', 'project' ; FileViewSet(viewsets.
Read more >
Create a parameter query (Power Query) - Microsoft Support
To use an existing parameter, select Parameter, and then select the parameter you want from the list that appears on the right. To...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found