Design the API specification for Scribe-Server

[wkyoshida]

Terms

• I have searched open and closed issues
• I agree to follow Scribe-Server's Code of Conduct

Issue

This issue is to track the design and documentation work for the specification/schema of the Scribe-Server API.

[wkyoshida]

Going with the oapi-codegen tooling to assist with code generation given an OpenAPI specification file

[Jk40git]

@wkyoshida want to help on the documentation

[wkyoshida]

Hey, @Jk40git ! 👋

Thanks so much for the interest!

The documentation piece for this issue is really more so just me writing out the design of the OpenAPI specification for the Scribe-Server API in the openapi.yaml actually 😁

I am considering setting up some user-facing documentation for using the Scribe-Server API later though, but that'll be a little ways ahead - mostly after this issue here is complete for the most part. I'll create the issue and can tag you there though if you're interested in that!

[Jk40git]

Hey, @Jk40git ! 👋

Thanks so much for the interest!

The documentation piece for this issue is really more so just me writing out the design of the OpenAPI specification for the Scribe-Server API in the openapi.yaml actually 😁

I am considering setting up some user-facing documentation for using the Scribe-Server API later though, but that'll be a little ways ahead - mostly after this issue here is complete for the most part. I'll create the issue and can tag you there though if you're interested in that!

all right that will be fine 👍