Skip to content

[PoC] Demonstrate metadata needed for spending-policy operations - #1247

Draft
Concepta Njolima (ConceptaNjolima) wants to merge 1 commit into
microsoftgraph:masterfrom
ConceptaNjolima:cnjolima-microsoft-selected-groups-metadata-fix
Draft

Concepta Njolima (ConceptaNjolima) wants to merge 1 commit into
microsoftgraph:masterfrom
ConceptaNjolima:cnjolima-microsoft-selected-groups-metadata-fix

Conversation

@ConceptaNjolima

Copy link
Copy Markdown

Draft for AGS/Graph DevX guidance—not ready to merge.

Purpose and scope

Demonstrate the metadata needed to generate seven spending-policy operations, and expose the remaining converter/contract questions before proposing a production correction.

This PoC adds narrowly scoped beta preprocessing for:

  • microsoft.graph.costManagementRoot/spendingPolicies: Org.OData.Validation.V1.DerivedTypeConstraint listing both microsoft.graph.allUsersSpendingPolicy and microsoft.graph.selectedGroupsSpendingPolicy.
  • microsoft.graph.selectedGroupsSpendingPolicy/assignedGroups: Org.OData.Capabilities.V1.NavigationRestrictions / Referenceable=true.
  • microsoft.graph.costManagementAlertSetting/recipients: the same property-scoped reference annotation.

The reference rules use the existing ReferenceableRestrictionsTemplate when no restriction exists, add a missing field to an existing inline/out-of-line record, and preserve explicit existing values and unrelated annotations. They run only for beta when capability annotations are retained. The change does not edit production metadata snapshots, converter settings/source, permissions, flags, tenant-balance behavior, or reporting APIs.

Public precedents: microsoftgraph/msgraph-metadata#473 and microsoftgraph/msgraph-metadata#792.

Observed Graph Explorer route coverage

All seven methods below are generated from the actual source transform using the checked-in conversion-settings/graphexplorer.json. They are absent in the original baseline. The repository's key names are retained; /beta is not a path prefix.

ID Method Generated path
P07 GET /copilot/costManagement/spendingPolicies/{spendingPolicy-id}/microsoft.graph.selectedGroupsSpendingPolicy/assignedGroups
P08 GET /copilot/costManagement/spendingPolicies/{spendingPolicy-id}/microsoft.graph.selectedGroupsSpendingPolicy/assignedGroups/$ref
P09 POST /copilot/costManagement/spendingPolicies/{spendingPolicy-id}/microsoft.graph.selectedGroupsSpendingPolicy/assignedGroups/$ref
P10 DELETE /copilot/costManagement/spendingPolicies/{spendingPolicy-id}/microsoft.graph.selectedGroupsSpendingPolicy/assignedGroups/{group-id}/$ref
P19 GET /copilot/costManagement/spendingPolicies/{spendingPolicy-id}/emailThresholdSettings/recipients/$ref
P20 POST /copilot/costManagement/spendingPolicies/{spendingPolicy-id}/emailThresholdSettings/recipients/$ref
P21 DELETE /copilot/costManagement/spendingPolicies/{spendingPolicy-id}/emailThresholdSettings/recipients/{user-id}/$ref

Verification

  • Public schema baseline: 19426105dd741181fffcd4972c8800b569360bed; unchanged full beta and v1.0 inputs.
  • Reviewed PoC commit: 4cc70de79da099c47fd284e4227811cc874017db (tree dd42b18102867a5b2d5da9e9f896a72174efc4c4).
  • Actual source transform uses -addInnerErrorDescription $true -removeCapabilityAnnotations $false with explicit -csdlVersion beta / v1.0.
  • A fresh full-beta Graph Explorer conversion used repository-pinned Hidi 1.6.24 (Microsoft.OpenApi.OData/1.7.5, source c2dacfcf324a9f71d4ede0c44136fc021b6cd0ca, EDM 7.21.6). This is not a claim about the deployed converter version.
  • The entire parsed OpenAPI document equals the earlier combined annotation experiment. Source CSDL equals that experiment after relocating only the two new reference annotations from inline to the equivalent property-scoped out-of-line locations. Existing full delta/payload evidence therefore applies unchanged.
  • The actual full v1.0 transform is byte-identical to baseline.
  • All 54 focused source regression tests pass against the exact staged snapshot, including beta/v1.0/default behavior, exact target scope, capability removal, preservation of existing inline/out-of-line and qualified records, explicit true/false values, and duplicate prevention. The shared default fixture regenerates byte-for-byte; the staged diff check passes.
  • Independent staged review identified one test-coverage gap in out-of-line duplicate assertions; it was corrected and the targeted re-review found it resolved. A mutation removing that guard is caught by six tests. No unresolved implementation finding remains; the generated-contract limitations below are intentionally unresolved.

