Azure / Azure/azure-rest-api-specs

Allow to define blueprint artifacts as part of the blueprint entity itself

Open
#14,010 1 comment 0 reactions 0 assignees View on GitHub
Blueprint Service Attention
Dominant language
TypeSpec
Stars
3.1k
Forks
5.9k
Avg merge
2d 22h
Merged PRs (30d)
444

Description

In order to simplify the creation of blueprint objects it would be great if one could have the blueprint artifacts defined within the spec of the Blueprint itself.

As far as I've understood, per the current api spec, the blueprint entity and the artifact entity are treated as completely independent resources (although the Artifacts are actually child objects of a blueprint). It would make sense, in my view, that the blueprint entity had an optional property consisting on the list of artifacts applicable to that blueprint as a blueprint without artifacts would only be able to define resource groups as per the current api spec and one would need to define the artifacts in subsequent api operations one per each artifact to add.

Auto generated clients from this api spec will then inherit the above mentioned limitations.

Contributor guide

Open the contributing guide

Research direction

No file or test is named in the issue. Start by reviewing the current blueprint and artifact resource definitions in the API specification, then determine how an optional artifact list should be represented within Blueprint and reflected by generated clients. Done means the specification supports creating a blueprint with its artifacts while preserving blueprints without artifacts.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi
Domain
api, backend-api-design
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.