bookstore_swagger_template.json

{
  "swagger": "2.0",
  "info": {
    "description": "A simple Google Cloud Endpoints Bookstore API example.",
    "title": "Bookstore",
    "version": "1.0.0"
  },
  "host": "bookstore.endpoints.cloudesf-testing.cloud.goog",
  "basePath": "/",
  "consumes": [
    "application/json"
  ],
  "produces": [
    "application/json"
  ],
  "schemes": [
    "https"
  ],
  "paths": {
    "/echo": {
      "delete": {
        "description": "Echo Delete Message",
        "operationId": "echoDeleteMessage",
        "produces": [
          "application/json"
        ],
        "responses": {
          "204": {
            "description": "delete message response"
          }
        }
      },
      "get": {
        "description": "Echo Get Message",
        "operationId": "echoGetMessage",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "get message response"
          }
        }
      },
      "patch": {
        "description": "Echo Patch Message",
        "operationId": "echoPatchMessage",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "patch message response"
          }
        }
      },
      "post": {
        "description": "Echo Post Message",
        "operationId": "echoPostMessage",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "post message response"
          }
        }
      },
      "put": {
        "description": "Echo Put Message",
        "operationId": "echoPutMessage",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "put message response"
          }
        }
      }
    },
    "/echo/auth": {
      "get": {
        "description": "Echo Get Message Authed",
        "operationId": "echoGetMessageAuthed",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "get message response"
          }
        },
        "security": [
          {
            "api_key": []
          }
        ]
      },
      "post": {
        "description": "Echo Post Message Authed",
        "operationId": "echoPostMessageAuthed",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "post message response"
          }
        },
        "security": [
          {
            "api_key": []
          }
        ]
      }
    },
    "/echo_token/disable_auth": {
      "get": {
        "description": "Echo token in Authorization Header under backend auth disabled",
        "operationId": "echoTokenDisableAuth",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "get message response"
          }
        },
        "security": [
        ]
    }
    },
    "/echo_token/default_enable_auth": {
      "get": {
        "description": "Echo token in Authorization Header under backend auth enabled",
        "operationId": "echoTokenEnableAuth",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "get message response"
          }
        },
        "security": [
        ]
      }
    },
    "/shelves": {
      "get": {
        "description": "Returns all shelves in the bookstore.",
        "operationId": "listShelves",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "List of shelves in the bookstore.",
            "schema": {
              "$ref": "#/definitions/listShelvesResponse"
            }
          }
        },
        "security": [
          {
            "auth0_jwk": []
          }
        ]
      },
      "post": {
        "description": "Creates a new shelf in the bookstore.",
        "operationId": "createShelf",
        "parameters": [
          {
            "description": "A shelf resource to create.",
            "in": "body",
            "name": "shelf",
            "required": true,
            "schema": {
              "$ref": "#/definitions/shelf"
            }
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "A newly created shelf resource.",
            "schema": {
              "$ref": "#/definitions/shelf"
            }
          }
        },
        "security": [
          {
            "auth0_jwk": [],
            "api_key": []
          }
        ]
      }
    },
    "/shelves/{shelf}": {
      "get": {
        "description": "Get a single shelf resource with the given name.",
        "operationId": "getShelf",
        "parameters": [
          {
            "description": "Name of the shelf to get.",
            "format": "int64",
            "in": "path",
            "name": "shelf",
            "required": true,
            "type": "integer"
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "A shelf resource.",
            "schema": {
              "$ref": "#/definitions/shelf"
            }
          }
        },
        "security": [
          {
            "auth0_jwk": []
          }
        ]
      },
      "delete": {
        "description": "Deletes a single shelf with the given name.",
        "operationId": "deleteShelf",
        "parameters": [
          {
            "description": "Name of the shelf to delete.",
            "format": "int64",
            "in": "path",
            "name": "shelf",
            "required": true,
            "type": "integer"
          }
        ],
        "responses": {
          "default": {
            "description": "An empty response body."
          }
        }
      }
    },
    "/shelves/{shelf}/books": {
      "get": {
        "description": "Returns all books in a shelf with the given name.",
        "operationId": "listBooks",
        "parameters": [
          {
            "description": "Name of the shelf whose books should be returned.",
            "format": "int64",
            "in": "path",
            "name": "shelf",
            "required": true,
            "type": "integer"
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "List of books on the specified shelf.",
            "schema": {
              "$ref": "#/definitions/listBooksResponse"
            }
          }
        }
      },
      "post": {
        "description": "Creates a new book on the shelf.",
        "operationId": "createBook",
        "parameters": [
          {
            "description": "Name of the shelf where the book should be created.",
            "format": "int64",
            "in": "path",
            "name": "shelf",
            "required": true,
            "type": "integer"
          },
          {
            "description": "Book to create.",
            "in": "body",
            "name": "book",
            "required": true,
            "schema": {
              "$ref": "#/definitions/book"
            }
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "A newly crated book resource.",
            "schema": {
              "$ref": "#/definitions/book"
            }
          }
        }
      }
    },
    "/shelves/{shelf}/books/{book}": {
      "get": {
        "description": "Get a single book with a given name from a shelf.",
        "operationId": "getBook",
        "parameters": [
          {
            "description": "Name of the shelf from which to get the book.",
            "format": "int64",
            "in": "path",
            "name": "shelf",
            "required": true,
            "type": "integer"
          },
          {
            "description": "Name of the book to get from the shelf.",
            "format": "int64",
            "in": "path",
            "name": "book",
            "required": true,
            "type": "integer"
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "A book resource.",
            "schema": {
              "$ref": "#/definitions/book"
            }
          }
        },
        "security": [
          {
            "auth0_jwk": [],
            "api_key": []
          }
        ]
      },
      "delete": {
        "description": "Delete a single book with a given name from a shelf.",
        "operationId": "deleteBook",
        "parameters": [
          {
            "description": "Name of the shelf from which to delete the book.",
            "format": "int64",
            "in": "path",
            "name": "shelf",
            "required": true,
            "type": "integer"
          },
          {
            "description": "Name of the book to delete from the shelf.",
            "format": "int64",
            "in": "path",
            "name": "book",
            "required": true,
            "type": "integer"
          }
        ],
        "responses": {
          "default": {
            "description": "An empty response body."
          }
        }
      }
    },
    "/version": {
      "get": {
        "description": "Returns a version of the application.",
        "operationId": "getVersion",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "Version of the application.",
            "schema": {
              "$ref": "#/definitions/version"
            }
          }
        },
        "security": []
      }
    },
    "/restricted": {
      "get": {
        "description": "API to test key restriction",
        "operationId": "keyRestriction",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "get restricted response"
          }
        },
        "security": [
          {
            "api_key": []
          }
        ]
      }
    },
    "/quota_read": {
      "get": {
        "description": "Read API behind quota",
        "operationId": "readApiQuota",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "get read message response"
          }
        },
        "security": [
          {
            "api_key": []
          }
        ],
        "x-google-quota": {
          "metricCosts": {
            "bookstore/read_requests": 1
          }
        }
      }
    }
  },
  "definitions": {
    "book": {
      "properties": {
        "author": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "title": {
          "type": "string"
        }
      },
      "required": [
        "name",
        "author",
        "title"
      ]
    },
    "listBooksResponse": {
      "properties": {
        "books": {
          "items": {
            "$ref": "#/definitions/book"
          },
          "type": "array"
        }
      },
      "required": [
        "books"
      ],
      "type": "object"
    },
    "listShelvesResponse": {
      "properties": {
        "shelves": {
          "items": {
            "$ref": "#/definitions/shelf"
          },
          "type": "array"
        }
      },
      "type": "object"
    },
    "shelf": {
      "properties": {
        "name": {
          "type": "string"
        },
        "theme": {
          "type": "string"
        }
      },
      "required": [
        "name",
        "theme"
      ]
    },
    "version": {
      "properties": {
        "version": {
          "type": "string"
        }
      },
      "required": [
        "version"
      ]
    }
  },
  "security": [
    {
      "api_key": []
    }
  ],
  "securityDefinitions": {
    "api_key": {
      "in": "query",
      "name": "key",
      "type": "apiKey"
    },
    "auth0_jwk": {
      "authorizationUrl": "",
      "flow": "implicit",
      "type": "oauth2",
      "x-google-issuer": "e2e-client-jwk@cloudesf-testing.iam.gserviceaccount.com",
      "x-google-jwks_uri": "https://www.googleapis.com/service_accounts/v1/jwk/e2e-client-jwk@cloudesf-testing.iam.gserviceaccount.com",
      "x-google-audiences": "bookstore.endpoints.cloudesf-testing.cloud.goog",
      "x-google-jwt-locations": [
        {
          "header": "Authorization",
          "value_prefix": "Bearer "
        },
        {
          "header": "Jwt-Header-Name",
          "value_prefix": "Jwt-Value-Prefix"
        },
        {
          "query": "jwt_query_name"
        }
      ]
    }
  },
  "x-google-management": {
    "metrics": [
      {
        "name": "bookstore/read_requests",
        "value_type": "INT64",
        "metric_kind": "DELTA"
      }
    ],
    "quota": {
      "limits": [{
        "name": "bookstore-read-requests",
        "values": {"STANDARD": 30},
        "unit": "1/min/{project}",
        "metric": "bookstore/read_requests"
      }]
    }
  },
  "x-google-endpoints": [
    {
      "allowCors": true,
      "name": "bookstore.endpoints.cloudesf-testing.cloud.goog"
    }
  ]
}