Skip to content

Commit

Permalink
openapi for only cache
Browse files Browse the repository at this point in the history
  • Loading branch information
lorenzo-catalano committed Apr 8, 2024
1 parent b74f9ea commit 167d280
Show file tree
Hide file tree
Showing 14 changed files with 5,531 additions and 5,215 deletions.
3,683 changes: 1,709 additions & 1,974 deletions openapi/openapi.json

Large diffs are not rendered by default.

1,160 changes: 1,160 additions & 0 deletions openapi/openapi_cache.json

Large diffs are not rendered by default.

168 changes: 77 additions & 91 deletions openapi/openapi_export.json
Original file line number Diff line number Diff line change
@@ -1,119 +1,105 @@
{
"openapi": "3.0.1",
"info": {
"title": "API-Config Cache ${service}",
"description": "Generate cache for various microservices",
"termsOfService": "https://www.pagopa.gov.it/",
"version": "0.8.20"
"openapi" : "3.0.1",
"info" : {
"title" : "API-Config Cache ${service}",
"description" : "Generate cache for various microservices",
"termsOfService" : "https://www.pagopa.gov.it/",
"version" : "0.8.20"
},
"servers": [
{
"url": "https://{host}/{basePath}",
"variables": {
"host": {
"default": "api.dev.platform.pagopa.it",
"enum": [
"api.dev.platform.pagopa.it",
"api.uat.platform.pagopa.it",
"api.platform.pagopa.it"
]
},
"basePath": {
"default": "api-config-cache/o/v1",
"enum": [
"api-config-cache/o/v1",
"api-config-cache/p/v1",
"api-config-cache/odev/v1"
]
}
"servers" : [ {
"url" : "https://{host}/{basePath}",
"variables" : {
"host" : {
"default" : "api.dev.platform.pagopa.it",
"enum" : [ "api.dev.platform.pagopa.it", "api.uat.platform.pagopa.it", "api.platform.pagopa.it" ]
},
"basePath" : {
"default" : "api-config-cache/o/v1",
"enum" : [ "api-config-cache/o/v1", "api-config-cache/p/v1", "api-config-cache/odev/v1" ]
}
}
],
"paths": {
"/cache/xlsx": {
"get": {
"tags": [
"Cache"
],
"summary": "Get xlsx of full chache",
"operationId": "xls",
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemJson"
} ],
"paths" : {
"/cache/xlsx" : {
"get" : {
"tags" : [ "Cache" ],
"summary" : "Get xlsx of full chache",
"operationId" : "xls",
"responses" : {
"400" : {
"description" : "Bad Request",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemJson"
}
}
}
},
"429": {
"description": "Too many requests"
},
"500": {
"description": "Service unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemJson"
"500" : {
"description" : "Service unavailable",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemJson"
}
}
}
},
"403": {
"description": "Forbidden"
},
"200": {
"description": "OK",
"content": {
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {}
"200" : {
"description" : "OK",
"content" : {
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet" : { }
}
},
"401": {
"description": "Unauthorized"
"401" : {
"description" : "Unauthorized"
},
"429" : {
"description" : "Too many requests"
},
"403" : {
"description" : "Forbidden"
}
},
"security": [
{
"ApiKey": []
}
]
"security" : [ {
"ApiKey" : [ ]
} ]
}
}
},
"components": {
"schemas": {
"ProblemJson": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "A short, summary of the problem type. Written in english and readable for engineers (usually not suited for non technical stakeholders and not localized); example: Service Unavailable"
"components" : {
"schemas" : {
"ProblemJson" : {
"type" : "object",
"properties" : {
"title" : {
"type" : "string",
"description" : "A short, summary of the problem type. Written in english and readable for engineers (usually not suited for non technical stakeholders and not localized); example: Service Unavailable"
},
"status": {
"maximum": 600,
"minimum": 100,
"type": "integer",
"description": "The HTTP status code generated by the origin server for this occurrence of the problem.",
"format": "int32",
"example": 200
"status" : {
"maximum" : 600,
"minimum" : 100,
"type" : "integer",
"description" : "The HTTP status code generated by the origin server for this occurrence of the problem.",
"format" : "int32",
"example" : 200
},
"detail": {
"type": "string",
"description": "A human readable explanation specific to this occurrence of the problem.",
"example": "There was an error processing the request"
"detail" : {
"type" : "string",
"description" : "A human readable explanation specific to this occurrence of the problem.",
"example" : "There was an error processing the request"
}
}
}
},
"securitySchemes": {
"ApiKey": {
"type": "apiKey",
"description": "The API key to access this function app.",
"name": "Ocp-Apim-Subscription-Key",
"in": "header"
"securitySchemes" : {
"ApiKey" : {
"type" : "apiKey",
"description" : "The API key to access this function app.",
"name" : "Ocp-Apim-Subscription-Key",
"in" : "header"
}
}
}
}
}
Loading

0 comments on commit 167d280

Please sign in to comment.