Skip to content
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.

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

Update the WireMock openapi #298

Merged
merged 2 commits into from
Jul 4, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
327 changes: 312 additions & 15 deletions assets/js/wiremock-admin-api.json

Large diffs are not rendered by default.

5 changes: 5 additions & 0 deletions swagger/examples/health.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
status: "healthy"
message: "Wiremock is ok"
version: "3.8.0"
uptimeInSeconds: 14355
timestamp: "2024-07-03T13:16:06.172362Z"
2 changes: 1 addition & 1 deletion swagger/examples/record-spec.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
targetBaseUrl: http://examples.wiremockapi.cloud/
targetBaseUrl: https://examples.wiremockapi.cloud/
filters:
urlPathPattern: "/api/.*"
method: GET
Expand Down
25 changes: 25 additions & 0 deletions swagger/schemas/health.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
type: object
properties:
status:
type: string
example: "healthy"
description: "The status of the server"
enum:
- healthy
- unhealthy
message:
type: string
description: "Longer message regarding the status of the server"
example: "Wiremock is ok"
version:
type: string
description: "The WireMock version"
example: "3.8.0"
uptimeInSeconds:
type: integer
description: "How long the server has been running"
example: 14355
timestamp:
type: string
description: "The current timestamp"
example: "2024-07-03T13:16:06.172362Z"
38 changes: 38 additions & 0 deletions swagger/schemas/request-pattern.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,15 @@ example:
method: POST
url: /some/thing
properties:
scheme:
type: string
description: The URI scheme
host:
type: object
description: 'URI host pattern to match against in the "<predicate>": "<value>" form'
port:
type: integer
description: The HTTP port number
method:
type: string
description: The HTTP request method e.g. GET
Expand Down Expand Up @@ -48,3 +57,32 @@ properties:
description: 'Request body patterns to match against in the <key>: { "<predicate>": "<value>" } form'
items:
type: object
customMatcher:
type: object
description: Custom request matcher to match against
properties:
name:
type: string
description: The matcher's name specified in the implementation of the matcher.
parameters:
type: object
multipartPatterns:
type: array
description: Multipart patterns to match against headers and body
items:
type: object
properties:
name:
type: string
matchingType:
type: string
default: ANY
enum:
- ALL
- ANY
headers:
type: object
bodyPatterns:
type: array
items:
type: object
5 changes: 5 additions & 0 deletions swagger/schemas/response-definition.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,11 @@ allOf:
additionalProxyRequestHeaders:
type: object
description: Extra request headers to send when proxying to another host.
removeProxyRequestHeaders:
type: array
description: Request headers to remove when proxying to another host.
items:
type: string
body:
type: string
description: The response body as a string. Only one of body, base64Body, jsonBody or bodyFileName may be specified.
Expand Down
19 changes: 19 additions & 0 deletions swagger/schemas/stub-mapping.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,25 @@ properties:
postServeActions:
type: object
description: A map of the names of post serve action extensions to trigger and their parameters.
serveEventListeners:
type: array
description: The list of serve event listeners
items:
type: object
properties:
name:
type: string
requestPhases:
type: array
items:
type: string
enum:
- BEFORE_MATCH
- AFTER_MATCH
- BEFORE_RESPONSE_SENT
- AFTER_COMPLETE
parameters:
type: object
metadata:
type: object
description: Arbitrary metadata to be used for e.g. tagging, documentation. Can also be used to find and remove stubs.
Expand Down
Loading
Loading