How to create an array in OpenAPI with 3 elements and 2 enums

Creating an array in OpenAPI with three elements and two enums may sound complicated, but don't worry! In this article, we will guide you through the process step by step, making it easy for even entry-level users to understand.

First, let's understand what an array is. An array is a data structure that allows you to store multiple values of the same type in a single variable. In OpenAPI, arrays are represented using the type: array keyword.

To create an array with three elements, you need to define the array in your OpenAPI specification with the items keyword. Let's say we want to create an array of colors. Here's an example:

{
  "type": "array",
  "items": {
    "type": "string"
  },
  "minItems": 3,
  "maxItems": 3
}

In the above example, we have specified the type of the array as string, indicating that each element in the array will be a string. The minItems and maxItems properties are set to 3, ensuring that the array will always have three elements.

Now, let's move on to adding enums to our array. Enum, short for enumeration, is a list of predefined values that a variable can take. In OpenAPI, enums are represented using the enum keyword.

Let's say we want to create an array of fruits, but we only want to allow the values "apple" and "banana". Here's an example:

{
  "type": "array",
  "items": {
    "type": "string",
    "enum": ["apple", "banana"]
  },
  "minItems": 3,
  "maxItems": 3
}

In the above example, we have added the enum property to the items keyword. This ensures that each element in the array can only be either "apple" or "banana".

Now that we have defined our array with three elements and two enums, let's see how we can use it in an OpenAPI specification. Here's an example of how you can define a parameter with this array:

{
  "paths": {
    "/fruits": {
      "get": {
        "parameters": [
          {
            "name": "selectedFruits",
            "in": "query",
            "description": "Selected fruits",
            "required": true,
            "schema": {
              "type": "array",
              "items": {
                "type": "string",
                "enum": ["apple", "banana"]
              },
              "minItems": 3,
              "maxItems": 3
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }
  }
}

In the above example, we have defined a GET endpoint for the path "/fruits". The parameters property contains an array with a single parameter named "selectedFruits". This parameter is of type array and follows the same schema we defined earlier with three elements and two enums.

That's it! You have successfully created an array in OpenAPI with three elements and two enums. Now you can use this array in your API specifications to define parameters, request bodies, or response bodies.

In this article, we learned how to create an array in OpenAPI with three elements and two enums. We saw that arrays are defined using the type: array keyword, and the number of elements is specified using the minItems and maxItems properties. We also learned how to add enums to our array using the enum keyword. Finally, we saw an example of how to use this array in an OpenAPI specification.

References