odata-v4-service-metadata's Introduction

OData V4 Service Metadata Document

Using this module you can generate a service metadata document response from a simple JSON format, an advanced schema JSON format or an Edmx instance created with odata-v4-metadata.

Basic usage

Use the simple JSON format and convert your metadata JSON to a service metadata document.

var ServiceMetadata = require('odata-v4-service-metadata').ServiceMetadata;

// $metadata express.js route
app.get('/odata/\\$metadata', ServiceMetadata.defineEntities({
    namespace: 'Default',
    containerName: 'Container',
    entities: [
        {
            name: 'Kitten',
            collectionName: 'Kittens',
            keys: ['Id'],
            computedKey: true,
            properties: {
                Id: 'Edm.String',
                Name: 'Edm.String',
                Age: 'Edm.Int32',
                Lives: 'Edm.Int32',
                Owner: 'Edm.String'
            },
            annotations:[
                { name: 'UI.DisplayName', value: 'Meww' },
                { property: 'Id', name: 'UI.ReadOnly', value: 'true' },
                { property: 'Title', name: 'UI.DisplayName', value: 'Meww Meww' },
            ]
        }
    ]
}).requestHandler());

Advanced usage

Use a schema JSON, which is more verbose, but you can customize the metadata in a more advanced way.

var ServiceMetadata = require('odata-v4-service-metadata').ServiceMetadata;
var schema = require('./schema');
var serviceMetadata = ServiceMetadata.processMetadataJson(schema);
var serviceMetadataDocument = serviceMetadata.document();

An example schema JSON looks like this

odata-v4-service-metadata's People

Contributors

Stargazers

Watchers

odata-v4-service-metadata's Issues

Declare LICENSE

Declare a license for this source code plz.

Declaring NavigationPropertyBinding EntitySet in JSON schema does not produce desired $metadata.xml output

Having declared:

"entityType" : [
{
    "name" : "ParentType",
    "navigationProperty": {
        "name": "Child",
        "type": "ChildType"
    }...
}

and then:

"entitySet": [
    {
        "navigationPropertyBinding": [
            {
                "path": "Child",
                "target": "Children"
            }
        ],
        "name": "Parents",
        "entityType": "ParentType"
    }....

the $metadata XML that gets created contains:

<NavigationProperty Name="Child" Type="ChildType"/>

in EntityType section however, the following "NavigationPropertyBinding" information is missing but seems to be required in such situation according to OData specs.

<EntitySet Name="PArents" EntityType="ParentType">
       <NavigationPropertyBinding Path="Child" Target="Children">
        </NavigationPropertyBinding>