Forum Discussion

BostonKevin's avatar
BostonKevin
Contributor
6 years ago

Way to Model Response An Array of Different Objects With Identical Properties

Hi!   In Swagger Editor is there a way to model an array of objects each of which has identical properties but with different values for these properties?  This array is in a response to a delete...
  • RonRatovsky's avatar
    RonRatovsky
    6 years ago

    Okay, that will not produce what you want. Please read https://swagger.io/docs/specification/adding-examples/ for a deeper explanation on how to add examples to responses. It should give you enough information on the right steps. If you run into any issues, please share the definitiion you got to and we'll take it from there.

     

    As a side note - the Editor is intended to be used with YAML and not JSON. By using JSON, you will not get some of the benefits of the editor. Converting to YAML would be as simple as copying the JSON and pasting it again into the Editor. It will automatically detect it and ask if you want to convert it to YAML.

BostonKevin's avatar
BostonKevin
Contributor

Each one of those objects is unique, even if it does not look so.  In order to describe all the data that is returned i.e. information on the number of rows deleted from different tables, in the Swagger Editor, each of the objects would have to have a unique ID of some kind.  In the example i provided, the 'ID' is the value of the table_name field. As a result,  I cannot model the full response.

 

If each one of those objects were defined as a distinct kind of object in an array, I could model the complete response i.e. precise information on the rows deleted in different tables.  Do you see what I mean?

 

I think that this is more of a coding issue  than a Swagger issue, and will suggest a coding change to the development team. 

RonRatovsky's avatar
RonRatovsky
Staff
6 years ago

Unfortunately, I don't understand the problem. In the example you provided, each array entry is an object with two properties.rows_deleted and table_name. The fact that they have different values in the actual response doesn't change anything with regard to the modeling. rows_deleted would be of type integer, table_name would be a string, and that's pretty much it. What am I missing?

  • BostonKevin's avatar
    BostonKevin
    Contributor
    6 years ago

    What I am trying to do with Swagger Editor is model the response that occurs when a project is deleted.  The response is an array of objects, each of which consists of 2 properties - rows_deleted and table_name.  When I try to model this array consisting of several identical objects, I get the message

    duplicated mapping key

    In other words, I cannot represent the entire response to the delete operation.  Or perhaps there is? 

    • RonRatovsky's avatar
      RonRatovsky
      Staff
      6 years ago

       Can you share the definition that causes that error?

      • BostonKevin's avatar
        BostonKevin
        Contributor
        6 years ago

        The response from the DELETE operations is as follows:

        {
  "changes_made": [
    {
      "rows_deleted": 0,
      "table_name": "user_project"
    },
    {
      "rows_deleted": 0,
      "table_name": "test_job"
    },
    {
      "rows_deleted": 0,
      "table_name": "project_info"
    }
  ]
}

        I have defined the following response with Swagger Editor:

              "inline_response_DELETE_Project_200": {
        "type": "object",
        "properties": {
          "changes_made": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "rows_deleted": {
                  "type": "string",
                  "description": "The number of rows deleted when the project was deleted.",
                  "example": "0"
                  },
                "table_name": {
                  "type": "string",
                  "description": "The name of the table where the row was deleted.",
                  "example": "user_project"
                  },
              }
            }
          }
        }
      },

        Unfortunately, I cannot define as part of the response the test_job and project_info objects, as part of the array.  I cannot save the JSON file when I attempt to do this.  

         

        Do you understand now?