@bfra.me/api-core 0.1.0

package/test-utils/definitions/auth-quirks.json

@@ -0,0 +1,62 @@
+{
+  "openapi": "3.1.0",
+  "info": {
+    "version": "1.0.0",
+    "title": "Debugging auth quirks"
+  },
+  "servers": [
+    {
+      "url": "https://httpbin.org"
+    }
+  ],
+  "paths": {
+    "/anything": {
+      "post": {
+        "security": [
+          {
+            "oauth2": ["write:things"]
+          },
+          {
+            "basicAuth": []
+          }
+        ]
+      }
+    },
+    "/anything/or-and": {
+      "post": {
+        "security": [
+          {
+            "oauth2": ["write:things"]
+          },
+          {
+            "basicAuth": [],
+            "bearerAuth": []
+          }
+        ]
+      }
+    }
+  },
+  "components": {
+    "securitySchemes": {
+      "basicAuth": {
+        "type": "http",
+        "scheme": "basic"
+      },
+      "bearerAuth": {
+        "type": "http",
+        "scheme": "bearer"
+      },
+      "oauth2": {
+        "type": "oauth2",
+        "flows": {
+          "implicit": {
+            "authorizationUrl": "http://example.com/oauth/dialog",
+            "scopes": {
+              "write:things": "Add things to your account"
+            }
+          }
+        }
+      }
+    }
+  }
+}

package/test-utils/definitions/basiq.json

