bf2fc6cc711aee1a0c2a / architecture

Repository containing the architecture documents.
https://architecture.bf2.dev/
Apache License 2.0
5 stars 20 forks source link

OpenAPI clients code generation - Kiota #87

Closed andreaTP closed 1 year ago

andreaTP commented 1 year ago

Reference the Original doc.

andreaTP commented 1 year ago

cc. @tombentley please assign this issue to me.

tombentley commented 1 year ago

@andreaTP it's an AP you want, right? (not an ADR)

andreaTP commented 1 year ago

Hi @tombentley , thanks for taking a look!

I'm finding it a little confusing to identify if I should submit an AP or an ADR.

Currently in the available documentation: https://github.com/bf2fc6cc711aee1a0c2a/architecture/blob/main/pages/about/index.adoc#architectural-pattern

I can see that, in the AP description, the term ADR is used interchangeably and I'm finding it hard to identify the key differences. Would you mind clarifying or directly suggesting the best curse of action?

tombentley commented 1 year ago

ADR records a decision (specific to a single service) that MUST be followed in applicable circumstances. The only way to avoid it is to supersede the decision.

PADR records a decision (applying to all services) that MUST be followed in applicable circumstances. The only way to avoid it is to supersede the decision.

Obviously these are a bit written-in-stone. So AP provides mechanism for saying "We think this is what we want to do, but we want to see whether the pattern is really generally applicable before we promote it to PADR".

From the draft document you linked, I think this should be an AP. Once we've got experience with Kiota for at least one service we could have an PADR to record that it's what everyone MUST use from now on.

Does that sound OK/work for you?

andreaTP commented 1 year ago

Thanks a ton for the clarification.

Yes, I'm fine with submitting it as an AP!

tombentley commented 1 year ago

create ap

tombentley commented 1 year ago

/create ap

bf2-arch-bot[bot] commented 1 year ago

Closing following creation of AP-17 @andreaTP, please write your content in _ap/17/index.adoc and open a PR for AP acceptance.

andreaTP commented 1 year ago

@tombentley the number given by the automation is colliding on @shawkins https://github.com/bf2fc6cc711aee1a0c2a/architecture/pull/82

tombentley commented 1 year ago

Sigh. Avoiding this kind of thing is why the automation allocates the id in an initial (basically empty) PR. It's not the fault of @shawkins for not knowing that (because the bot is only now working thanks to @grdryn).

@andreaTP I'll bump your AP id manually. That should be enough to fix it for future APs too.

tombentley commented 1 year ago

@andreaTP you now have ADR 18 (you can re-fetch main).

andreaTP commented 1 year ago

Cool, thanks for sorting things out! I'll continue to work on AP 18