microsoftgraph / microsoftgraph/msgraph-metadata

SearchHit and SearchQuery have properties with incorrect conventions.

Open
#267 0 comments 0 reactions 1 assignee View on GitHub

@irvinesunday is already working on this.

Since Feb 8, 2023.

priority:p2
Dominant language
XSLT
Stars
166
Forks
55
Avg merge
16h 12m
Merged PRs (30d)
14

Description

SearchHit and SearchQuery have properties beginning with an underscore against conventions.

<ComplexType Name="searchHit">
  <Property Name="contentSource" Type="Edm.String"/>
  <Property Name="hitId" Type="Edm.String"/>
  <Property Name="isCollapsed" Type="Edm.Boolean"/>
  <Property Name="rank" Type="Edm.Int32"/>
  <Property Name="resultTemplateId" Type="Edm.String"/>
  <Property Name="summary" Type="Edm.String"/>
  <Property Name="_id" Type="Edm.String"/>
  <Property Name="_score" Type="Edm.Int32"/>
  <Property Name="_summary" Type="Edm.String"/>
  <NavigationProperty Name="resource" Type="graph.entity" ContainsTarget="true"/>
  <NavigationProperty Name="_source" Type="graph.entity" ContainsTarget="true"/>
</ComplexType>

Its important to note that these properties have been marked deprecated for now and no action may be needed if they end up being removed from the metadata.

<Annotations Target="microsoft.graph.searchHit/_id">
        <Annotation Term="Org.OData.Core.V1.Revisions">
            <Collection>
                <Record>
                    <PropertyValue Property="Date" Date="2021-12-14" />
                    <PropertyValue Property="Description" String="The _id will be removed on December 31, 2022. Use the id instead." />
                    <PropertyValue Property="Kind">
                        <EnumMember>Org.OData.Core.V1.RevisionKind/Deprecated</EnumMember>
                    </PropertyValue>
                    <PropertyValue Property="RemovalDate" Date="2022-12-31" />
                    <PropertyValue Property="Version" String="2021-12/RemoveDeprecatedUnderscoreProperty" />
                </Record>
            </Collection>
        </Annotation>
    </Annotations>
    <Annotations Target="microsoft.graph.searchHit/_score">
        <Annotation Term="Org.OData.Core.V1.Revisions">
            <Collection>
                <Record>
                    <PropertyValue Property="Date" Date="2021-12-14" />
                    <PropertyValue Property="Description" String="The _score will be removed on December 31, 2022. Use the rank instead." />
                    <PropertyValue Property="Kind">
                        <EnumMember>Org.OData.Core.V1.RevisionKind/Deprecated</EnumMember>
                    </PropertyValue>
                    <PropertyValue Property="RemovalDate" Date="2022-12-31" />
                    <PropertyValue Property="Version" String="2021-12/RemoveDeprecatedUnderscoreProperty" />
                </Record>
            </Collection>
        </Annotation>
    </Annotations>
    <Annotations Target="microsoft.graph.searchHit/_summary">
        <Annotation Term="Org.OData.Core.V1.Revisions">
            <Collection>
                <Record>
                    <PropertyValue Property="Date" Date="2021-12-14" />
                    <PropertyValue Property="Description" String="The _summary will be removed on December 31, 2022. Use the summary instead." />
                    <PropertyValue Property="Kind">
                        <EnumMember>Org.OData.Core.V1.RevisionKind/Deprecated</EnumMember>
                    </PropertyValue>
                    <PropertyValue Property="RemovalDate" Date="2022-12-31" />
                    <PropertyValue Property="Version" String="2021-12/RemoveDeprecatedUnderscoreProperty" />
                </Record>
            </Collection>
        </Annotation>
    </Annotations>
    <Annotations Target="microsoft.graph.searchHit/_source">
        <Annotation Term="Org.OData.Core.V1.Revisions">
            <Collection>
                <Record>
                    <PropertyValue Property="Date" Date="2020-09-15" />
                    <PropertyValue Property="Description" String="The _source property is deprecated and will stop supporting on December 15, 2020. Please use the new property resource." />
                    <PropertyValue Property="Kind">
                        <EnumMember>Org.OData.Core.V1.RevisionKind/Deprecated</EnumMember>
                    </PropertyValue>
                    <PropertyValue Property="RemovalDate" Date="2020-12-15" />
                    <PropertyValue Property="Version" String="2020-09/MVP3" />
                </Record>
            </Collection>
        </Annotation>
    </Annotations>

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.