Skip to content

Commit 57a4c1d

Browse files
author
Caitlin Bales (MSFT)
authored
Add metadata augmentation steps
As per #93
1 parent 18e59c3 commit 57a4c1d

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ Currently the following target languages are supported by this writer:
1010
- Objective-C
1111
- Python
1212
- TypeScript
13+
- PHP
1314

1415
# Contents
1516
- [Prerequisites](#prerequisites)
@@ -123,6 +124,21 @@ Note: You can also check in a template by `odcjObject.LongDescriptionContains("f
123124

124125
**Note: Includes/Excludes and Ignore/Matches were used before Vipr had full support for annotations; now that annotations have been added to Vipr usage of these parameters should be limited to legacy scenarios**
125126

127+
## Building against Graph Metadata
128+
129+
There are currently several steps we take to form the metadata into one that will successfully generate SDKs in the shape we expect:
130+
131+
- Remove capability annotations (see [#132](https://github.com/Microsoft/Vipr/issues/132))
132+
- Add navigation annotation to thumbnail
133+
```xml
134+
<Annotation String="navigable" Term="Org.OData.Core.V1.LongDescription"/>
135+
```
136+
- Remove HasStream properties from ```onenoteEntitySchemaObjectModel``` and ```onenoteEntityBaseModel```
137+
- Add ```ContainsTarget="true"``` to navigation properties that do not have a corresponding EntitySet
138+
- Add long descriptions to types and properties from [docs](https://developer.microsoft.com/en-us/graph/docs/concepts/overview)
139+
140+
In order to build against metadata other than that stored in the [metadata](https://github.com/microsoftgraph/MSGraph-SDK-Code-Generator/tree/master/metadata) directory, you will need to perform the first four on this list.
141+
126142
## Contributing
127143

128144
Before we can accept your pull request, you'll need to electronically complete Microsoft's [Contributor License Agreement](https://cla.microsoft.com/). If you've done this for other Microsoft projects, then you're already covered.

0 commit comments

Comments
 (0)