@@ -0,0 +1,104 @@
+{
+  "openapi": "3.0.1",
+  "info": {
+    "title": "Core",
+    "description": "All included utility endpoints for Basiq partners",
+    "version": "3.0.0"
+  },
+  "servers": [
+    {
+      "url": "https://au-api.basiq.io/"
+    }
+  ],
+  "paths": {
+    "/token": {
+      "post": {
+        "tags": ["Authentication"],
+        "summary": "Generate an auth token",
+        "description": "Use this endpoint to retrieve a token that will be passed as authorization header for Basiq API",
+        "operationId": "postToken",
+        "parameters": [
+          {
+            "name": "basiq-version",
+            "in": "header",
+            "required": true,
+            "schema": {
+              "type": "string",
+              "example": "3.0"
+            }
+          }
+        ],
+        "requestBody": {
+          "content": {
+            "application/x-www-form-urlencoded": {
+              "schema": {
+                "properties": {
+                  "scope": {
+                    "type": "string"
+                  },
+                  "userId": {
+                    "type": "string"
+                  }
+                }
+              },
+              "examples": {
+                "client_access": {
+                  "summary": "For all client side requests",
+                  "value": {
+                    "scope": "CLIENT_ACCESS",
+                    "userId": "6dd30ce4-d4ba-11ec-9d64-0242ac120002"
+                  }
+                },
+                "server_access": {
+                  "summary": "For all server side requests",
+                  "value": {
+                    "scope": "SERVER_ACCESS"
+                  }
+                }
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "OK"
+          }
+        },
+        "security": [
+          {
+            "api_key": []
+          }
+        ]
+      }
+    }
+  },
+  "components": {
+    "securitySchemes": {
+      "api_key": {
+        "type": "apiKey",
+        "name": "Authorization",
+        "in": "header",
+        "x-default": "Basic NjMxMjNmMWMtZjYxMy00ZjMyLWFiYzUtYzBhZDdhYTY2YmU1OjQ3NWYwMzhkLTBlZmItNGM1ZS1iMzQ0LTAzMzYxOTkyYTRlMw=="
+      },
+      "services_token": {
+        "type": "http",
+        "scheme": "bearer",
+        "bearerFormat": "JWT"
+      }
+    }
+  },
+  "security": [
+    {
+      "api_key": []
+    },
+    {
+      "services_token": []
+    }
+  ],
+  "x-readme": {
+    "explorer-enabled": true,
+    "proxy-enabled": true,
+    "samples-enabled": true,
+    "samples-languages": ["curl", "node", "ruby", "javascript", "python"]
+  }
+}

package/test-utils/definitions/metrotransit.json

@@ -0,0 +1,318 @@
+{
+  "openapi": "3.0.1",
+  "info": {
+    "title": "NexTrip API",
+    "description": "API for creating Metro Transit real-time departure information display (beta, subject to change)",
+    "version": "2"
+  },
+  "servers": [{"url": "https://svc.metrotransit.org"}],
+  "paths": {
+    "/nextrip/agencies": {
+      "get": {
+        "tags": ["NexTrip"],
+        "responses": {
+          "200": {
+            "description": "Success",
+            "content": {
+              "application/json": {
+                "schema": {"type": "array", "items": {"$ref": "#/components/schemas/Agency"}}
+              }
+            }
+          },
+          "400": {
+            "description": "Bad Request",
+            "content": {
+              "application/json": {"schema": {"$ref": "#/components/schemas/ProblemDetails"}}
+            }
+          },
+          "500": {"description": "Server Error"}
+        }
+      }
+    },
+    "/nextrip/routes": {
+      "get": {
+        "tags": ["NexTrip"],
+        "responses": {
+          "200": {
+            "description": "Success",
+            "content": {
+              "application/json": {
+                "schema": {"type": "array", "items": {"$ref": "#/components/schemas/Route"}}
+              }
+            }
+          },
+          "400": {
+            "description": "Bad Request",
+            "content": {
+              "application/json": {"schema": {"$ref": "#/components/schemas/ProblemDetails"}}
+            }
+          },
+          "500": {"description": "Server Error"}
+        }
+      }
+    },
+    "/nextrip/directions/{route_id}": {
+      "get": {
+        "tags": ["NexTrip"],
+        "parameters": [
+          {"name": "route_id", "in": "path", "required": true, "schema": {"type": "string"}}
+        ],
+        "responses": {
+          "200": {
+            "description": "Success",
+            "content": {
+              "application/json": {
+                "schema": {"type": "array", "items": {"$ref": "#/components/schemas/Direction"}}
+              }
+            }
+          },
+          "400": {
+            "description": "Bad Request",
+            "content": {
+              "application/json": {"schema": {"$ref": "#/components/schemas/ProblemDetails"}}
+            }
+          },
+          "500": {"description": "Server Error"}
+        }
+      }
+    },
+    "/nextrip/stops/{route_id}/{direction_id}": {
+      "get": {
+        "tags": ["NexTrip"],
+        "parameters": [
+          {"name": "route_id", "in": "path", "required": true, "schema": {"type": "string"}},
+          {
+            "name": "direction_id",
+            "in": "path",
+            "required": true,
+            "schema": {"type": "integer", "format": "int32"}
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Success",
+            "content": {
+              "application/json": {
+                "schema": {"type": "array", "items": {"$ref": "#/components/schemas/Place"}}
+              }
+            }
+          },
+          "400": {
+            "description": "Bad Request",
+            "content": {
+              "application/json": {"schema": {"$ref": "#/components/schemas/ProblemDetails"}}
+            }
+          },
+          "500": {"description": "Server Error"}
+        }
+      }
+    },
+    "/nextrip/{stop_id}": {
+      "get": {
+        "tags": ["NexTrip"],
+        "parameters": [
+          {
+            "name": "stop_id",
+            "in": "path",
+            "required": true,
+            "schema": {"type": "integer", "format": "int32"}
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Success",
+            "content": {
+              "application/json": {"schema": {"$ref": "#/components/schemas/NexTripResult"}}
+            }
+          },
+          "400": {
+            "description": "Bad Request",
+            "content": {
+              "application/json": {"schema": {"$ref": "#/components/schemas/ProblemDetails"}}
+            }
+          },
+          "500": {"description": "Server Error"}
+        }
+      }
+    },
+    "/nextrip/{route_id}/{direction_id}/{place_code}": {
+      "get": {
+        "tags": ["NexTrip"],
+        "parameters": [
+          {"name": "route_id", "in": "path", "required": true, "schema": {"type": "string"}},
+          {
+            "name": "direction_id",
+            "in": "path",
+            "required": true,
+            "schema": {"type": "integer", "format": "int32"}
+          },
+          {"name": "place_code", "in": "path", "required": true, "schema": {"type": "string"}}
+        ],
+        "responses": {
+          "200": {
+            "description": "Success",
+            "content": {
+              "application/json": {"schema": {"$ref": "#/components/schemas/NexTripResult"}}
+            }
+          },
+          "400": {
+            "description": "Bad Request",
+            "content": {
+              "application/json": {"schema": {"$ref": "#/components/schemas/ProblemDetails"}}
+            }
+          },
+          "500": {"description": "Server Error"}
+        }
+      }
+    },
+    "/nextrip/vehicles/{route_id}": {
+      "get": {
+        "tags": ["NexTrip"],
+        "parameters": [
+          {"name": "route_id", "in": "path", "required": true, "schema": {"type": "string"}}
+        ],
+        "responses": {
+          "200": {
+            "description": "Success",
+            "content": {
+              "application/json": {
+                "schema": {"type": "array", "items": {"$ref": "#/components/schemas/Vehicle"}}
+              }
+            }
+          },
+          "400": {
+            "description": "Bad Request",
+            "content": {
+              "application/json": {"schema": {"$ref": "#/components/schemas/ProblemDetails"}}
+            }
+          },
+          "500": {"description": "Server Error"}
+        }
+      }
+    }
+  },
+  "components": {
+    "schemas": {
+      "Agency": {
+        "type": "object",
+        "properties": {
+          "agency_id": {"type": "integer", "format": "int32"},
+          "agency_name": {"type": "string", "nullable": true}
+        },
+        "additionalProperties": false
+      },
+      "AlertMessage": {
+        "type": "object",
+        "properties": {
+          "stop_closed": {"type": "boolean"},
+          "alert_text": {"type": "string", "nullable": true}
+        },
+        "additionalProperties": false
+      },
+      "Departure": {
+        "type": "object",
+        "properties": {
+          "actual": {"type": "boolean"},
+          "trip_id": {"type": "string", "nullable": true},
+          "stop_id": {"type": "integer", "format": "int32"},
+          "departure_text": {"type": "string", "nullable": true},
+          "departure_time": {"type": "integer", "format": "int64"},
+          "description": {"type": "string", "nullable": true},
+          "gate": {"type": "string", "nullable": true},
+          "route_id": {"type": "string", "nullable": true},
+          "route_short_name": {"type": "string", "nullable": true},
+          "direction_id": {"type": "integer", "format": "int32"},
+          "direction_text": {"type": "string", "nullable": true},
+          "terminal": {"type": "string", "nullable": true},
+          "schedule_relationship": {"type": "string", "nullable": true}
+        },
+        "additionalProperties": false
+      },
+      "Direction": {
+        "type": "object",
+        "properties": {
+          "direction_id": {"type": "integer", "format": "int32"},
+          "direction_name": {"type": "string", "nullable": true}
+        },
+        "additionalProperties": false
+      },
+      "NexTripResult": {
+        "type": "object",
+        "properties": {
+          "stops": {
+            "type": "array",
+            "items": {"$ref": "#/components/schemas/Stop"},
+            "nullable": true
+          },
+          "alerts": {
+            "type": "array",
+            "items": {"$ref": "#/components/schemas/AlertMessage"},
+            "nullable": true
+          },
+          "departures": {
+            "type": "array",
+            "items": {"$ref": "#/components/schemas/Departure"},
+            "nullable": true
+          }
+        },
+        "additionalProperties": false
+      },
+      "Place": {
+        "type": "object",
+        "properties": {
+          "place_code": {"type": "string", "nullable": true},
+          "description": {"type": "string", "nullable": true}
+        },
+        "additionalProperties": false
+      },
+      "ProblemDetails": {
+        "type": "object",
+        "properties": {
+          "type": {"type": "string", "nullable": true},
+          "title": {"type": "string", "nullable": true},
+          "status": {"type": "integer", "format": "int32", "nullable": true},
+          "detail": {"type": "string", "nullable": true},
+          "instance": {"type": "string", "nullable": true}
+        },
+        "additionalProperties": {}
+      },
+      "Route": {
+        "type": "object",
+        "properties": {
+          "route_id": {"type": "string", "nullable": true},
+          "agency_id": {"type": "integer", "format": "int32"},
+          "route_label": {"type": "string", "nullable": true}
+        },
+        "additionalProperties": false
+      },
+      "Stop": {
+        "type": "object",
+        "properties": {
+          "stop_id": {"type": "integer", "format": "int32"},
+          "latitude": {"type": "number", "format": "double"},
+          "longitude": {"type": "number", "format": "double"},
+          "description": {"type": "string", "nullable": true}
+        },
+        "additionalProperties": false
+      },
+      "Vehicle": {
+        "type": "object",
+        "properties": {
+          "trip_id": {"type": "string", "nullable": true},
+          "direction_id": {"type": "integer", "format": "int32"},
+          "direction": {"type": "string", "nullable": true},
+          "location_time": {"type": "integer", "format": "int64"},
+          "route_id": {"type": "string", "nullable": true},
+          "terminal": {"type": "string", "nullable": true},
+          "latitude": {"type": "number", "format": "float"},
+          "longitude": {"type": "number", "format": "float"},
+          "bearing": {"type": "number", "format": "float"},
+          "odometer": {"type": "number", "format": "double"},
+          "speed": {"type": "number", "format": "float"}
+        },
+        "additionalProperties": false
+      }
+    }
+  },
+  "x-readme": {"explorer-enabled": true, "proxy-enabled": true, "samples-enabled": true}
+}

package/test-utils/definitions/nested-defaults.json

@@ -0,0 +1,107 @@
+{
+  "openapi": "3.0.0",
+  "info": {
+    "version": "1.0.0",
+    "title": "Nested defaults"
+  },
+  "servers": [
+    {
+      "url": "https://httpbin.org"
+    }
+  ],
+  "paths": {
+    "/pet": {
+      "post": {
+        "tags": ["pet"],
+        "summary": "Add a new pet to the store",
+        "description": "",
+        "operationId": "addPet",
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/Pet"
+              }
+            }
+          },
+          "description": "Pet object that needs to be added to the store",
+          "required": true
+        },
+        "responses": {
+          "405": {
+            "description": "Invalid input"
+          }
+        }
+      }
+    }
+  },
+  "components": {
+    "schemas": {
+      "Category": {
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "integer",
+            "format": "int64"
+          },
+          "name": {
+            "type": "string",
+            "default": "dog"
+          }
+        },
+        "required": ["name"]
+      },
+      "Tag": {
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "integer",
+            "format": "int64"
+          },
+          "name": {
+            "type": "string"
+          }
+        }
+      },
+      "Pet": {
+        "type": "object",
+        "required": ["name", "photoUrls", "category"],
+        "properties": {
+          "id": {
+            "type": "integer",
+            "format": "int64",
+            "readOnly": true,
+            "default": 40,
+            "example": 25
+          },
+          "category": {
+            "$ref": "#/components/schemas/Category"
+          },
+          "name": {
+            "type": "string",
+            "example": "doggie",
+            "default": "buster"
+          },
+          "photoUrls": {
+            "type": "array",
+            "items": {
+              "type": "string",
+              "example": "https://example.com/photo.png"
+            }
+          },
+          "tags": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/Tag"
+            }
+          },
+          "status": {
+            "type": "string",
+            "description": "pet status in the store",
+            "enum": ["available", "pending", "sold"]
+          }
+        }
+      }
+    }
+  }
+}

