{
  "opencollection": "1.0.0",
  "info": {
    "name": "Kong Enterprise Admin ACLs Scorecards API",
    "version": "3.14.0"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "Kong-Admin-Token",
      "value": "{{Kong-Admin-Token}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "Scorecards",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List Catalog Service Scorecards",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{protocol}://{hostname}:{port}{path}/v1/catalog-services/:id/scorecards",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The `id` of the service."
              },
              {
                "name": "page[size]",
                "value": "",
                "type": "query",
                "description": "The maximum number of items to include per page. The last page of a collection may include fewer items."
              },
              {
                "name": "page[number]",
                "value": "",
                "type": "query",
                "description": "Determines which page of the entities to retrieve."
              },
              {
                "name": "filter",
                "value": "",
                "type": "query",
                "description": "Filters a collection of scorecards."
              },
              {
                "name": "sort",
                "value": "",
                "type": "query",
                "description": "Sorts a collection of scorecards. Supported sort attributes are:\n  - `name`\n  - `score.value`\n  - `score.raw_value`\n\nDefault sort is `name` in ascending order.\n"
              }
            ]
          },
          "docs": "Returns a paginated collection of scorecards targeting the given service."
        },
        {
          "info": {
            "name": "Get a Catalog Service Scorecard",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{protocol}://{hostname}:{port}{path}/v1/catalog-services/:serviceId/scorecards/:scorecardId",
            "params": [
              {
                "name": "serviceId",
                "value": "",
                "type": "path",
                "description": "The `id` of the service."
              },
              {
                "name": "scorecardId",
                "value": "",
                "type": "path",
                "description": "The `id` of the scorecard."
              }
            ]
          },
          "docs": "Fetches the given scorecard targeting the service."
        },
        {
          "info": {
            "name": "List Scorecard Templates",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{protocol}://{hostname}:{port}{path}/v1/scorecard-templates",
            "params": [
              {
                "name": "page[size]",
                "value": "",
                "type": "query",
                "description": "The maximum number of items to include per page. The last page of a collection may include fewer items."
              },
              {
                "name": "page[number]",
                "value": "",
                "type": "query",
                "description": "Determines which page of the entities to retrieve."
              },
              {
                "name": "filter",
                "value": "",
                "type": "query",
                "description": "Filters a collection of scorecard templates."
              },
              {
                "name": "sort",
                "value": "",
                "type": "query",
                "description": "Sorts a collection of scorecard templates. Supported sort attributes are:\n\n\n  - `display_name`\n  - `name`\n\nDefault sort is `display_name` in ascending order.\n"
              }
            ]
          },
          "docs": "Returns a paginated collection of scorecard templates."
        },
        {
          "info": {
            "name": "List Scorecards",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{protocol}://{hostname}:{port}{path}/v1/scorecards",
            "params": [
              {
                "name": "page[size]",
                "value": "",
                "type": "query",
                "description": "The maximum number of items to include per page. The last page of a collection may include fewer items."
              },
              {
                "name": "page[number]",
                "value": "",
                "type": "query",
                "description": "Determines which page of the entities to retrieve."
              },
              {
                "name": "filter",
                "value": "",
                "type": "query",
                "description": "Filters a collection of scorecards."
              },
              {
                "name": "sort",
                "value": "",
                "type": "query",
                "description": "Sorts a collection of scorecards. Supported sort attributes are:\n  - `name`\n  - `score.value`\n  - `score.raw_value`\n\nDefault sort is `name` in ascending order.\n"
              }
            ]
          },
          "docs": "Returns a paginated collection of scorecards."
        },
        {
          "info": {
            "name": "Create Scorecard",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{protocol}://{hostname}:{port}{path}/v1/scorecards",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a scorecard."
        },
        {
          "info": {
            "name": "Get a Scorecard",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{protocol}://{hostname}:{port}{path}/v1/scorecards/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The `id` of the scorecard."
              }
            ]
          },
          "docs": "Fetches a scorecard."
        },
        {
          "info": {
            "name": "Update Scorecard",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{protocol}://{hostname}:{port}{path}/v1/scorecards/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The `id` of the scorecard."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates a scorecard."
        },
        {
          "info": {
            "name": "Delete Scorecard",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{protocol}://{hostname}:{port}{path}/v1/scorecards/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The `id` of the scorecard."
              }
            ]
          },
          "docs": "Deletes a scorecard."
        },
        {
          "info": {
            "name": "List Scorecard Services",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{protocol}://{hostname}:{port}{path}/v1/scorecards/:id/catalog-services",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The `id` of the scorecard."
              },
              {
                "name": "page[size]",
                "value": "",
                "type": "query",
                "description": "The maximum number of items to include per page. The last page of a collection may include fewer items."
              },
              {
                "name": "page[number]",
                "value": "",
                "type": "query",
                "description": "Determines which page of the entities to retrieve."
              },
              {
                "name": "filter",
                "value": "",
                "type": "query",
                "description": "Filters a collection of services targeted by a scorecard."
              },
              {
                "name": "sort",
                "value": "",
                "type": "query",
                "description": "Sorts a collection of services targeted by a scorecard. Supported sort attributes are:\n\n\n  - `display_name`\n  - `name`\n  - `score.value`\n  - `score.raw_value`\n\nDefault sort is `display_name` in ascending order.\n"
              }
            ]
          },
          "docs": "Lists services targeted by a scorecard."
        },
        {
          "info": {
            "name": "List Scorecard Criteria",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{protocol}://{hostname}:{port}{path}/v1/scorecards/:id/criteria",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The `id` of the scorecard."
              },
              {
                "name": "page[size]",
                "value": "",
                "type": "query",
                "description": "The maximum number of items to include per page. The last page of a collection may include fewer items."
              },
              {
                "name": "page[number]",
                "value": "",
                "type": "query",
                "description": "Determines which page of the entities to retrieve."
              },
              {
                "name": "filter",
                "value": "",
                "type": "query",
                "description": "Filters a collection of criteria belonging to a scorecard."
              },
              {
                "name": "sort",
                "value": "",
                "type": "query",
                "description": "Sorts a collection of criteria belonging to a scorecard. Supported sort attributes are:\n\n\n  - `evaluation.passing_services_count`\n\nBy default, criteria will be returned in the order that they are configured in the scorecard.\n"
              }
            ]
          },
          "docs": "Lists criteria, including passing service counts, belonging to a scorecard."
        },
        {
          "info": {
            "name": "List Scorecard Criteria Services",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{protocol}://{hostname}:{port}{path}/v1/scorecards/:scorecardId/criteria/:criteriaId/catalog-services",
            "params": [
              {
                "name": "scorecardId",
                "value": "",
                "type": "path",
                "description": "The `id` of the scorecard."
              },
              {
                "name": "criteriaId",
                "value": "",
                "type": "path",
                "description": "The `id` of the criteria."
              },
              {
                "name": "page[size]",
                "value": "",
                "type": "query",
                "description": "The maximum number of items to include per page. The last page of a collection may include fewer items."
              },
              {
                "name": "page[number]",
                "value": "",
                "type": "query",
                "description": "Determines which page of the entities to retrieve."
              },
              {
                "name": "filter",
                "value": "",
                "type": "query",
                "description": "Filters a collection of services targeted by a scorecard criteria."
              },
              {
                "name": "sort",
                "value": "",
                "type": "query",
                "description": "Sorts a collection of services targeted by a scorecard criteria. Supported sort attributes are:\n\n\n  - `display_name`\n  - `name`\n  - `evaluation.is_passing`\n  - `evaluation.successfully_evaluated_at`\n  - `evaluation.attempted_at`\n\nDefault sort is `display_name` in ascending order.\n"
              }
            ]
          },
          "docs": "Lists services targeted by a scorecard criteria with evaluation results per-service."
        }
      ]
    }
  ],
  "bundled": true
}