No new full cross-profile matrix, remote CI, Redocly lint, live endpoint, or production publishing success is claimed. The CLI-generated server remains http://localhost, as in the baseline. Earlier matrix evidence covers only its original candidate, not this source revision.

Known limitations — guidance requested

Route generation is not contract acceptance. Against the original Graph Explorer baseline, this PoC adds 36 path items / 59 operations and removes 2 path items / 4 operations; it changes no surviving operation objects or non-path document sections. Four existing path items change only in grouped-path documentation extensions.

  • Restricted cast reads remain. Both collection and keyed selected-groups cast GETs are emitted despite the existing Readable=false annotation at microsoft.graph.GraphService/copilot/costManagement/spendingPolicies/microsoft.graph.selectedGroupsSpendingPolicy.
  • Other operations are generated. Ordinary POST on assignedGroups remains. Derived policy casts also expose inherited email-threshold, recipient, mailbox-setting, service-setting, count, and navigation operations. This PR does not approve that added surface.
  • Referenceable is not additive. Non-reference keyed and alternate-key GET/DELETE routes disappear for the reference-enabled properties. Compared with the constraint-only control, 8 path items / 16 operations are replaced: assigned groups plus recipients on the uncast policy and both subtype casts. Against the original baseline, the lost routes are GET/DELETE on .../emailThresholdSettings/recipients/{user-id} and .../recipients(userPrincipalName='{userPrincipalName}').
  • Extra collection deletes appear. Four DELETE .../$ref operations require query parameter @id: string: assigned groups and the three recipient locations. These are outside the seven target entries.
  • GET reference schema needs correction or guidance. P08/P19 resolve to StringCollectionResponse, whose value items are strings, not @odata.id objects. The successful response is 200; POST and DELETE use 204.
  • POST reference required-property semantics are missing. refPostBody is required, but its ReferenceCreate schema only declares an @odata.id string property and has no schema required list requiring that property.
  • Strict bundled-vocabulary validation is not proven. A separate pinned-library probe parses the reference annotations but strict EDM validation reports RecordExpressionHasExtraProperties: the bundled EDM 7.21.6 record lacks Referenceable. Conversion uses the unchanged default VerifyEdmModel=false. This is a scoped bundled-vocabulary caveat, not a claim about every validator or production configuration.

Please advise whether these property annotations are the appropriate metadata contract and which converter/schema work is required before a production-ready correction. This draft intentionally preserves the failures for review rather than suppressing operations or relaxing restrictions to make acceptance appear green.

Make the seven targeted spending policy operations discoverable
for draft PoC review. This is not a production-ready correction.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Copilot-Session: 3182eba0-4459-445a-92ee-f0a9a580fadd
@microsoft-github-policy-service

Copy link
Copy Markdown

Concepta Njolima (@ConceptaNjolima) please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@microsoft-github-policy-service agree [company="{your company}"]

