nwSwaggerCategories.json

{
    "swagger": "2.0",
    "info": {
        "version": "v1",
        "title": "NorthwindAPI"
    },
    "host": "microsoft-apiapp18a6d483211745969fbbde2fed199d66.azurewebsites.net",
    "schemes": [
        "https"
    ],
    "consumes": [],
    "produces": [],
    "paths": {
        "/Northwind/v4/Categories": {
            "get": {
                "tags": [
                    "Categories"
                ],
                "summary": "GetCategories",
                "x-ms-summary": "Categories",
                "x-ms-visibility": "advanced",
                "description": "Returns the EntitySet Categories",
                "operationId": "Categories_Get",
                "consumes": [],
                "produces": [
                    "application/json"
                ],
                "parameters": [
                    {
                        "name": "$expand",
                        "in": "query",
                        "description": "Expands related entities inline.",
                        "required": false,
                        "type": "string"
                    },
                    {
                        "name": "$filter",
                        "in": "query",
                        "description": "Filters the results, based on a Boolean condition.",
                        "required": false,
                        "type": "string"
                    },
                    {
                        "name": "$select",
                        "in": "query",
                        "description": "Selects which properties to include in the response.",
                        "required": false,
                        "type": "string"
                    },
                    {
                        "name": "$orderby",
                        "in": "query",
                        "description": "Sorts the results.",
                        "required": false,
                        "type": "string"
                    },
                    {
                        "name": "$top",
                        "in": "query",
                        "description": "Returns only the first n results.",
                        "required": false,
                        "type": "integer",
                        "format": "int32"
                    },
                    {
                        "name": "$skip",
                        "in": "query",
                        "description": "Skips the first n results.",
                        "required": false,
                        "type": "integer",
                        "format": "int32"
                    },
                    {
                        "name": "$count",
                        "in": "query",
                        "description": "Includes a count of the matching results in the response.",
                        "required": false,
                        "type": "boolean"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "OK",
                        "schema": {
                            "$ref": "#/definitions/ODataResponse[Category]"
                        }
                    }
                },
                "deprecated": false
            },
            "post": {
                "tags": [
                    "Categories"
                ],
                "summary": "CreateCategories",
                "x-ms-summary": "Categories",
                "x-ms-visibility": "advanced",
                "description": "Post a new entity to EntitySet Categories",
                "operationId": "Categories_Post",
                "consumes": [
                    "application/json"
                ],
                "produces": [
                    "application/json"
                ],
                "parameters": [
                    {
                        "name": "Category",
                        "in": "body",
                        "description": "The entity to post",
                        "required": true,
                        "schema": {
                            "$ref": "#/definitions/Category"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "OK",
                        "schema": {
                            "$ref": "#/definitions/Category"
                        }
                    }
                },
                "deprecated": false
            }
        },
        "/Northwind/v4/Categories({CategoryID})": {
            "get": {
                "tags": [
                    "Categories"
                ],
                "summary": "GetCategory",
                "x-ms-summary": "Category",
                "x-ms-visibility": "advanced",
                "description": "Returns the entity with the key from Categories",
                "operationId": "Categories_GetByCategoryid",
                "consumes": [],
                "produces": [
                    "application/json"
                ],
                "parameters": [
                    {
                        "name": "CategoryID",
                        "in": "path",
                        "description": "key: CategoryID",
                        "required": true,
                        "type": "integer",
                        "format": "int32"
                    },
                    {
                        "name": "$select",
                        "in": "query",
                        "description": "Selects which properties to include in the response.",
                        "required": false,
                        "type": "string"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "OK",
                        "schema": {
                            "$ref": "#/definitions/Category"
                        }
                    }
                },
                "deprecated": false
            },
            "put": {
                "tags": [
                    "Categories"
                ],
                "summary": "PutCategory",
                "x-ms-summary": "Category",
                "x-ms-visibility": "advanced",
                "description": "Replace entity in EntitySet Categories",
                "operationId": "Categories_PutByCategoryid",
                "consumes": [
                    "application/json"
                ],
                "produces": [],
                "parameters": [
                    {
                        "name": "CategoryID",
                        "in": "path",
                        "description": "key: CategoryID",
                        "required": true,
                        "type": "integer",
                        "format": "int32"
                    },
                    {
                        "name": "Category",
                        "in": "body",
                        "description": "The entity to put",
                        "required": true,
                        "schema": {
                            "$ref": "#/definitions/Category"
                        }
                    }
                ],
                "responses": {
                    "204": {
                        "description": "No Content"
                    }
                },
                "deprecated": false
            },
            "delete": {
                "tags": [
                    "Categories"
                ],
                "summary": "DeleteCategories",
                "x-ms-summary": "Category",
                "x-ms-visibility": "advanced",
                "description": "Delete entity in EntitySet Categories",
                "operationId": "Categories_DeleteByCategoryid",
                "consumes": [],
                "produces": [],
                "parameters": [
                    {
                        "name": "CategoryID",
                        "in": "path",
                        "description": "key: CategoryID",
                        "required": true,
                        "type": "integer",
                        "format": "int32"
                    },
                    {
                        "name": "If-Match",
                        "in": "header",
                        "description": "If-Match header",
                        "required": false,
                        "type": "string"
                    }
                ],
                "responses": {
                    "204": {
                        "description": "No Content"
                    }
                },
                "deprecated": false
            },
            "patch": {
                "tags": [
                    "Categories"
                ],
                "summary": "UpdateCategories",
                "x-ms-summary": "Categories",
                "x-ms-visibility": "advanced",
                "description": "Update entity in EntitySet Categories",
                "operationId": "Categories_PatchByCategoryid",
                "consumes": [
                    "application/json"
                ],
                "produces": [],
                "parameters": [
                    {
                        "name": "CategoryID",
                        "in": "path",
                        "description": "key: CategoryID",
                        "required": true,
                        "type": "integer",
                        "format": "int32"
                    },
                    {
                        "name": "Category",
                        "in": "body",
                        "description": "The entity to patch",
                        "required": true,
                        "schema": {
                            "$ref": "#/definitions/Category"
                        }
                    }
                ],
                "responses": {
                    "204": {
                        "description": "No Content"
                    }
                },
                "deprecated": false
            }
        },
    },
    "definitions": {
        "ODataResponse[Category]": {
            "type": "object",
            "properties": {
                "@odata.context": {
                    "type": "string"
                },
                "value": {
                    "type": "array",
                    "items": {
                        "$ref": "#/definitions/Category"
                    }
                }
            }
        },
        "Category": {
            "required": [
                "CategoryName"
            ],
            "type": "object",
            "properties": {
                "CategoryID": {
                    "format": "int32",
                    "type": "integer"
                },
                "CategoryName": {
                    "maxLength": 15,
                    "minLength": 0,
                    "type": "string"
                },
                "Description": {
                    "type": "string"
                },
                "Picture": {
                    "type": "string"
                }
            }
        },
    },
    "parameters": {},
    "responses": {},
    "securityDefinitions": {},
    "security": [],
    "tags": []
}