API tools faq
paste
Advertisement
Guest User

Untitled

a guest
Jul 8th, 2023
33
0
Never
Add comment
Not a member of Pastebin yet? Sign Up, it unlocks many cool features!
JSON 34.87 KB | None | 0 0
raw download clone embed print report
  1. {
  2.    "openapi":"3.0.3",
  3.    "info":{
  4.       "title":"Demo API",
  5.       "description":"This documentation has been automatically generated by Treblle. Visit https:\/\/treblle.com\/ and get started for FREE.",
  6.       "version":"1.0.0"
  7.    },
  8.    "servers":[
  9.       {
  10.          "url":"https:\/\/demo.treblle.com\/api\/v1\/"
  11.       }
  12.    ],
  13.    "paths":{
  14.       "\/articles":{
  15.          "get":{
  16.             "operationId":"ff45c497-9c15-4b31-a2b0-c4adf11fa764",
  17.             "tags":[
  18.                "articles"
  19.             ],
  20.             "parameters":[
  21.                {
  22.                   "name":"page",
  23.                   "in":"query",
  24.                   "required":false,
  25.                   "schema":{
  26.                      "type":"string"
  27.                   }
  28.                },
  29.                {
  30.                   "name":"bearer_token",
  31.                   "in":"query",
  32.                   "required":false,
  33.                   "schema":{
  34.                      "type":"string"
  35.                   }
  36.                },
  37.                {
  38.                   "name":"token0a192d79-3c8a-398b-836f-bc526ec52d9euserNamepasswordusernameOrEmail",
  39.                   "in":"query",
  40.                   "required":false,
  41.                   "schema":{
  42.                      "type":"string"
  43.                   }
  44.                }
  45.             ],
  46.             "responses":{
  47.                "200":{
  48.                   "description":"GET \/articles",
  49.                   "content":{
  50.                      "application\/json":{
  51.                         "schema":{
  52.                            "type":"object",
  53.                            "properties":{
  54.                               "code":{
  55.                                  "type":"string"
  56.                               },
  57.                               "status":{
  58.                                  "type":"string"
  59.                               },
  60.                               "message":{
  61.                                  "type":"string"
  62.                               },
  63.                               "articles":{
  64.                                  "type":"array",
  65.                                  "items":{
  66.                                     "type":"object",
  67.                                     "properties":{
  68.                                        "uuid":{
  69.                                           "type":"string"
  70.                                        },
  71.                                        "title":{
  72.                                           "type":"string"
  73.                                        },
  74.                                        "content":{
  75.                                           "type":"string"
  76.                                        },
  77.                                        "image":{
  78.                                           "type":"string"
  79.                                        },
  80.                                        "views":{
  81.                                           "type":"string"
  82.                                        },
  83.                                        "created":{
  84.                                           "type":"object",
  85.                                           "properties":{
  86.                                              "date":{
  87.                                                 "type":"string"
  88.                                              },
  89.                                              "timezone_type":{
  90.                                                 "type":"string"
  91.                                              },
  92.                                              "timezone":{
  93.                                                 "type":"string"
  94.                                              }
  95.                                           }
  96.                                        },
  97.                                        "user":{
  98.                                           "type":"object",
  99.                                           "properties":{
  100.                                              "name":{
  101.                                                 "type":"string"
  102.                                              },
  103.                                              "email":{
  104.                                                 "type":"string"
  105.                                              },
  106.                                              "phone_number":{
  107.                                                 "type":"string"
  108.                                              },
  109.                                              "created":{
  110.                                                 "type":"object",
  111.                                                 "properties":{
  112.                                                    "date":{
  113.                                                       "type":"string"
  114.                                                    },
  115.                                                    "timezone_type":{
  116.                                                       "type":"string"
  117.                                                    },
  118.                                                    "timezone":{
  119.                                                       "type":"string"
  120.                                                    }
  121.                                                 }
  122.                                              },
  123.                                              "uuid":{
  124.                                                 "type":"string"
  125.                                              }
  126.                                           }
  127.                                        }
  128.                                     }
  129.                                  }
  130.                               }
  131.                            }
  132.                         }
  133.                      }
  134.                   }
  135.                }
  136.             }
  137.          },
  138.          "post":{
  139.             "operationId":"23312472-5efb-41c7-8324-aa993bcc62a3",
  140.             "tags":[
  141.                "articles"
  142.             ],
  143.             "requestBody":{
  144.                "required":true,
  145.                "content":{
  146.                   "application\/x-www-form-urlencoded":{
  147.                      "schema":{
  148.                         "type":"object",
  149.                         "properties":{
  150.                            "title":{
  151.                               "type":"string"
  152.                            },
  153.                            "content":{
  154.                               "type":"string"
  155.                            },
  156.                            "image":{
  157.                               "type":"string"
  158.                            },
  159.                            "user":{
  160.                               "type":"string"
  161.                            }
  162.                         }
  163.                      }
  164.                   }
  165.                }
  166.             },
  167.             "responses":{
  168.                "200":{
  169.                   "description":"POST \/articles",
  170.                   "content":{
  171.                      "application\/json":{
  172.                         "schema":{
  173.                            "type":"object",
  174.                            "properties":{
  175.                               "code":{
  176.                                  "type":"string"
  177.                               },
  178.                               "status":{
  179.                                  "type":"string"
  180.                               },
  181.                               "message":{
  182.                                  "type":"string"
  183.                               },
  184.                               "article":{
  185.                                  "type":"object",
  186.                                  "properties":{
  187.                                     "uuid":{
  188.                                        "type":"string"
  189.                                     },
  190.                                     "title":{
  191.                                        "type":"string"
  192.                                     },
  193.                                     "content":{
  194.                                        "type":"string"
  195.                                     },
  196.                                     "image":{
  197.                                        "type":"string"
  198.                                     },
  199.                                     "views":{
  200.                                        "type":"string"
  201.                                     },
  202.                                     "created":{
  203.                                        "type":"object",
  204.                                        "properties":{
  205.                                           "date":{
  206.                                              "type":"string"
  207.                                           },
  208.                                           "timezone_type":{
  209.                                              "type":"string"
  210.                                           },
  211.                                           "timezone":{
  212.                                              "type":"string"
  213.                                           }
  214.                                        }
  215.                                     },
  216.                                     "user":{
  217.                                        "type":"object",
  218.                                        "properties":{
  219.                                           "name":{
  220.                                              "type":"string"
  221.                                           },
  222.                                           "email":{
  223.                                              "type":"string"
  224.                                           },
  225.                                           "phone_number":{
  226.                                              "type":"string"
  227.                                           },
  228.                                           "created":{
  229.                                              "type":"object",
  230.                                              "properties":{
  231.                                                 "date":{
  232.                                                    "type":"string"
  233.                                                 },
  234.                                                 "timezone_type":{
  235.                                                    "type":"string"
  236.                                                 },
  237.                                                 "timezone":{
  238.                                                    "type":"string"
  239.                                                 }
  240.                                              }
  241.                                           },
  242.                                           "uuid":{
  243.                                              "type":"string"
  244.                                           }
  245.                                        }
  246.                                     }
  247.                                  }
  248.                               }
  249.                            }
  250.                         }
  251.                      }
  252.                   }
  253.                }
  254.             }
  255.          }
  256.       },
  257.       "\/articles\/{uuid}":{
  258.          "get":{
  259.             "operationId":"3785d352-88ab-4b9d-a2d5-5ecc15cc3a24",
  260.             "tags":[
  261.                "articles"
  262.             ],
  263.             "parameters":[
  264.                {
  265.                   "name":"uuid",
  266.                   "in":"path",
  267.                   "required":true,
  268.                   "schema":{
  269.                      "type":"string"
  270.                   }
  271.                },
  272.                {
  273.                   "name":"user",
  274.                   "in":"query",
  275.                   "required":false,
  276.                   "schema":{
  277.                      "type":"string"
  278.                   }
  279.                }
  280.             ],
  281.             "responses":{
  282.                "200":{
  283.                   "description":"GET \/articles\/{uuid}",
  284.                   "content":{
  285.                      "application\/json":{
  286.                         "schema":{
  287.                            "type":"object",
  288.                            "properties":{
  289.                               "code":{
  290.                                  "type":"string"
  291.                               },
  292.                               "status":{
  293.                                  "type":"string"
  294.                               },
  295.                               "message":{
  296.                                  "type":"string"
  297.                               },
  298.                               "article":{
  299.                                  "type":"object",
  300.                                  "properties":{
  301.                                     "uuid":{
  302.                                        "type":"string"
  303.                                     },
  304.                                     "title":{
  305.                                        "type":"string"
  306.                                     },
  307.                                     "content":{
  308.                                        "type":"string"
  309.                                     },
  310.                                     "image":{
  311.                                        "type":"string"
  312.                                     },
  313.                                     "views":{
  314.                                        "type":"string"
  315.                                     },
  316.                                     "created":{
  317.                                        "type":"object",
  318.                                        "properties":{
  319.                                           "date":{
  320.                                              "type":"string"
  321.                                           },
  322.                                           "timezone_type":{
  323.                                              "type":"string"
  324.                                           },
  325.                                           "timezone":{
  326.                                              "type":"string"
  327.                                           }
  328.                                        }
  329.                                     },
  330.                                     "user":{
  331.                                        "type":"object",
  332.                                        "properties":{
  333.                                           "name":{
  334.                                              "type":"string"
  335.                                           },
  336.                                           "email":{
  337.                                              "type":"string"
  338.                                           },
  339.                                           "phone_number":{
  340.                                              "type":"string"
  341.                                           },
  342.                                           "created":{
  343.                                              "type":"object",
  344.                                              "properties":{
  345.                                                 "date":{
  346.                                                    "type":"string"
  347.                                                 },
  348.                                                 "timezone_type":{
  349.                                                    "type":"string"
  350.                                                 },
  351.                                                 "timezone":{
  352.                                                    "type":"string"
  353.                                                 }
  354.                                              }
  355.                                           },
  356.                                           "uuid":{
  357.                                              "type":"string"
  358.                                           }
  359.                                        }
  360.                                     }
  361.                                  }
  362.                               }
  363.                            }
  364.                         }
  365.                      }
  366.                   }
  367.                }
  368.             }
  369.          }
  370.       },
  371.       "\/articles\/{uuid}\/favorite":{
  372.          "post":{
  373.             "operationId":"6ced8e98-54db-4f8b-9b92-0170b751b874",
  374.             "tags":[
  375.                "articles"
  376.             ],
  377.             "requestBody":{
  378.                "required":true,
  379.                "content":{
  380.                   "application\/x-www-form-urlencoded":{
  381.                      "schema":{
  382.                         "type":"object",
  383.                         "properties":{
  384.                            "user":{
  385.                               "type":"string"
  386.                            }
  387.                         }
  388.                      }
  389.                   }
  390.                }
  391.             },
  392.             "parameters":[
  393.                {
  394.                   "name":"uuid",
  395.                   "in":"path",
  396.                   "required":true,
  397.                   "schema":{
  398.                      "type":"string"
  399.                   }
  400.                }
  401.             ],
  402.             "responses":{
  403.                "200":{
  404.                   "description":"POST \/articles\/{uuid}\/favorite",
  405.                   "content":{
  406.                      "application\/json":{
  407.                         "schema":{
  408.                            "type":"object",
  409.                            "properties":{
  410.                               "code":{
  411.                                  "type":"string"
  412.                               },
  413.                               "status":{
  414.                                  "type":"string"
  415.                               },
  416.                               "message":{
  417.                                  "type":"string"
  418.                               },
  419.                               "article":{
  420.                                  "type":"object",
  421.                                  "properties":{
  422.                                     "uuid":{
  423.                                        "type":"string"
  424.                                     },
  425.                                     "title":{
  426.                                        "type":"string"
  427.                                     },
  428.                                     "content":{
  429.                                        "type":"string"
  430.                                     },
  431.                                     "image":{
  432.                                        "type":"string"
  433.                                     },
  434.                                     "views":{
  435.                                        "type":"string"
  436.                                     },
  437.                                     "created":{
  438.                                        "type":"object",
  439.                                        "properties":{
  440.                                           "date":{
  441.                                              "type":"string"
  442.                                           },
  443.                                           "timezone_type":{
  444.                                              "type":"string"
  445.                                           },
  446.                                           "timezone":{
  447.                                              "type":"string"
  448.                                           }
  449.                                        }
  450.                                     },
  451.                                     "user":{
  452.                                        "type":"object",
  453.                                        "properties":{
  454.                                           "name":{
  455.                                              "type":"string"
  456.                                           },
  457.                                           "email":{
  458.                                              "type":"string"
  459.                                           },
  460.                                           "phone_number":{
  461.                                              "type":"string"
  462.                                           },
  463.                                           "created":{
  464.                                              "type":"object",
  465.                                              "properties":{
  466.                                                 "date":{
  467.                                                    "type":"string"
  468.                                                 },
  469.                                                 "timezone_type":{
  470.                                                    "type":"string"
  471.                                                 },
  472.                                                 "timezone":{
  473.                                                    "type":"string"
  474.                                                 }
  475.                                              }
  476.                                           },
  477.                                           "uuid":{
  478.                                              "type":"string"
  479.                                           }
  480.                                        }
  481.                                     }
  482.                                  }
  483.                               }
  484.                            }
  485.                         }
  486.                      }
  487.                   }
  488.                }
  489.             }
  490.          }
  491.       },
  492.       "\/auth\/login":{
  493.          "post":{
  494.             "operationId":"57a9034f-2b78-4c26-a54e-61c2c0d84e0c",
  495.             "tags":[
  496.                "auth"
  497.             ],
  498.             "requestBody":{
  499.                "required":true,
  500.                "content":{
  501.                   "application\/x-www-form-urlencoded":{
  502.                      "schema":{
  503.                         "type":"object",
  504.                         "properties":{
  505.                            "email":{
  506.                               "type":"string"
  507.                            },
  508.                            "password":{
  509.                               "type":"string"
  510.                            },
  511.                            "token":{
  512.                               "type":"string"
  513.                            },
  514.                            "bearer_token":{
  515.                               "type":"string"
  516.                            }
  517.                         }
  518.                      }
  519.                   }
  520.                }
  521.             },
  522.             "responses":{
  523.                "200":{
  524.                   "description":"POST \/auth\/login",
  525.                   "content":{
  526.                      "application\/json":{
  527.                         "schema":{
  528.                            "type":"object",
  529.                            "properties":{
  530.                               "code":{
  531.                                  "type":"string"
  532.                               },
  533.                               "status":{
  534.                                  "type":"string"
  535.                               },
  536.                               "message":{
  537.                                  "type":"string"
  538.                               },
  539.                               "user":{
  540.                                  "type":"object",
  541.                                  "properties":{
  542.                                     "name":{
  543.                                        "type":"string"
  544.                                     },
  545.                                     "email":{
  546.                                        "type":"string"
  547.                                     },
  548.                                     "phone_number":{
  549.                                        "type":"string"
  550.                                     },
  551.                                     "created":{
  552.                                        "type":"object",
  553.                                        "properties":{
  554.                                           "date":{
  555.                                              "type":"string"
  556.                                           },
  557.                                           "timezone_type":{
  558.                                              "type":"string"
  559.                                           },
  560.                                           "timezone":{
  561.                                              "type":"string"
  562.                                           }
  563.                                        }
  564.                                     },
  565.                                     "uuid":{
  566.                                        "type":"string"
  567.                                     }
  568.                                  }
  569.                               }
  570.                            }
  571.                         }
  572.                      }
  573.                   }
  574.                }
  575.             }
  576.          }
  577.       },
  578.       "\/auth\/register":{
  579.          "post":{
  580.             "operationId":"e314810f-96af-47db-b8d0-bf6f9e3645e6",
  581.             "tags":[
  582.                "auth"
  583.             ],
  584.             "requestBody":{
  585.                "required":true,
  586.                "content":{
  587.                   "application\/x-www-form-urlencoded":{
  588.                      "schema":{
  589.                         "type":"object",
  590.                         "properties":{
  591.                            "name":{
  592.                               "type":"string"
  593.                            },
  594.                            "email":{
  595.                               "type":"string"
  596.                            },
  597.                            "password":{
  598.                               "type":"string"
  599.                            },
  600.                            "phone_number":{
  601.                               "type":"string"
  602.                            }
  603.                         }
  604.                      }
  605.                   }
  606.                }
  607.             },
  608.             "responses":{
  609.                "200":{
  610.                   "description":"POST \/auth\/register",
  611.                   "content":{
  612.                      "application\/json":{
  613.                         "schema":{
  614.                            "type":"object",
  615.                            "properties":{
  616.                               "code":{
  617.                                  "type":"string"
  618.                               },
  619.                               "status":{
  620.                                  "type":"string"
  621.                               },
  622.                               "message":{
  623.                                  "type":"string"
  624.                               },
  625.                               "user":{
  626.                                  "type":"object",
  627.                                  "properties":{
  628.                                     "name":{
  629.                                        "type":"string"
  630.                                     },
  631.                                     "email":{
  632.                                        "type":"string"
  633.                                     },
  634.                                     "phone_number":{
  635.                                        "type":"string"
  636.                                     },
  637.                                     "created":{
  638.                                        "type":"object",
  639.                                        "properties":{
  640.                                           "date":{
  641.                                              "type":"string"
  642.                                           },
  643.                                           "timezone_type":{
  644.                                              "type":"string"
  645.                                           },
  646.                                           "timezone":{
  647.                                              "type":"string"
  648.                                           }
  649.                                        }
  650.                                     },
  651.                                     "uuid":{
  652.                                        "type":"string"
  653.                                     }
  654.                                  }
  655.                               }
  656.                            }
  657.                         }
  658.                      }
  659.                   }
  660.                }
  661.             }
  662.          }
  663.       },
  664.       "\/users\/{uuid}\/favorites":{
  665.          "get":{
  666.             "operationId":"be69db2f-28c0-442c-b178-64b45094f5cd",
  667.             "tags":[
  668.                "users"
  669.             ],
  670.             "parameters":[
  671.                {
  672.                   "name":"uuid",
  673.                   "in":"path",
  674.                   "required":true,
  675.                   "schema":{
  676.                      "type":"string"
  677.                   }
  678.                },
  679.                {
  680.                   "name":"registerNumber",
  681.                   "in":"query",
  682.                   "required":false,
  683.                   "schema":{
  684.                      "type":"string"
  685.                   }
  686.                },
  687.                {
  688.                   "name":"departmentName",
  689.                   "in":"query",
  690.                   "required":false,
  691.                   "schema":{
  692.                      "type":"string"
  693.                   }
  694.                },
  695.                {
  696.                   "name":"inspectorName",
  697.                   "in":"query",
  698.                   "required":false,
  699.                   "schema":{
  700.                      "type":"string"
  701.                   }
  702.                },
  703.                {
  704.                   "name":"roVatCode",
  705.                   "in":"query",
  706.                   "required":false,
  707.                   "schema":{
  708.                      "type":"string"
  709.                   }
  710.                },
  711.                {
  712.                   "name":"institution",
  713.                   "in":"query",
  714.                   "required":false,
  715.                   "schema":{
  716.                      "type":"string"
  717.                   }
  718.                },
  719.                {
  720.                   "name":"institutionAddress",
  721.                   "in":"query",
  722.                   "required":false,
  723.                   "schema":{
  724.                      "type":"string"
  725.                   }
  726.                },
  727.                {
  728.                   "name":"memberState",
  729.                   "in":"query",
  730.                   "required":false,
  731.                   "schema":{
  732.                      "type":"string"
  733.                   }
  734.                },
  735.                {
  736.                   "name":"vatCode",
  737.                   "in":"query",
  738.                   "required":false,
  739.                   "schema":{
  740.                      "type":"string"
  741.                   }
  742.                },
  743.                {
  744.                   "name":"traderDate",
  745.                   "in":"query",
  746.                   "required":false,
  747.                   "schema":{
  748.                      "type":"string"
  749.                   }
  750.                },
  751.                {
  752.                   "name":"email",
  753.                   "in":"query",
  754.                   "required":false,
  755.                   "schema":{
  756.                      "type":"string"
  757.                   }
  758.                },
  759.                {
  760.                   "name":"password",
  761.                   "in":"query",
  762.                   "required":false,
  763.                   "schema":{
  764.                      "type":"string"
  765.                   }
  766.                }
  767.             ],
  768.             "responses":{
  769.                "200":{
  770.                   "description":"GET \/users\/{uuid}\/favorites",
  771.                   "content":{
  772.                      "application\/json":{
  773.                         "schema":{
  774.                            "type":"object",
  775.                            "properties":{
  776.                               "code":{
  777.                                  "type":"string"
  778.                               },
  779.                               "status":{
  780.                                  "type":"string"
  781.                               },
  782.                               "message":{
  783.                                  "type":"string"
  784.                               },
  785.                               "articles":{
  786.                                  "type":"array",
  787.                                  "items":{
  788.                                     "type":"object",
  789.                                     "properties":{
  790.                                        "uuid":{
  791.                                           "type":"string"
  792.                                        },
  793.                                        "title":{
  794.                                           "type":"string"
  795.                                        },
  796.                                        "content":{
  797.                                           "type":"string"
  798.                                        },
  799.                                        "image":{
  800.                                           "type":"string"
  801.                                        },
  802.                                        "views":{
  803.                                           "type":"string"
  804.                                        },
  805.                                        "created":{
  806.                                           "type":"object",
  807.                                           "properties":{
  808.                                              "date":{
  809.                                                 "type":"string"
  810.                                              },
  811.                                              "timezone_type":{
  812.                                                 "type":"string"
  813.                                              },
  814.                                              "timezone":{
  815.                                                 "type":"string"
  816.                                              }
  817.                                           }
  818.                                        },
  819.                                        "user":{
  820.                                           "type":"object",
  821.                                           "properties":{
  822.                                              "name":{
  823.                                                 "type":"string"
  824.                                              },
  825.                                              "email":{
  826.                                                 "type":"string"
  827.                                              },
  828.                                              "phone_number":{
  829.                                                 "type":"string"
  830.                                              },
  831.                                              "created":{
  832.                                                 "type":"object",
  833.                                                 "properties":{
  834.                                                    "date":{
  835.                                                       "type":"string"
  836.                                                    },
  837.                                                    "timezone_type":{
  838.                                                       "type":"string"
  839.                                                    },
  840.                                                    "timezone":{
  841.                                                       "type":"string"
  842.                                                    }
  843.                                                 }
  844.                                              },
  845.                                              "uuid":{
  846.                                                 "type":"string"
  847.                                              }
  848.                                           }
  849.                                        }
  850.                                     }
  851.                                  }
  852.                               }
  853.                            }
  854.                         }
  855.                      }
  856.                   }
  857.                }
  858.             }
  859.          }
  860.       }
  861.    },
  862.    "components":{
  863.       "securitySchemes":{
  864.          "BearerAuth":{
  865.             "type":"http",
  866.             "scheme":"bearer"
  867.          }
  868.       }
  869.    },
  870.    "security":[
  871.       {
  872.          "BearerAuth":[
  873.            
  874.          ]
  875.       }
  876.    ]
  877. }
Advertisement
Add Comment
Please, Sign In to add comment
Advertisement
Public Pastes
Advertisement
We use cookies for various purposes including analytics. By continuing to use Pastebin, you agree to our use of cookies as described in the Cookies Policy.  OK, I Understand
Not a member of Pastebin yet?
Sign Up, it unlocks many cool features!