Options:

  • (default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.
@microsoft-github-policy-service agree
  • (when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.
@microsoft-github-policy-service agree company="Microsoft"
Contributor License Agreement

Contribution License Agreement

This Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”),
and conveys certain license rights to Microsoft Corporation and its affiliates (“Microsoft”) for Your
contributions to Microsoft open source projects. This Agreement is effective as of the latest signature
date below.

  1. Definitions.
    “Code” means the computer software code, whether in human-readable or machine-executable form,
    that is delivered by You to Microsoft under this Agreement.
    “Project” means any of the projects owned or managed by Microsoft and offered under a license
    approved by the Open Source Initiative (www.opensource.org).
    “Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any
    Project, including but not limited to communication on electronic mailing lists, source code control
    systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of
    discussing and improving that Project, but excluding communication that is conspicuously marked or
    otherwise designated in writing by You as “Not a Submission.”
    “Submission” means the Code and any other copyrightable material Submitted by You, including any
    associated comments and documentation.
  2. Your Submission. You must agree to the terms of this Agreement before making a Submission to any
    Project. This Agreement covers any and all Submissions that You, now or in the future (except as
    described in Section 4 below), Submit to any Project.
  3. Originality of Work. You represent that each of Your Submissions is entirely Your original work.
    Should You wish to Submit materials that are not Your original work, You may Submit them separately
    to the Project if You (a) retain all copyright and license information that was in the materials as You
    received them, (b) in the description accompanying Your Submission, include the phrase “Submission
    containing materials of a third party:” followed by the names of the third party and any licenses or other
    restrictions of which You are aware, and (c) follow any other instructions in the Project’s written
    guidelines concerning Submissions.
  4. Your Employer. References to “employer” in this Agreement include Your employer or anyone else
    for whom You are acting in making Your Submission, e.g. as a contractor, vendor, or agent. If Your
    Submission is made in the course of Your work for an employer or Your employer has intellectual
    property rights in Your Submission by contract or applicable law, You must secure permission from Your
    employer to make the Submission before signing this Agreement. In that case, the term “You” in this
    Agreement will refer to You and the employer collectively. If You change employers in the future and
    desire to Submit additional Submissions for the new employer, then You agree to sign a new Agreement
    and secure permission from the new employer before Submitting those Submissions.
  5. Licenses.
  • Copyright License. You grant Microsoft, and those who receive the Submission directly or
    indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license in the
    Submission to reproduce, prepare derivative works of, publicly display, publicly perform, and distribute
    the Submission and such derivative works, and to sublicense any or all of the foregoing rights to third
    parties.
  • Patent License. You grant Microsoft, and those who receive the Submission directly or
    indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license under
    Your patent claims that are necessarily infringed by the Submission or the combination of the
    Submission with the Project to which it was Submitted to make, have made, use, offer to sell, sell and
    import or otherwise dispose of the Submission alone or with the Project.
  • Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement.
    No additional licenses or rights whatsoever (including, without limitation, any implied licenses) are
    granted by implication, exhaustion, estoppel or otherwise.
  1. Representations and Warranties. You represent that You are legally entitled to grant the above
    licenses. You represent that each of Your Submissions is entirely Your original work (except as You may
    have disclosed under Section 3). You represent that You have secured permission from Your employer to
    make the Submission in cases where Your Submission is made in the course of Your work for Your
    employer or Your employer has intellectual property rights in Your Submission by contract or applicable
    law. If You are signing this Agreement on behalf of Your employer, You represent and warrant that You
    have the necessary authority to bind the listed employer to the obligations contained in this Agreement.
    You are not expected to provide support for Your Submission, unless You choose to do so. UNLESS
    REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE WARRANTIES
    EXPRESSLY STATED IN SECTIONS 3, 4, AND 6, THE SUBMISSION PROVIDED UNDER THIS AGREEMENT IS
    PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY OF
    NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
  2. Notice to Microsoft. You agree to notify Microsoft in writing of any facts or circumstances of which
    You later become aware that would make Your representations in this Agreement inaccurate in any
    respect.
  3. Information about Submissions. You agree that contributions to Projects and information about
    contributions may be maintained indefinitely and disclosed publicly, including Your name and other
    information that You submit with Your Submission.
  4. Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and
    the parties consent to exclusive jurisdiction and venue in the federal courts sitting in King County,
    Washington, unless no federal subject matter jurisdiction exists, in which case the parties consent to
    exclusive jurisdiction and venue in the Superior Court of King County, Washington. The parties waive all
    defenses of lack of personal jurisdiction and forum non-conveniens.
  5. Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and
    supersedes any and all prior agreements, understandings or communications, written or oral, between
    the parties relating to the subject matter hereof. This Agreement may be assigned by Microsoft.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant