Atualização da especificação do serviço (OpenAPI)

amagovpt · Jan 12, 2024 · 9d3dd2e · 9d3dd2e
1 parent cba42ae
commit 9d3dd2e
Showing 1 changed file with 239 additions and 8 deletions.
diff --git a/api/fsp-api.json b/api/fsp-api.json
@@ -5,7 +5,7 @@
     "version": "v1"
   },
   "paths": {
-    "/api/Cipher": {
+    "/Cipher": {
       "get": {
         "tags": [
           "Cipher"
@@ -44,7 +44,7 @@
         }
       }
     },
-    "/api/Invoice": {
+    "/Invoice": {
       "post": {
         "tags": [
           "Invoice"
@@ -88,9 +88,127 @@
             }
           }
         }
+      },
+      "get": {
+        "tags": [
+          "Invoice"
+        ],
+        "responses": {
+          "200": {
+            "description": "Success",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/InvoicePendingResentDTOPageResult"
+                }
+              }
+            }
+          },
+          "400": {
+            "description": "Bad Request",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorMessageDTO"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/Invoice/resend": {
+      "post": {
+        "tags": [
+          "Invoice"
+        ],
+        "requestBody": {
+          "content": {
+            "application/json-patch+json": {
+              "schema": {
+                "$ref": "#/components/schemas/InvoiceRequest"
+              }
+            },
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/InvoiceRequest"
+              }
+            },
+            "text/json": {
+              "schema": {
+                "$ref": "#/components/schemas/InvoiceRequest"
+              }
+            },
+            "application/*+json": {
+              "schema": {
+                "$ref": "#/components/schemas/InvoiceRequest"
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "Success"
+          },
+          "400": {
+            "description": "Bad Request",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorMessageDTO"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/Invoice/list": {
+      "get": {
+        "tags": [
+          "Invoice"
+        ],
+        "parameters": [
+          {
+            "name": "InvoiceState",
+            "in": "query",
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "EmissionDate",
+            "in": "query",
+            "schema": {
+              "type": "string",
+              "format": "date-time"
+            }
+          },
+          {
+            "name": "PageNumber",
+            "in": "query",
+            "schema": {
+              "type": "integer",
+              "format": "int32"
+            }
+          },
+          {
+            "name": "PageSize",
+            "in": "query",
+            "schema": {
+              "type": "integer",
+              "format": "int32"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Success"
+          }
+        }
       }
     },
-    "/api/Seller": {
+    "/Seller": {
       "delete": {
         "tags": [
           "Seller"
@@ -156,7 +274,89 @@
         }
       }
     },
-    "/api/Token": {
+    "/Sw/auth": {
+      "post": {
+        "tags": [
+          "Sw"
+        ],
+        "responses": {
+          "200": {
+            "description": "Success",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/AccessTokenDTO"
+                }
+              }
+            }
+          },
+          "400": {
+            "description": "Bad Request",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorMessageDTO"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/Sw/seller": {
+      "post": {
+        "tags": [
+          "Sw"
+        ],
+        "requestBody": {
+          "content": {
+            "application/json-patch+json": {
+              "schema": {
+                "$ref": "#/components/schemas/SwSellerRequest"
+              }
+            },
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/SwSellerRequest"
+              }
+            },
+            "text/json": {
+              "schema": {
+                "$ref": "#/components/schemas/SwSellerRequest"
+              }
+            },
+            "application/*+json": {
+              "schema": {
+                "$ref": "#/components/schemas/SwSellerRequest"
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "Success",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/AccessTokenDTO"
+                }
+              }
+            }
+          },
+          "400": {
+            "description": "Bad Request",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorMessageDTO"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/Token": {
       "put": {
         "tags": [
           "Token"
@@ -254,17 +454,17 @@
         },
         "additionalProperties": false
       },
+      "InvoicePendingResentDTOPageResult": {
+        "type": "object",
+        "additionalProperties": false
+      },
       "InvoiceRequest": {
         "type": "object",
         "properties": {
           "localId": {
             "type": "string",
             "nullable": true
           },
-          "sellerId": {
-            "type": "string",
-            "nullable": true
-          },
           "filename": {
             "type": "string",
             "nullable": true
@@ -280,6 +480,15 @@
           "invoice": {
             "type": "string",
             "nullable": true
+          },
+          "emissionDate": {
+            "type": "string",
+            "format": "date-time",
+            "nullable": true
+          },
+          "collaboratorId": {
+            "type": "string",
+            "nullable": true
           }
         },
         "additionalProperties": false
@@ -297,6 +506,28 @@
           }
         },
         "additionalProperties": false
+      },
+      "SwSellerRequest": {
+        "type": "object",
+        "properties": {
+          "instanceId": {
+            "type": "string",
+            "format": "uuid"
+          },
+          "enterpriseNipc": {
+            "type": "string",
+            "nullable": true
+          },
+          "clientName": {
+            "type": "string",
+            "nullable": true
+          },
+          "email": {
+            "type": "string",
+            "nullable": true
+          }
+        },
+        "additionalProperties": false
       }
     },
     "securitySchemes": {