package/test-utils/definitions/operationid-quirks.json

@@ -0,0 +1,36 @@
+{
+  "openapi": "3.1.0",
+  "info": {
+    "title": "Quirky `operationID` cases",
+    "version": "1.0.0"
+  },
+  "servers": [
+    {
+      "url": "https://httpbin.org/anything"
+    }
+  ],
+  "paths": {
+    "/quirky-operationId": {
+      "get": {
+        "description": "This mess of a string is intentionally nasty so we can be sure that we're not including anything that wouldn't look right as an operationID for a potential method accessor in `api`.",
+        "operationId": "quirky/?*!@#$%^&*()-=_.,<>+[]{}\\|operation-id_string"
+      }
+    },
+    "/no-operation-id": {
+      "get": {
+        "description": "This operation doesn't have an `operationId` so we should create one."
+      }
+    },
+    "/get-operation-path-starts-with-an-http-method": {
+      "get": {
+        "description": "This operation has no `operationId` but because path starts with an HTTP method when we generate an `operationId` that has `get` doubled."
+      }
+    },
+    "/hyphenated-operation-id": {
+      "get": {
+        "operationId": "hyphenated-operation-id",
+        "description": "This operation has an `operationId` with hypens yet it should still be accessible in the dynamic `api` flow."
+      }
+    }
+  }
+}

