OpenAPI.NET.OData/docs/oas3_0_0/TripService.yaml

2018 lines
60 KiB
YAML

openapi: 3.0.1
info:
title: OData Service for namespace Microsoft.OData.Service.Sample.TrippinInMemory.Models
description: This OData service is located at http://localhost
version: 1.0.1
servers:
- url: http://localhost
paths:
/People:
get:
tags:
- People.Person
summary: Get entities from People
operationId: People.Person.ListPerson
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
schema:
uniqueItems: true
type: array
items:
enum:
- UserName
- UserName desc
- FirstName
- FirstName desc
- LastName
- LastName desc
- MiddleName
- MiddleName desc
- Gender
- Gender desc
- Age
- Age desc
- Emails
- Emails desc
- AddressInfo
- AddressInfo desc
- HomeAddress
- HomeAddress desc
- FavoriteFeature
- FavoriteFeature desc
- Features
- Features desc
type: string
- name: $select
in: query
description: Select properties to be returned
schema:
uniqueItems: true
type: array
items:
enum:
- UserName
- FirstName
- LastName
- MiddleName
- Gender
- Age
- Emails
- AddressInfo
- HomeAddress
- FavoriteFeature
- Features
- Friends
- BestFriend
- Trips
type: string
- name: $expand
in: query
description: Expand related entities
schema:
uniqueItems: true
type: array
items:
enum:
- '*'
- Friends
- BestFriend
- Trips
type: string
responses:
'200':
description: Retrieved entities
content:
application/json:
schema:
title: Collection of Person
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/Microsoft.OData.Service.Sample.TrippinInMemory.Models.Person'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
post:
tags:
- People.Person
summary: Add new entity to People
operationId: People.Person.CreatePerson
requestBody:
description: New entity
content:
application/json:
schema:
$ref: '#/components/schemas/Microsoft.OData.Service.Sample.TrippinInMemory.Models.Person'
required: true
responses:
'201':
description: Created entity
content:
application/json:
schema:
$ref: '#/components/schemas/Microsoft.OData.Service.Sample.TrippinInMemory.Models.Person'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/People({UserName})':
get:
tags:
- People.Person
summary: Get entity from People by key
operationId: People.Person.GetPerson
parameters:
- name: UserName
in: path
description: 'key: UserName'
required: true
schema:
type: string
x-ms-docs-key-type: Person
- name: $select
in: query
description: Select properties to be returned
schema:
uniqueItems: true
type: array
items:
enum:
- UserName
- FirstName
- LastName
- MiddleName
- Gender
- Age
- Emails
- AddressInfo
- HomeAddress
- FavoriteFeature
- Features
- Friends
- BestFriend
- Trips
type: string
- name: $expand
in: query
description: Expand related entities
schema:
uniqueItems: true
type: array
items:
enum:
- '*'
- Friends
- BestFriend
- Trips
type: string
responses:
'200':
description: Retrieved entity
content:
application/json:
schema:
$ref: '#/components/schemas/Microsoft.OData.Service.Sample.TrippinInMemory.Models.Person'
links:
Friends:
operationId: People.Person.GetPerson
parameters:
UserName: $request.path.UserName
BestFriend:
operationId: People.Person.GetPerson
parameters:
UserName: $request.path.UserName
Trips:
operationId: People.Person.GetPerson
parameters:
UserName: $request.path.UserName
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- People.Person
summary: Update entity in People
operationId: People.Person.UpdatePerson
parameters:
- name: UserName
in: path
description: 'key: UserName'
required: true
schema:
type: string
x-ms-docs-key-type: Person
requestBody:
description: New property values
content:
application/json:
schema:
$ref: '#/components/schemas/Microsoft.OData.Service.Sample.TrippinInMemory.Models.Person'
required: true
responses:
'204':
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- People.Person
summary: Delete entity from People
operationId: People.Person.DeletePerson
parameters:
- name: UserName
in: path
description: 'key: UserName'
required: true
schema:
type: string
x-ms-docs-key-type: Person
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/People({UserName})/Microsoft.OData.Service.Sample.TrippinInMemory.Models.GetFavoriteAirline()':
get:
tags:
- People.Functions
summary: Invoke function GetFavoriteAirline
operationId: People.Person.GetFavoriteAirline.1c526eb64c7a82083ebab0f2
parameters:
- name: UserName
in: path
description: 'key: UserName'
required: true
schema:
type: string
x-ms-docs-key-type: Person
responses:
'200':
description: Success
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/Microsoft.OData.Service.Sample.TrippinInMemory.Models.Airline'
nullable: true
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
'/People({UserName})/Microsoft.OData.Service.Sample.TrippinInMemory.Models.GetFriendsTrips(userName={userName})':
get:
tags:
- People.Functions
summary: Invoke function GetFriendsTrips
operationId: People.Person.GetFriendsTrips.9b42e09ab8ef6d73b88be6e9
parameters:
- name: UserName
in: path
description: 'key: UserName'
required: true
schema:
type: string
x-ms-docs-key-type: Person
- name: userName
in: path
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
anyOf:
- $ref: '#/components/schemas/Microsoft.OData.Service.Sample.TrippinInMemory.Models.Trip'
nullable: true
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
'/People({UserName})/Microsoft.OData.Service.Sample.TrippinInMemory.Models.UpdatePersonLastName(lastName={lastName})':
get:
tags:
- People.Functions
summary: Invoke function UpdatePersonLastName
operationId: People.Person.UpdatePersonLastName.e4ea38792d2cfa3aa5bab91b
parameters:
- name: UserName
in: path
description: 'key: UserName'
required: true
schema:
type: string
x-ms-docs-key-type: Person
- name: lastName
in: path
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: boolean
default: false
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
'/People({UserName})/Microsoft.OData.Service.Sample.TrippinInMemory.Models.ShareTrip':
post:
tags:
- People.Actions
summary: Invoke action ShareTrip
operationId: People.Person.ShareTrip
parameters:
- name: UserName
in: path
description: 'key: UserName'
required: true
schema:
type: string
x-ms-docs-key-type: Person
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
userName:
type: string
tripId:
maximum: 2147483647
minimum: -2147483648
type: integer
format: int32
required: true
responses:
'204':
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
/Airlines:
get:
tags:
- Airlines.Airline
summary: Get entities from Airlines
operationId: Airlines.Airline.ListAirline
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
schema:
uniqueItems: true
type: array
items:
enum:
- AirlineCode
- AirlineCode desc
- Name
- Name desc
type: string
- name: $select
in: query
description: Select properties to be returned
schema:
uniqueItems: true
type: array
items:
enum:
- AirlineCode
- Name
type: string
- name: $expand
in: query
description: Expand related entities
schema:
uniqueItems: true
type: array
items:
enum:
- '*'
type: string
responses:
'200':
description: Retrieved entities
content:
application/json:
schema:
title: Collection of Airline
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/Microsoft.OData.Service.Sample.TrippinInMemory.Models.Airline'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
post:
tags:
- Airlines.Airline
summary: Add new entity to Airlines
operationId: Airlines.Airline.CreateAirline
requestBody:
description: New entity
content:
application/json:
schema:
$ref: '#/components/schemas/Microsoft.OData.Service.Sample.TrippinInMemory.Models.Airline'
required: true
responses:
'201':
description: Created entity
content:
application/json:
schema:
$ref: '#/components/schemas/Microsoft.OData.Service.Sample.TrippinInMemory.Models.Airline'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/Airlines({AirlineCode})':
get:
tags:
- Airlines.Airline
summary: Get entity from Airlines by key
operationId: Airlines.Airline.GetAirline
parameters:
- name: AirlineCode
in: path
description: 'key: AirlineCode'
required: true
schema:
type: string
x-ms-docs-key-type: Airline
- name: $select
in: query
description: Select properties to be returned
schema:
uniqueItems: true
type: array
items:
enum:
- AirlineCode
- Name
type: string
- name: $expand
in: query
description: Expand related entities
schema:
uniqueItems: true
type: array
items:
enum:
- '*'
type: string
responses:
'200':
description: Retrieved entity
content:
application/json:
schema:
$ref: '#/components/schemas/Microsoft.OData.Service.Sample.TrippinInMemory.Models.Airline'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- Airlines.Airline
summary: Update entity in Airlines
operationId: Airlines.Airline.UpdateAirline
parameters:
- name: AirlineCode
in: path
description: 'key: AirlineCode'
required: true
schema:
type: string
x-ms-docs-key-type: Airline
requestBody:
description: New property values
content:
application/json:
schema:
$ref: '#/components/schemas/Microsoft.OData.Service.Sample.TrippinInMemory.Models.Airline'
required: true
responses:
'204':
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- Airlines.Airline
summary: Delete entity from Airlines
operationId: Airlines.Airline.DeleteAirline
parameters:
- name: AirlineCode
in: path
description: 'key: AirlineCode'
required: true
schema:
type: string
x-ms-docs-key-type: Airline
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/Airports:
get:
tags:
- Airports.Airport
summary: Get entities from Airports
operationId: Airports.Airport.ListAirport
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
schema:
uniqueItems: true
type: array
items:
enum:
- Name
- Name desc
- IcaoCode
- IcaoCode desc
- IataCode
- IataCode desc
- Location
- Location desc
type: string
- name: $select
in: query
description: Select properties to be returned
schema:
uniqueItems: true
type: array
items:
enum:
- Name
- IcaoCode
- IataCode
- Location
type: string
- name: $expand
in: query
description: Expand related entities
schema:
uniqueItems: true
type: array
items:
enum:
- '*'
type: string
responses:
'200':
description: Retrieved entities
content:
application/json:
schema:
title: Collection of Airport
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/Microsoft.OData.Service.Sample.TrippinInMemory.Models.Airport'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
post:
tags:
- Airports.Airport
summary: Add new entity to Airports
operationId: Airports.Airport.CreateAirport
requestBody:
description: New entity
content:
application/json:
schema:
$ref: '#/components/schemas/Microsoft.OData.Service.Sample.TrippinInMemory.Models.Airport'
required: true
responses:
'201':
description: Created entity
content:
application/json:
schema:
$ref: '#/components/schemas/Microsoft.OData.Service.Sample.TrippinInMemory.Models.Airport'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/Airports({IcaoCode})':
get:
tags:
- Airports.Airport
summary: Get entity from Airports by key
operationId: Airports.Airport.GetAirport
parameters:
- name: IcaoCode
in: path
description: 'key: IcaoCode'
required: true
schema:
type: string
x-ms-docs-key-type: Airport
- name: $select
in: query
description: Select properties to be returned
schema:
uniqueItems: true
type: array
items:
enum:
- Name
- IcaoCode
- IataCode
- Location
type: string
- name: $expand
in: query
description: Expand related entities
schema:
uniqueItems: true
type: array
items:
enum:
- '*'
type: string
responses:
'200':
description: Retrieved entity
content:
application/json:
schema:
$ref: '#/components/schemas/Microsoft.OData.Service.Sample.TrippinInMemory.Models.Airport'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- Airports.Airport
summary: Update entity in Airports
operationId: Airports.Airport.UpdateAirport
parameters:
- name: IcaoCode
in: path
description: 'key: IcaoCode'
required: true
schema:
type: string
x-ms-docs-key-type: Airport
requestBody:
description: New property values
content:
application/json:
schema:
$ref: '#/components/schemas/Microsoft.OData.Service.Sample.TrippinInMemory.Models.Airport'
required: true
responses:
'204':
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- Airports.Airport
summary: Delete entity from Airports
operationId: Airports.Airport.DeleteAirport
parameters:
- name: IcaoCode
in: path
description: 'key: IcaoCode'
required: true
schema:
type: string
x-ms-docs-key-type: Airport
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/NewComePeople:
get:
tags:
- NewComePeople.Person
summary: Get entities from NewComePeople
operationId: NewComePeople.Person.ListPerson
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
schema:
uniqueItems: true
type: array
items:
enum:
- UserName
- UserName desc
- FirstName
- FirstName desc
- LastName
- LastName desc
- MiddleName
- MiddleName desc
- Gender
- Gender desc
- Age
- Age desc
- Emails
- Emails desc
- AddressInfo
- AddressInfo desc
- HomeAddress
- HomeAddress desc
- FavoriteFeature
- FavoriteFeature desc
- Features
- Features desc
type: string
- name: $select
in: query
description: Select properties to be returned
schema:
uniqueItems: true
type: array
items:
enum:
- UserName
- FirstName
- LastName
- MiddleName
- Gender
- Age
- Emails
- AddressInfo
- HomeAddress
- FavoriteFeature
- Features
- Friends
- BestFriend
- Trips
type: string
- name: $expand
in: query
description: Expand related entities
schema:
uniqueItems: true
type: array
items:
enum:
- '*'
- Friends
- BestFriend
- Trips
type: string
responses:
'200':
description: Retrieved entities
content:
application/json:
schema:
title: Collection of Person
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/Microsoft.OData.Service.Sample.TrippinInMemory.Models.Person'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
post:
tags:
- NewComePeople.Person
summary: Add new entity to NewComePeople
operationId: NewComePeople.Person.CreatePerson
requestBody:
description: New entity
content:
application/json:
schema:
$ref: '#/components/schemas/Microsoft.OData.Service.Sample.TrippinInMemory.Models.Person'
required: true
responses:
'201':
description: Created entity
content:
application/json:
schema:
$ref: '#/components/schemas/Microsoft.OData.Service.Sample.TrippinInMemory.Models.Person'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/NewComePeople({UserName})':
get:
tags:
- NewComePeople.Person
summary: Get entity from NewComePeople by key
operationId: NewComePeople.Person.GetPerson
parameters:
- name: UserName
in: path
description: 'key: UserName'
required: true
schema:
type: string
x-ms-docs-key-type: Person
- name: $select
in: query
description: Select properties to be returned
schema:
uniqueItems: true
type: array
items:
enum:
- UserName
- FirstName
- LastName
- MiddleName
- Gender
- Age
- Emails
- AddressInfo
- HomeAddress
- FavoriteFeature
- Features
- Friends
- BestFriend
- Trips
type: string
- name: $expand
in: query
description: Expand related entities
schema:
uniqueItems: true
type: array
items:
enum:
- '*'
- Friends
- BestFriend
- Trips
type: string
responses:
'200':
description: Retrieved entity
content:
application/json:
schema:
$ref: '#/components/schemas/Microsoft.OData.Service.Sample.TrippinInMemory.Models.Person'
links:
Friends:
operationId: NewComePeople.Person.GetPerson
parameters:
UserName: $request.path.UserName
BestFriend:
operationId: NewComePeople.Person.GetPerson
parameters:
UserName: $request.path.UserName
Trips:
operationId: NewComePeople.Person.GetPerson
parameters:
UserName: $request.path.UserName
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- NewComePeople.Person
summary: Update entity in NewComePeople
operationId: NewComePeople.Person.UpdatePerson
parameters:
- name: UserName
in: path
description: 'key: UserName'
required: true
schema:
type: string
x-ms-docs-key-type: Person
requestBody:
description: New property values
content:
application/json:
schema:
$ref: '#/components/schemas/Microsoft.OData.Service.Sample.TrippinInMemory.Models.Person'
required: true
responses:
'204':
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- NewComePeople.Person
summary: Delete entity from NewComePeople
operationId: NewComePeople.Person.DeletePerson
parameters:
- name: UserName
in: path
description: 'key: UserName'
required: true
schema:
type: string
x-ms-docs-key-type: Person
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/NewComePeople({UserName})/Microsoft.OData.Service.Sample.TrippinInMemory.Models.GetFavoriteAirline()':
get:
tags:
- NewComePeople.Functions
summary: Invoke function GetFavoriteAirline
operationId: NewComePeople.Person.GetFavoriteAirline.1c526eb64c7a82083ebab0f2
parameters:
- name: UserName
in: path
description: 'key: UserName'
required: true
schema:
type: string
x-ms-docs-key-type: Person
responses:
'200':
description: Success
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/Microsoft.OData.Service.Sample.TrippinInMemory.Models.Airline'
nullable: true
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
'/NewComePeople({UserName})/Microsoft.OData.Service.Sample.TrippinInMemory.Models.GetFriendsTrips(userName={userName})':
get:
tags:
- NewComePeople.Functions
summary: Invoke function GetFriendsTrips
operationId: NewComePeople.Person.GetFriendsTrips.9b42e09ab8ef6d73b88be6e9
parameters:
- name: UserName
in: path
description: 'key: UserName'
required: true
schema:
type: string
x-ms-docs-key-type: Person
- name: userName
in: path
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
anyOf:
- $ref: '#/components/schemas/Microsoft.OData.Service.Sample.TrippinInMemory.Models.Trip'
nullable: true
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
'/NewComePeople({UserName})/Microsoft.OData.Service.Sample.TrippinInMemory.Models.UpdatePersonLastName(lastName={lastName})':
get:
tags:
- NewComePeople.Functions
summary: Invoke function UpdatePersonLastName
operationId: NewComePeople.Person.UpdatePersonLastName.e4ea38792d2cfa3aa5bab91b
parameters:
- name: UserName
in: path
description: 'key: UserName'
required: true
schema:
type: string
x-ms-docs-key-type: Person
- name: lastName
in: path
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: boolean
default: false
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
'/NewComePeople({UserName})/Microsoft.OData.Service.Sample.TrippinInMemory.Models.ShareTrip':
post:
tags:
- NewComePeople.Actions
summary: Invoke action ShareTrip
operationId: NewComePeople.Person.ShareTrip
parameters:
- name: UserName
in: path
description: 'key: UserName'
required: true
schema:
type: string
x-ms-docs-key-type: Person
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
userName:
type: string
tripId:
maximum: 2147483647
minimum: -2147483648
type: integer
format: int32
required: true
responses:
'204':
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
/Me:
get:
tags:
- Me.Person
summary: Get Me
operationId: Me.Person.GetPerson
parameters:
- name: $select
in: query
description: Select properties to be returned
schema:
uniqueItems: true
type: array
items:
enum:
- UserName
- FirstName
- LastName
- MiddleName
- Gender
- Age
- Emails
- AddressInfo
- HomeAddress
- FavoriteFeature
- Features
- Friends
- BestFriend
- Trips
type: string
- name: $expand
in: query
description: Expand related entities
schema:
uniqueItems: true
type: array
items:
enum:
- '*'
- Friends
- BestFriend
- Trips
type: string
responses:
'200':
description: Retrieved entity
content:
application/json:
schema:
$ref: '#/components/schemas/Microsoft.OData.Service.Sample.TrippinInMemory.Models.Person'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- Me.Person
summary: Update Me
operationId: Me.Person.UpdatePerson
requestBody:
description: New property values
content:
application/json:
schema:
$ref: '#/components/schemas/Microsoft.OData.Service.Sample.TrippinInMemory.Models.Person'
required: true
responses:
'204':
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/Me/Microsoft.OData.Service.Sample.TrippinInMemory.Models.GetFavoriteAirline():
get:
tags:
- Me.Functions
summary: Invoke function GetFavoriteAirline
operationId: Me.Person.GetFavoriteAirline.1c526eb64c7a82083ebab0f2
responses:
'200':
description: Success
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/Microsoft.OData.Service.Sample.TrippinInMemory.Models.Airline'
nullable: true
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
'/Me/Microsoft.OData.Service.Sample.TrippinInMemory.Models.GetFriendsTrips(userName={userName})':
get:
tags:
- Me.Functions
summary: Invoke function GetFriendsTrips
operationId: Me.Person.GetFriendsTrips.9b42e09ab8ef6d73b88be6e9
parameters:
- name: userName
in: path
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
anyOf:
- $ref: '#/components/schemas/Microsoft.OData.Service.Sample.TrippinInMemory.Models.Trip'
nullable: true
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
'/Me/Microsoft.OData.Service.Sample.TrippinInMemory.Models.UpdatePersonLastName(lastName={lastName})':
get:
tags:
- Me.Functions
summary: Invoke function UpdatePersonLastName
operationId: Me.Person.UpdatePersonLastName.e4ea38792d2cfa3aa5bab91b
parameters:
- name: lastName
in: path
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: boolean
default: false
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
/Me/Microsoft.OData.Service.Sample.TrippinInMemory.Models.ShareTrip:
post:
tags:
- Me.Actions
summary: Invoke action ShareTrip
operationId: Me.Person.ShareTrip
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
userName:
type: string
tripId:
maximum: 2147483647
minimum: -2147483648
type: integer
format: int32
required: true
responses:
'204':
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
/GetPersonWithMostFriends():
get:
tags:
- People
summary: Invoke functionImport GetPersonWithMostFriends
operationId: OperationImport.GetPersonWithMostFriends.de8b4a5ab51ba6c8c254fe80
responses:
'200':
description: Success
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/Microsoft.OData.Service.Sample.TrippinInMemory.Models.Person'
nullable: true
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: functionImport
'/GetNearestAirport(lat={lat},lon={lon})':
get:
tags:
- Airports
summary: Invoke functionImport GetNearestAirport
operationId: OperationImport.GetNearestAirport.6896b1324a4eff76ad9867a0
parameters:
- name: lat
in: path
required: true
schema:
anyOf:
- type: number
- type: string
- enum:
- '-INF'
- INF
- NaN
format: double
- name: lon
in: path
required: true
schema:
anyOf:
- type: number
- type: string
- enum:
- '-INF'
- INF
- NaN
format: double
responses:
'200':
description: Success
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/Microsoft.OData.Service.Sample.TrippinInMemory.Models.Airport'
nullable: true
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: functionImport
/ResetDataSource:
post:
tags:
- ResetDataSource
summary: Invoke actionImport ResetDataSource
operationId: OperationImport.ResetDataSource
responses:
'204':
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: actionImport
components:
schemas:
Microsoft.OData.Service.Sample.TrippinInMemory.Models.Person:
title: Person
type: object
properties:
UserName:
type: string
FirstName:
type: string
LastName:
type: string
nullable: true
MiddleName:
type: string
nullable: true
Gender:
anyOf:
- $ref: '#/components/schemas/Microsoft.OData.Service.Sample.TrippinInMemory.Models.PersonGender'
Age:
type: integer
format: int64
nullable: true
Emails:
type: array
items:
type: string
nullable: true
AddressInfo:
type: array
items:
anyOf:
- $ref: '#/components/schemas/Microsoft.OData.Service.Sample.TrippinInMemory.Models.Location'
nullable: true
HomeAddress:
anyOf:
- $ref: '#/components/schemas/Microsoft.OData.Service.Sample.TrippinInMemory.Models.Location'
nullable: true
FavoriteFeature:
anyOf:
- $ref: '#/components/schemas/Microsoft.OData.Service.Sample.TrippinInMemory.Models.Feature'
Features:
type: array
items:
anyOf:
- $ref: '#/components/schemas/Microsoft.OData.Service.Sample.TrippinInMemory.Models.Feature'
Friends:
type: array
items:
$ref: '#/components/schemas/Microsoft.OData.Service.Sample.TrippinInMemory.Models.Person'
BestFriend:
anyOf:
- $ref: '#/components/schemas/Microsoft.OData.Service.Sample.TrippinInMemory.Models.Person'
nullable: true
Trips:
type: array
items:
$ref: '#/components/schemas/Microsoft.OData.Service.Sample.TrippinInMemory.Models.Trip'
example:
UserName: String (identifier)
FirstName: String
LastName: String
MiddleName: String
Gender:
'@odata.type': Microsoft.OData.Service.Sample.TrippinInMemory.Models.PersonGender
Age: Int64
Emails:
- String
AddressInfo:
- '@odata.type': Microsoft.OData.Service.Sample.TrippinInMemory.Models.Location
HomeAddress:
'@odata.type': Microsoft.OData.Service.Sample.TrippinInMemory.Models.Location
FavoriteFeature:
'@odata.type': Microsoft.OData.Service.Sample.TrippinInMemory.Models.Feature
Features:
- '@odata.type': Microsoft.OData.Service.Sample.TrippinInMemory.Models.Feature
Friends:
- '@odata.type': Microsoft.OData.Service.Sample.TrippinInMemory.Models.Person
BestFriend:
'@odata.type': Microsoft.OData.Service.Sample.TrippinInMemory.Models.Person
Trips:
- '@odata.type': Microsoft.OData.Service.Sample.TrippinInMemory.Models.Trip
Microsoft.OData.Service.Sample.TrippinInMemory.Models.Airline:
title: Airline
type: object
properties:
AirlineCode:
type: string
Name:
type: string
nullable: true
example:
AirlineCode: String (identifier)
Name: String
Microsoft.OData.Service.Sample.TrippinInMemory.Models.Airport:
title: Airport
type: object
properties:
Name:
type: string
nullable: true
IcaoCode:
type: string
IataCode:
type: string
nullable: true
Location:
anyOf:
- $ref: '#/components/schemas/Microsoft.OData.Service.Sample.TrippinInMemory.Models.AirportLocation'
nullable: true
example:
Name: String
IcaoCode: String (identifier)
IataCode: String
Location:
'@odata.type': Microsoft.OData.Service.Sample.TrippinInMemory.Models.AirportLocation
Microsoft.OData.Service.Sample.TrippinInMemory.Models.Location:
title: Location
type: object
properties:
Address:
type: string
nullable: true
City:
anyOf:
- $ref: '#/components/schemas/Microsoft.OData.Service.Sample.TrippinInMemory.Models.City'
nullable: true
example:
Address: String
City:
'@odata.type': Microsoft.OData.Service.Sample.TrippinInMemory.Models.City
Microsoft.OData.Service.Sample.TrippinInMemory.Models.City:
title: City
type: object
properties:
Name:
type: string
nullable: true
CountryRegion:
type: string
nullable: true
Region:
type: string
nullable: true
example:
Name: String
CountryRegion: String
Region: String
Microsoft.OData.Service.Sample.TrippinInMemory.Models.AirportLocation:
allOf:
- $ref: '#/components/schemas/Microsoft.OData.Service.Sample.TrippinInMemory.Models.Location'
- title: AirportLocation
type: object
properties:
Loc:
$ref: '#/components/schemas/Edm.GeographyPoint'
example:
Address: String
City:
'@odata.type': Microsoft.OData.Service.Sample.TrippinInMemory.Models.City
Loc: GeographyPoint
Microsoft.OData.Service.Sample.TrippinInMemory.Models.EventLocation:
allOf:
- $ref: '#/components/schemas/Microsoft.OData.Service.Sample.TrippinInMemory.Models.Location'
- title: EventLocation
type: object
properties:
BuildingInfo:
type: string
nullable: true
example:
Address: String
City:
'@odata.type': Microsoft.OData.Service.Sample.TrippinInMemory.Models.City
BuildingInfo: String
Microsoft.OData.Service.Sample.TrippinInMemory.Models.Trip:
title: Trip
type: object
properties:
TripId:
maximum: 2147483647
minimum: -2147483648
type: integer
format: int32
ShareId:
pattern: '^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$'
type: string
format: uuid
Name:
type: string
nullable: true
Budget:
anyOf:
- type: number
- type: string
- enum:
- '-INF'
- INF
- NaN
format: float
Description:
type: string
nullable: true
Tags:
type: array
items:
type: string
nullable: true
StartsAt:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
format: date-time
EndsAt:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
format: date-time
PlanItems:
type: array
items:
$ref: '#/components/schemas/Microsoft.OData.Service.Sample.TrippinInMemory.Models.PlanItem'
example:
TripId: Int32 (identifier)
ShareId: Guid
Name: String
Budget: Single
Description: String
Tags:
- String
StartsAt: DateTimeOffset (timestamp)
EndsAt: DateTimeOffset (timestamp)
PlanItems:
- '@odata.type': Microsoft.OData.Service.Sample.TrippinInMemory.Models.PlanItem
Microsoft.OData.Service.Sample.TrippinInMemory.Models.PlanItem:
title: PlanItem
type: object
properties:
PlanItemId:
maximum: 2147483647
minimum: -2147483648
type: integer
format: int32
ConfirmationCode:
type: string
nullable: true
StartsAt:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
format: date-time
EndsAt:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
format: date-time
Duration:
pattern: '^-?P([0-9]+D)?(T([0-9]+H)?([0-9]+M)?([0-9]+([.][0-9]+)?S)?)?$'
type: string
format: duration
example:
PlanItemId: Int32 (identifier)
ConfirmationCode: String
StartsAt: DateTimeOffset (timestamp)
EndsAt: DateTimeOffset (timestamp)
Duration: Duration
Microsoft.OData.Service.Sample.TrippinInMemory.Models.Event:
allOf:
- $ref: '#/components/schemas/Microsoft.OData.Service.Sample.TrippinInMemory.Models.PlanItem'
- title: Event
type: object
properties:
OccursAt:
anyOf:
- $ref: '#/components/schemas/Microsoft.OData.Service.Sample.TrippinInMemory.Models.EventLocation'
nullable: true
Description:
type: string
nullable: true
example:
PlanItemId: Int32 (identifier)
ConfirmationCode: String
StartsAt: DateTimeOffset (timestamp)
EndsAt: DateTimeOffset (timestamp)
Duration: Duration
OccursAt:
'@odata.type': Microsoft.OData.Service.Sample.TrippinInMemory.Models.EventLocation
Description: String
Microsoft.OData.Service.Sample.TrippinInMemory.Models.PublicTransportation:
allOf:
- $ref: '#/components/schemas/Microsoft.OData.Service.Sample.TrippinInMemory.Models.PlanItem'
- title: PublicTransportation
type: object
properties:
SeatNumber:
type: string
nullable: true
example:
PlanItemId: Int32 (identifier)
ConfirmationCode: String
StartsAt: DateTimeOffset (timestamp)
EndsAt: DateTimeOffset (timestamp)
Duration: Duration
SeatNumber: String
Microsoft.OData.Service.Sample.TrippinInMemory.Models.Flight:
allOf:
- $ref: '#/components/schemas/Microsoft.OData.Service.Sample.TrippinInMemory.Models.PublicTransportation'
- title: Flight
type: object
properties:
FlightNumber:
type: string
nullable: true
Airline:
anyOf:
- $ref: '#/components/schemas/Microsoft.OData.Service.Sample.TrippinInMemory.Models.Airline'
nullable: true
From:
anyOf:
- $ref: '#/components/schemas/Microsoft.OData.Service.Sample.TrippinInMemory.Models.Airport'
nullable: true
To:
anyOf:
- $ref: '#/components/schemas/Microsoft.OData.Service.Sample.TrippinInMemory.Models.Airport'
nullable: true
example:
PlanItemId: Int32 (identifier)
ConfirmationCode: String
StartsAt: DateTimeOffset (timestamp)
EndsAt: DateTimeOffset (timestamp)
Duration: Duration
SeatNumber: String
FlightNumber: String
Airline:
'@odata.type': Microsoft.OData.Service.Sample.TrippinInMemory.Models.Airline
From:
'@odata.type': Microsoft.OData.Service.Sample.TrippinInMemory.Models.Airport
To:
'@odata.type': Microsoft.OData.Service.Sample.TrippinInMemory.Models.Airport
Microsoft.OData.Service.Sample.TrippinInMemory.Models.Employee:
allOf:
- $ref: '#/components/schemas/Microsoft.OData.Service.Sample.TrippinInMemory.Models.Person'
- title: Employee
type: object
properties:
Cost:
type: integer
format: int64
Peers:
type: array
items:
$ref: '#/components/schemas/Microsoft.OData.Service.Sample.TrippinInMemory.Models.Person'
example:
UserName: String (identifier)
FirstName: String
LastName: String
MiddleName: String
Gender:
'@odata.type': Microsoft.OData.Service.Sample.TrippinInMemory.Models.PersonGender
Age: Int64
Emails:
- String
AddressInfo:
- '@odata.type': Microsoft.OData.Service.Sample.TrippinInMemory.Models.Location
HomeAddress:
'@odata.type': Microsoft.OData.Service.Sample.TrippinInMemory.Models.Location
FavoriteFeature:
'@odata.type': Microsoft.OData.Service.Sample.TrippinInMemory.Models.Feature
Features:
- '@odata.type': Microsoft.OData.Service.Sample.TrippinInMemory.Models.Feature
Friends:
- '@odata.type': Microsoft.OData.Service.Sample.TrippinInMemory.Models.Person
BestFriend:
'@odata.type': Microsoft.OData.Service.Sample.TrippinInMemory.Models.Person
Trips:
- '@odata.type': Microsoft.OData.Service.Sample.TrippinInMemory.Models.Trip
Cost: Int64
Peers:
- '@odata.type': Microsoft.OData.Service.Sample.TrippinInMemory.Models.Person
Microsoft.OData.Service.Sample.TrippinInMemory.Models.Manager:
allOf:
- $ref: '#/components/schemas/Microsoft.OData.Service.Sample.TrippinInMemory.Models.Person'
- title: Manager
type: object
properties:
Budget:
type: integer
format: int64
BossOffice:
anyOf:
- $ref: '#/components/schemas/Microsoft.OData.Service.Sample.TrippinInMemory.Models.Location'
nullable: true
DirectReports:
type: array
items:
$ref: '#/components/schemas/Microsoft.OData.Service.Sample.TrippinInMemory.Models.Person'
example:
UserName: String (identifier)
FirstName: String
LastName: String
MiddleName: String
Gender:
'@odata.type': Microsoft.OData.Service.Sample.TrippinInMemory.Models.PersonGender
Age: Int64
Emails:
- String
AddressInfo:
- '@odata.type': Microsoft.OData.Service.Sample.TrippinInMemory.Models.Location
HomeAddress:
'@odata.type': Microsoft.OData.Service.Sample.TrippinInMemory.Models.Location
FavoriteFeature:
'@odata.type': Microsoft.OData.Service.Sample.TrippinInMemory.Models.Feature
Features:
- '@odata.type': Microsoft.OData.Service.Sample.TrippinInMemory.Models.Feature
Friends:
- '@odata.type': Microsoft.OData.Service.Sample.TrippinInMemory.Models.Person
BestFriend:
'@odata.type': Microsoft.OData.Service.Sample.TrippinInMemory.Models.Person
Trips:
- '@odata.type': Microsoft.OData.Service.Sample.TrippinInMemory.Models.Trip
Budget: Int64
BossOffice:
'@odata.type': Microsoft.OData.Service.Sample.TrippinInMemory.Models.Location
DirectReports:
- '@odata.type': Microsoft.OData.Service.Sample.TrippinInMemory.Models.Person
Microsoft.OData.Service.Sample.TrippinInMemory.Models.PersonGender:
title: PersonGender
enum:
- Male
- Female
- Unknow
type: string
Microsoft.OData.Service.Sample.TrippinInMemory.Models.Feature:
title: Feature
enum:
- Feature1
- Feature2
- Feature3
- Feature4
type: string
Edm.Geography:
$ref: '#/components/schemas/Edm.Geometry'
Edm.GeographyPoint:
$ref: '#/components/schemas/Edm.GeometryPoint'
Edm.GeographyLineString:
$ref: '#/components/schemas/Edm.GeometryLineString'
Edm.GeographyPolygon:
$ref: '#/components/schemas/Edm.GeometryPolygon'
Edm.GeographyMultiPoint:
$ref: '#/components/schemas/Edm.GeometryMultiPoint'
Edm.GeographyMultiLineString:
$ref: '#/components/schemas/Edm.GeometryMultiLineString'
Edm.GeographyMultiPolygon:
$ref: '#/components/schemas/Edm.GeometryMultiPolygon'
Edm.GeographyCollection:
$ref: '#/components/schemas/Edm.GeometryCollection'
Edm.Geometry:
type: object
anyOf:
- $ref: '#/components/schemas/Edm.GeometryPoint'
- $ref: '#/components/schemas/Edm.GeometryLineString'
- $ref: '#/components/schemas/Edm.GeometryPolygon'
- $ref: '#/components/schemas/Edm.GeometryMultiPoint'
- $ref: '#/components/schemas/Edm.GeometryMultiLineString'
- $ref: '#/components/schemas/Edm.GeometryMultiPolygon'
- $ref: '#/components/schemas/Edm.GeometryCollection'
Edm.GeometryPoint:
required:
- type
- coordinates
type: object
properties:
type:
enum:
- Point
type: string
default: Point
coordinates:
$ref: '#/components/schemas/GeoJSON.position'
Edm.GeometryLineString:
required:
- type
- coordinates
type: object
properties:
type:
enum:
- LineString
coordinates:
minItems: 2
type: array
items:
$ref: '#/components/schemas/GeoJSON.position'
Edm.GeometryPolygon:
required:
- type
- coordinates
type: object
properties:
type:
enum:
- Polygon
coordinates:
minItems: 4
type: array
items:
type: array
items:
$ref: '#/components/schemas/GeoJSON.position'
Edm.GeometryMultiPoint:
required:
- type
- coordinates
type: object
properties:
type:
enum:
- MultiPoint
coordinates:
type: array
items:
$ref: '#/components/schemas/GeoJSON.position'
Edm.GeometryMultiLineString:
required:
- type
- coordinates
type: object
properties:
type:
enum:
- MultiLineString
coordinates:
minItems: 2
type: array
items:
type: array
items:
$ref: '#/components/schemas/GeoJSON.position'
Edm.GeometryMultiPolygon:
required:
- type
- coordinates
type: object
properties:
type:
enum:
- MultiPolygon
coordinates:
minItems: 4
type: array
items:
type: array
items:
type: array
items:
$ref: '#/components/schemas/GeoJSON.position'
Edm.GeometryCollection:
required:
- type
- coordinates
type: object
properties:
type:
enum:
- GeometryCollection
coordinates:
type: array
items:
$ref: '#/components/schemas/Edm.Geometry'
GeoJSON.position:
minItems: 2
type: array
items:
type: number
odata.error:
required:
- error
type: object
properties:
error:
$ref: '#/components/schemas/odata.error.main'
odata.error.main:
required:
- code
- message
type: object
properties:
code:
type: string
message:
type: string
target:
type: string
details:
type: array
items:
$ref: '#/components/schemas/odata.error.detail'
innererror:
type: object
description: The structure of this object is service-specific
odata.error.detail:
required:
- code
- message
type: object
properties:
code:
type: string
message:
type: string
target:
type: string
responses:
error:
description: error
content:
application/json:
schema:
$ref: '#/components/schemas/odata.error'
parameters:
top:
name: $top
in: query
description: Show only the first n items
schema:
minimum: 0
type: integer
example: 50
skip:
name: $skip
in: query
description: Skip the first n items
schema:
minimum: 0
type: integer
count:
name: $count
in: query
description: Include count of items
schema:
type: boolean
filter:
name: $filter
in: query
description: Filter items by property values
schema:
type: string
search:
name: $search
in: query
description: Search items by search phrases
schema:
type: string
tags:
- name: People.Person
x-ms-docs-toc-type: page
- name: People.Functions
x-ms-docs-toc-type: container
- name: People.Actions
x-ms-docs-toc-type: container
- name: Airlines.Airline
x-ms-docs-toc-type: page
- name: Airports.Airport
x-ms-docs-toc-type: page
- name: NewComePeople.Person
x-ms-docs-toc-type: page
- name: NewComePeople.Functions
x-ms-docs-toc-type: container
- name: NewComePeople.Actions
x-ms-docs-toc-type: container
- name: Me.Person
x-ms-docs-toc-type: page
- name: Me.Functions
x-ms-docs-toc-type: container
- name: Me.Actions
x-ms-docs-toc-type: container
- name: People
x-ms-docs-toc-type: container
- name: Airports
x-ms-docs-toc-type: container
- name: ResetDataSource
x-ms-docs-toc-type: container