How to define multiple objects to the definitions or components

[BhanuKiranChaluvadi]

Hi ,

I have a definition (swagger-2.0)

  ErrorCode:
    type: object
    properties:
      code:
        type: integer
      field: 
        type: string 

I would like to add possible value for this structure into openapi documentation. Practically, code and field corresponds to the same thing (one in numerical and the other in English). I would like all the possible objects be part of the openAPI document, so the client can translate them into multiple languages if needed.
For example

{
	{
		code: 1001
		field: "missing_file"
	},
	{
		code: 1002
		field: "invalid_file"
	},
	{
		code: 1003
		field: "large_file"
	},
	...
}

How to specify all the ErrorCode in the openapi document

[rafalkrupinski]

ErrorCode:
    type: object
    properties:
      code:
        type: integer
      field: 
        type: string 
    enum:
    - code: 1001
      field: missing_file
    - code: 1002
      field: invalid_file
...

[BhanuKiranChaluvadi]

@rafalkrupinski
I tried a simple swagger2.0

swagger: "2.0"
info:
  title: Sample API
  description: API description in Markdown.
  version: 1.0.0

host: api.example.com
basePath: /v1
schemes:
  - https

paths:
  /users:
    get:
      summary: Returns a list of users.
      description: Optional extended description in Markdown.
      produces:
        - application/json
      responses:
        200:
          description: OK

definitions:
  ErrorCode:
    type: object
    properties:
      code:
        description: Api context code
        type: integer
      value:
        description: Api context value in english language
        type: string
    enum:
    - code: 1001
      value: failed_installation
    - code: 1010
      value: failed_update
    - code: 1020
      value: failed_info
      
  Colors:
    type: string
    enum:
      - black
      - white
      - red
      - green
      - blue

The generate UI (html) document does not include the ErrorCode enum values, but Colors enum values were present.

[rafalkrupinski]

Enum values can be of any type. It's another matter whether your client supports them.

[handrews]

Answered from the spec perspective, tooling support questions should go to tooling vendors, so closing this.