Skip to content

add update endpoint #66

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

add update endpoint #66

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
167 changes: 164 additions & 3 deletions config/routes.oas.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,28 @@
"201": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique identifier for the mock bin"
},
"url": {
"type": "string",
"description": "URL to invoke the mock"
},
"secret": {
"type": "string",
"description": "Secret ID required for updating this mock"
}
}
},
"examples": [
{
"binId": "n6zbnzSHBVTdmd05CLrNc",
"url": "https://api.mockbin.io/n6zbnzSHBVTdmd05CLrNc"
"id": "n6zbnzSHBVTdmd05CLrNc",
"url": "https://api.mockbin.io/n6zbnzSHBVTdmd05CLrNc",
"secret": "a1b2c3d4e5f6g7h8i9j0"
}
]
}
Expand Down Expand Up @@ -82,7 +100,55 @@
},
"post": {
"summary": "Create OpenAPI bin",
"description": "Lorem ipsum dolor sit amet, **consectetur adipiscing** elit, sed do `eiusmod tempor` incididunt ut labore et dolore magna aliqua.",
"description": "Creates a new mock bin from an OpenAPI specification file",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"file": {
"type": "string",
"format": "binary",
"description": "OpenAPI specification file (JSON or YAML)"
}
}
}
}
}
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique identifier for the mock bin"
},
"url": {
"type": "string",
"description": "URL to invoke the mock"
},
"secret": {
"type": "string",
"description": "Secret ID required for updating this mock"
}
}
},
"examples": [
{
"id": "n6zbnzSHBVTdmd05CLrNc_oas",
"url": "https://api.mockbin.io/n6zbnzSHBVTdmd05CLrNc_oas",
"secret": "a1b2c3d4e5f6g7h8i9j0"
}
]
}
}
}
},
"x-zuplo-route": {
"corsPolicy": "anything-goes",
"handler": {
Expand Down Expand Up @@ -122,6 +188,101 @@
}
},
"operationId": "2ae802d2-c8e1-40ba-ac2e-f45a9b4eafab"
},
"put": {
"summary": "Update bin",
"description": "Updates an existing mock bin using the secret ID for authentication",
"parameters": [
{
"name": "x-mockbin-secret",
"in": "header",
"required": true,
"schema": {
"type": "string"
},
"description": "Secret ID required for updating the mock"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": false,
"properties": {
"response": {
"type": "object",
"additionalProperties": false,
"required": [
"status"
],
"properties": {
"status": {
"type": "number"
},
"statusText": {
"type": "string"
},
"headers": {
"type": "object"
},
"body": {
"type": "string"
}
}
}
}
}
},
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"file": {
"type": "string",
"format": "binary",
"description": "OpenAPI specification file (JSON or YAML)"
}
}
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": [
{
"id": "n6zbnzSHBVTdmd05CLrNc",
"url": "https://api.mockbin.io/n6zbnzSHBVTdmd05CLrNc"
}
]
}
}
},
"401": {
"description": "Unauthorized - Invalid or missing secret"
},
"404": {
"description": "Mock not found"
}
},
"x-zuplo-route": {
"corsPolicy": "anything-goes",
"handler": {
"export": "updateMockResponse",
"module": "$import(./modules/handlers)",
"options": {}
},
"policies": {
"inbound": [
"block-bad-bins",
"rate-limit-inbound"
]
}
},
"operationId": "update-bin-response"
}
},
"/v1/bins/{binId}/requests": {
Expand Down
Loading