search

aep-dev / aep.dev

AEPs help developers and organizations build clear, consistent network APIs and clients by providing an extensible set of design guidelines.
http://aep.dev/
Other
20 stars 15 forks source link

Propose a standard for OAS operationIDs. #208

Open toumorokoshi opened 1 month ago

toumorokoshi commented 1 month ago

OpenAPI specifications have an "operationID" field, of which there is no prescriptive syntax.

We should try define a standard for AEPs that will serve the clients.

Context:

:thinking: well, I don't know if we've actually made a decision about the operationId yet, and I think that it's usage will be very critical when we start building clients.

For now I'll remove it, and will probably do a follow-up to determine the standard around OAS operations IDs.

_Originally posted by @toumorokoshi in https://github.com/aep-dev/aep.dev/pull/206#discussion_r1717961984_

toumorokoshi commented 3 weeks ago

The operationID is a great place to add information that could be relevant to generated clients. I think we should consider how much information we could inject into it before finalizing it.