Open Specification for WireMock's standalone server Admin APIs

oleg-nenashev commented 1 year ago

Proposal

There are many implementations of WireMock including the standalone server, and they have different REST APIs. It would be nice, in collaboration with maintainers of the implementations, to create an open specification within the WireMock organization that would be used as a recommended implementation of the interfaces.

Suggested implementation:

Standalone repository for the specification
SemVer versioning

Channel

#spec on WireMock Slack

If there are any existing implementations, prototypes, blogs or etc, let us know!

WireMock Java schemas: https://github.com/wiremock/wiremock.org-sources/tree/master/swagger
WireMock.NET Admin API reference: https://github.com/WireMock-Net/WireMock.Net/wiki/Admin-API-Reference
Compatibility note for WireMock.NET: https://github.com/WireMock-Net/WireMock.Net/wiki/Compatibility-WireMock.org

Reference any relevant documentation, other materials or issues/pull requests that can be used for inspiration.

wiremock/spec#1

oleg-nenashev commented 1 year ago

Created https://github.com/wiremock/spec as a foundation repository

cezarypiatek commented 1 year ago

I just wanted to use schema definition to generate C# client but it looks like the schema is incomplete. For example, there's no schema definition for a response from __admin/requests https://github.com/wiremock/spec/blob/main/wiremock/wiremock-admin-api/wiremock-admin-api.yaml#L216

@oleg-nenashev can you provide the missing bits and pieces?

oleg-nenashev commented 1 year ago

Yes, it needs to be updated for the recent version. Unfortunately I wasn't able to work on that before my vacation but I will revisit it in August

wiremock / spec