package/test-utils/definitions/optional-payload.json

@@ -0,0 +1,57 @@
+{
+  "openapi": "3.0.0",
+  "info": {
+    "version": "1.0.0",
+    "title": "Example API with a requestBody payload that's optional."
+  },
+  "servers": [
+    {
+      "url": "http://petstore.swagger.io/v2"
+    }
+  ],
+  "paths": {
+    "/pet/{petId}": {
+      "post": {
+        "summary": "Updates a pet in the store with form data",
+        "description": "",
+        "operationId": "updatePetWithForm",
+        "parameters": [
+          {
+            "name": "petId",
+            "in": "path",
+            "description": "ID of pet that needs to be updated",
+            "required": true,
+            "schema": {
+              "type": "integer",
+              "format": "int64"
+            }
+          }
+        ],
+        "requestBody": {
+          "content": {
+            "application/x-www-form-urlencoded": {
+              "schema": {
+                "type": "object",
+                "properties": {
+                  "name": {
+                    "description": "Updated name of the pet",
+                    "type": "string"
+                  },
+                  "status": {
+                    "description": "Updated status of the pet",
+                    "type": "string"
+                  }
+                }
+              }
+            }
+          }
+        },
+        "responses": {
+          "405": {
+            "description": "Invalid input"
+          }
+        }
+      }
+    }
+  }
+}