Referencing multiple pre-defined swagger 2.0 parameter definitions throwing error

Question

I've got two re-usable parameters defined in my swagger 2.0 file:

parameters:
  cursorParam:
    name: cursor
    in: query
    description: Pagination cursor.
    required: false
    type: string       
  limitParam:
    name: limit
    in: query
    description: Result limiter.
    required: false
    type: integer

And then in my route definitions (a GET in this case) I'm trying to reference both like this:

parameters:
    - $ref: '#/parameters/cursorParam'
    - $ref: '#/parameters/limitParam'

If I use one $ref, it seems to work OK (no compile errors), but if I try using both, it gawks at me:

Operation parameter already defined: undefined
at paths ▹ /users ▹ get ▹ parameters ▹ 1 ▹ name

Operation parameter already defined: undefined
at paths ▹ /authorisations ▹ get ▹ parameters ▹ 1 ▹ name

Moreover, if I pass these parameters in the query string and output req.swagger.params, I get an empty object. What am I doing wrong?

Here's a full SSCCE of the spec, generating the same error:

swagger: "2.0"
info:
  version: "0.0.1"
  title: Test
# during dev, should point to your local machine
host: localhost
# basePath prefixes all resource paths 
basePath: /
# 
schemes:
  # tip: remove http to make production-grade
  - http
  - https
# format of bodies a client can send (Content-Type)
consumes:
  - application/json
# format of the responses to the client (Accepts)
produces:
  - application/json
x-a127-config: {}
x-volos-resources: {}
paths:
  /authorisations:
    x-swagger-router-controller: authorizations
    x-volos-authorizations: {}
    x-volos-apply: {}
    get:
      description: Returns all authorizations. Requires administrator rights to view unfiltered results, or if authenticated, returns the authorization entity belonging to the OAuth token.
      operationId: authorizationsGetAll #controller method name
      parameters:
        - $ref: '#/parameters/cursorParam'
        - $ref: '#/parameters/limitParam'
      responses:
        200:
          description: OK

# reusable parameters have parameter definitions
parameters:
  cursorParam:
    name: cursor
    in: query
    description: Pagination cursor passed to a BaaS collection. Note that if this parameter is present, lastAccessedTimestamp.{channelType} should not be updated.
    required: false
    type: string       
  limitParam:
    name: limit
    in: query
    description: Result limiter to be passed to a BaaS collection.
    required: false
    type: integer

Yeah, added. It's a bit of a beast, but I trimmed it down as much as I could to reproduce the errors. — brandonscript, Dec 23 '14 at 20:24
Aha, you didn't mention in the question that you're talking about the apigee127 tool and I had assumed the error is from the swagger-editor. I'll try to get someone from the apigee team to look at it. — Ron, Dec 23 '14 at 20:28
Yeah.... ooops ;) Looks like Jeremy's got a point, I'll update. — brandonscript, Dec 23 '14 at 20:35

score 2 · Accepted Answer · answered Dec 23 '14 at 20:32

2

It appears you are using an old version of a127. The lack of reference support in all parts of the Swagger document were fixed recently so updating should fix this.

answered Dec 23 '14 at 20:32

Jeremy Whitlock

3,808
26
16

Thanks Jeremy. Silly question after all then. Haha and #protip: `apigee127` != `apigee-127` when using NPM so I discovered this morning. – brandonscript Dec 23 '14 at 20:37
Glad to help, sorry it too so long to respond and thanks webron for getting me involved. – Jeremy Whitlock Dec 23 '14 at 20:45
No worries! Oddly I did `npm -g update apigee127` and I'm still not showing the correct version. Am I missing something? – brandonscript Dec 23 '14 at 20:46
`npm -g install apigee-127` – Jeremy Whitlock Dec 23 '14 at 20:47

Referencing multiple pre-defined swagger 2.0 parameter definitions throwing error

1 Answers1