Re-usable enums in path/query parameters

[marcus-maws]

I've been told that it's not possible to use schemas in path/query parameters, but I have a case where multiple paths use the same enum pattern for inputs.

For example, I have the following pattern that is duplicated over many paths:

parameters:
- in: "query"
  ...
  enum: 
  - id
  - sku
  - guid
  - stock
  ...

Is it possible to generalize this in some way, so that I don't have to define them for each path, but can just reference them?

[webron]

I think we've had a similar issue about it, or someone was talking about it in the mailing list. I think it's a fair request to avoid repetitions for 'primitive' definitions as well and it's something we should look into in the next version of the spec.

[marcus-maws]

OK, thanks for the quick response.

[webron]

No, don't close it :) It's good to get feedback from others as well.

[marcus-maws]

OK. :-)

[marcus-maws]

On a separate issue (touched on in #290), I have a situation where multiple paths can take the same collection of parameters. It appears that again, I have to define all those parameters individually for each path. Being able to separate all those parameters would be useful as well.

[webron]

That should be a separate issue though. However, you can define parameters in a single place and then refer to them from multiple paths.

[mohsen1]

If you're writing you specs in YAML you can take advantage of YAML anchors to avoid reputations.

[webron]

But since there's a solution for that in the spec, it's better to utilize than than to utilize a solution that's can't be converted back and forth between JSON and YAML.

[webron]

My bad, I thought @mohsen1 referred to repeating the parameters. His solution is most certainly valid for the original request though!

[JamesMessinger]

This is already doable, though perhaps not very intuitive:
https://github.com/BigstickCarpet/swagger-parser/blob/master/tests/files/non-object-refs.yaml#L40

[Ckim15]

@mohsen1, Could you provide a working sample yaml spec where I can avoid repetition for enum?

I checked BigStickCarpet's url (https://github.com/BigstickCarpet/swagger-parser/blob/master/tests/files/non-object-refs.yaml#L40), It doesn't work.

[mohsen1]

@chanthakim15 Here is a quick example

---
swagger: '2.0'
info:
  version: 1.0.0
  title: Pets Store
paths:
  /pets:
    get:
      responses:
        200:
          description: Returns all the pets
          schema:
            $ref: '#/definitions/List'
        201:
          description: Returns all the pets
          schema:
            $ref: '#/definitions/Set'

definitions:
  List:
    type: string
    enum: &my-list
      - one
      - two
      - three
  Set:
    type: string
    enum: *my-list

@BigstickCarpet's example is correct. If any of swagger tools is not supporting it, it's a bug. Please file a bug for it.