Skip to content

Commit

Permalink
Update OpenAPI spec
Browse files Browse the repository at this point in the history
  • Loading branch information
cmorabito-woolpert committed Jan 14, 2025
1 parent d4cad7c commit f44d316
Showing 1 changed file with 44 additions and 34 deletions.
78 changes: 44 additions & 34 deletions application/backend/openapi.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
openapi: 3.0.3
openapi: 3.1.1
info:
title: Fleet Routing App - Backend
version: 4.0.0
Expand All @@ -9,6 +9,10 @@ paths:
Static web content.
Paths not matched by other API routes are directed to static file serving middleware
to deliver the frontend application.
responses:
200:
description:
OK

/healthz:
get:
Expand All @@ -29,11 +33,19 @@ paths:
description:
A [`google.cloud.optimization.v1.IOptimizeToursRequest`](https://cloud.google.com/optimization/docs/reference/rpc/google.cloud.optimization.v1#optimizetoursrequest),
with the `parent` property omitted (to be added by the backend).

required: true
content:
application/json:
schema:
type: array
type: object
multipart/form-data:
schema:
type: object
properties:
file:
format: binary
description: A gzip-compressed JSON file containing the IOptimizeToursRequest data
responses:
200:
description:
Expand Down Expand Up @@ -90,22 +102,21 @@ paths:
schema:
type: array
items:
schema:
type: object
properties:
name:
type: string
pageToken:
type: object
properties:
prefix:
type: string
maxResults:
type: integer
autoPaginate:
type: boolean
pageToken:
type: string
type: object
properties:
name:
type: string
pageToken:
type: object
properties:
prefix:
type: string
maxResults:
type: integer
autoPaginate:
type: boolean
pageToken:
type: string
required: ['name']
example:
- name: "2020-10-23/0-vehicles-10-shipments-dayton.request.json"
Expand Down Expand Up @@ -259,22 +270,21 @@ paths:
schema:
type: array
items:
schema:
type: object
properties:
name:
type: string
pageToken:
type: object
properties:
prefix:
type: string
maxResults:
type: integer
autoPaginate:
type: boolean
pageToken:
type: string
type: object
properties:
name:
type: string
pageToken:
type: object
properties:
prefix:
type: string
maxResults:
type: integer
autoPaginate:
type: boolean
pageToken:
type: string
example:
- name: "2020-10-23/0-vehicles-10-shipments-dayton.request.json"
pageToken:
Expand Down

0 comments on commit f44d316

Please sign in to comment.