Basic.OpenApi.V2.yaml

swagger: '2.0'
info:
  title: OData Service for namespace DefaultNs
  description: This OData service is located at http://localhost
  version: 1.0.0
host: localhost
schemes:
  - http
paths:
  /City:
    get:
      tags:
        - City.City
      summary: Get entities from City
      operationId: City.City.ListCity
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/top'
        - $ref: '#/parameters/skip'
        - $ref: '#/parameters/search'
        - $ref: '#/parameters/filter'
        - $ref: '#/parameters/count'
        - in: query
          name: $orderby
          description: Order items by property values
          type: array
          items:
            type: string
            enum:
              - Name
              - Name desc
        - in: query
          name: $select
          description: Select properties to be returned
          type: array
          items:
            type: string
            enum:
              - Name
        - in: query
          name: $expand
          description: Expand related entities
          type: array
          items:
            type: string
            enum:
              - '*'
      responses:
        '200':
          $ref: '#/responses/DefaultNs.CityCollectionResponse'
        default:
          $ref: '#/responses/error'
    post:
      tags:
        - City.City
      summary: Add new entity to City
      operationId: City.City.CreateCity
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - in: body
          name: body
          description: New entity
          required: true
          schema:
            $ref: '#/definitions/DefaultNs.City'
      responses:
        '201':
          description: Created entity
          schema:
            $ref: '#/definitions/DefaultNs.City'
        default:
          $ref: '#/responses/error'
      x-ms-docs-operation-type: operation
    x-description: Provides operations to manage the collection of City entities.
  '/City({Name})':
    get:
      tags:
        - City.City
      summary: Get entity from City by key
      operationId: City.City.GetCity
      produces:
        - application/json
      parameters:
        - in: path
          name: Name
          description: The unique identifier of City
          required: true
          type: string
          x-ms-docs-key-type: City
        - in: query
          name: $select
          description: Select properties to be returned
          type: array
          items:
            type: string
            enum:
              - Name
        - in: query
          name: $expand
          description: Expand related entities
          type: array
          items:
            type: string
            enum:
              - '*'
      responses:
        '200':
          description: Retrieved entity
          schema:
            $ref: '#/definitions/DefaultNs.City'
        default:
          $ref: '#/responses/error'
      x-ms-docs-operation-type: operation
    patch:
      tags:
        - City.City
      summary: Update entity in City
      operationId: City.City.UpdateCity
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - in: path
          name: Name
          description: The unique identifier of City
          required: true
          type: string
          x-ms-docs-key-type: City
        - in: body
          name: body
          description: New property values
          schema:
            $ref: '#/definitions/DefaultNs.City'
      responses:
        '204':
          description: Success
        default:
          $ref: '#/responses/error'
      x-ms-docs-operation-type: operation
    delete:
      tags:
        - City.City
      summary: Delete entity from City
      operationId: City.City.DeleteCity
      produces:
        - application/json
      parameters:
        - in: path
          name: Name
          description: The unique identifier of City
          required: true
          type: string
          x-ms-docs-key-type: City
        - in: header
          name: If-Match
          description: ETag
          type: string
      responses:
        '204':
          description: Success
        default:
          $ref: '#/responses/error'
      x-ms-docs-operation-type: operation
    x-description: Provides operations to manage the collection of City entities.
  /City/$count:
    get:
      tags:
        - City.City
      summary: Get the number of the resource
      operationId: City.GetCount-8728
      produces:
        - text/plain
        - application/json
      parameters:
        - $ref: '#/parameters/search'
        - $ref: '#/parameters/filter'
      responses:
        '200':
          $ref: '#/responses/ODataCountResponse'
        default:
          $ref: '#/responses/error'
    x-description: Provides operations to count the resources in the collection.
  /CountryOrRegion:
    get:
      tags:
        - CountryOrRegion.CountryOrRegion
      summary: Get entities from CountryOrRegion
      operationId: CountryOrRegion.CountryOrRegion.ListCountryOrRegion
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/top'
        - $ref: '#/parameters/skip'
        - $ref: '#/parameters/search'
        - $ref: '#/parameters/filter'
        - $ref: '#/parameters/count'
        - in: query
          name: $orderby
          description: Order items by property values
          type: array
          items:
            type: string
            enum:
              - Name
              - Name desc
        - in: query
          name: $select
          description: Select properties to be returned
          type: array
          items:
            type: string
            enum:
              - Name
        - in: query
          name: $expand
          description: Expand related entities
          type: array
          items:
            type: string
            enum:
              - '*'
      responses:
        '200':
          $ref: '#/responses/DefaultNs.CountryOrRegionCollectionResponse'
        default:
          $ref: '#/responses/error'
    post:
      tags:
        - CountryOrRegion.CountryOrRegion
      summary: Add new entity to CountryOrRegion
      operationId: CountryOrRegion.CountryOrRegion.CreateCountryOrRegion
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - in: body
          name: body
          description: New entity
          required: true
          schema:
            $ref: '#/definitions/DefaultNs.CountryOrRegion'
      responses:
        '201':
          description: Created entity
          schema:
            $ref: '#/definitions/DefaultNs.CountryOrRegion'
        default:
          $ref: '#/responses/error'
      x-ms-docs-operation-type: operation
    x-description: Provides operations to manage the collection of CountryOrRegion entities.
  '/CountryOrRegion({Name})':
    get:
      tags:
        - CountryOrRegion.CountryOrRegion
      summary: Get entity from CountryOrRegion by key
      operationId: CountryOrRegion.CountryOrRegion.GetCountryOrRegion
      produces:
        - application/json
      parameters:
        - in: path
          name: Name
          description: The unique identifier of CountryOrRegion
          required: true
          type: string
          x-ms-docs-key-type: CountryOrRegion
        - in: query
          name: $select
          description: Select properties to be returned
          type: array
          items:
            type: string
            enum:
              - Name
        - in: query
          name: $expand
          description: Expand related entities
          type: array
          items:
            type: string
            enum:
              - '*'
      responses:
        '200':
          description: Retrieved entity
          schema:
            $ref: '#/definitions/DefaultNs.CountryOrRegion'
        default:
          $ref: '#/responses/error'
      x-ms-docs-operation-type: operation
    patch:
      tags:
        - CountryOrRegion.CountryOrRegion
      summary: Update entity in CountryOrRegion
      operationId: CountryOrRegion.CountryOrRegion.UpdateCountryOrRegion
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - in: path
          name: Name
          description: The unique identifier of CountryOrRegion
          required: true
          type: string
          x-ms-docs-key-type: CountryOrRegion
        - in: body
          name: body
          description: New property values
          schema:
            $ref: '#/definitions/DefaultNs.CountryOrRegion'
      responses:
        '204':
          description: Success
        default:
          $ref: '#/responses/error'
      x-ms-docs-operation-type: operation
    delete:
      tags:
        - CountryOrRegion.CountryOrRegion
      summary: Delete entity from CountryOrRegion
      operationId: CountryOrRegion.CountryOrRegion.DeleteCountryOrRegion
      produces:
        - application/json
      parameters:
        - in: path
          name: Name
          description: The unique identifier of CountryOrRegion
          required: true
          type: string
          x-ms-docs-key-type: CountryOrRegion
        - in: header
          name: If-Match
          description: ETag
          type: string
      responses:
        '204':
          description: Success
        default:
          $ref: '#/responses/error'
      x-ms-docs-operation-type: operation
    x-description: Provides operations to manage the collection of CountryOrRegion entities.
  /CountryOrRegion/$count:
    get:
      tags:
        - CountryOrRegion.CountryOrRegion
      summary: Get the number of the resource
      operationId: CountryOrRegion.GetCount-daf5
      produces:
        - text/plain
        - application/json
      parameters:
        - $ref: '#/parameters/search'
        - $ref: '#/parameters/filter'
      responses:
        '200':
          $ref: '#/responses/ODataCountResponse'
        default:
          $ref: '#/responses/error'
    x-description: Provides operations to count the resources in the collection.
  /Me:
    get:
      tags:
        - Me.Person
      summary: Get Me
      operationId: Me.Person.GetPerson
      produces:
        - application/json
      parameters:
        - in: query
          name: $select
          description: Select properties to be returned
          type: array
          items:
            type: string
            enum:
              - UserName
              - HomeAddress
              - WorkAddress
              - Addresses
        - in: query
          name: $expand
          description: Expand related entities
          type: array
          items:
            type: string
            enum:
              - '*'
      responses:
        '200':
          description: Retrieved entity
          schema:
            $ref: '#/definitions/DefaultNs.Person'
        default:
          $ref: '#/responses/error'
      x-ms-docs-operation-type: operation
    patch:
      tags:
        - Me.Person
      summary: Update Me
      operationId: Me.Person.UpdatePerson
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - in: body
          name: body
          description: New property values
          required: true
          schema:
            $ref: '#/definitions/DefaultNs.Person'
      responses:
        '204':
          description: Success
        default:
          $ref: '#/responses/error'
      x-ms-docs-operation-type: operation
    x-description: Provides operations to manage the Person singleton.
  /People:
    get:
      tags:
        - People.Person
      summary: Get entities from People
      description: People's description.
      operationId: People.Person.ListPerson
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/top'
        - $ref: '#/parameters/skip'
        - $ref: '#/parameters/search'
        - $ref: '#/parameters/filter'
        - $ref: '#/parameters/count'
        - in: query
          name: $orderby
          description: Order items by property values
          type: array
          items:
            type: string
            enum:
              - UserName
              - UserName desc
              - HomeAddress
              - HomeAddress desc
              - WorkAddress
              - WorkAddress desc
              - Addresses
              - Addresses desc
        - in: query
          name: $select
          description: Select properties to be returned
          type: array
          items:
            type: string
            enum:
              - UserName
              - HomeAddress
              - WorkAddress
              - Addresses
        - in: query
          name: $expand
          description: Expand related entities
          type: array
          items:
            type: string
            enum:
              - '*'
      responses:
        '200':
          $ref: '#/responses/DefaultNs.PersonCollectionResponse'
        default:
          $ref: '#/responses/error'
    post:
      tags:
        - People.Person
      summary: Add new entity to People
      operationId: People.Person.CreatePerson
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - in: body
          name: body
          description: New entity
          required: true
          schema:
            $ref: '#/definitions/DefaultNs.Person'
      responses:
        '201':
          description: Created entity
          schema:
            $ref: '#/definitions/DefaultNs.Person'
        default:
          $ref: '#/responses/error'
      x-ms-docs-operation-type: operation
    x-description: Provides operations to manage the collection of Person entities.
  '/People({UserName})':
    get:
      tags:
        - People.Person
      summary: Get entity from People by key
      operationId: People.Person.GetPerson
      produces:
        - application/json
      parameters:
        - in: path
          name: UserName
          description: The unique identifier of Person
          required: true
          type: string
          x-ms-docs-key-type: Person
        - in: query
          name: $select
          description: Select properties to be returned
          type: array
          items:
            type: string
            enum:
              - UserName
              - HomeAddress
              - WorkAddress
              - Addresses
        - in: query
          name: $expand
          description: Expand related entities
          type: array
          items:
            type: string
            enum:
              - '*'
      responses:
        '200':
          description: Retrieved entity
          schema:
            $ref: '#/definitions/DefaultNs.Person'
        default:
          $ref: '#/responses/error'
      x-ms-docs-operation-type: operation
    patch:
      tags:
        - People.Person
      summary: Update entity in People
      operationId: People.Person.UpdatePerson
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - in: path
          name: UserName
          description: The unique identifier of Person
          required: true
          type: string
          x-ms-docs-key-type: Person
        - in: body
          name: body
          description: New property values
          required: true
          schema:
            $ref: '#/definitions/DefaultNs.Person'
      responses:
        '204':
          description: Success
        default:
          $ref: '#/responses/error'
      x-ms-docs-operation-type: operation
    delete:
      tags:
        - People.Person
      summary: Delete entity from People
      operationId: People.Person.DeletePerson
      produces:
        - application/json
      parameters:
        - in: path
          name: UserName
          description: The unique identifier of Person
          required: true
          type: string
          x-ms-docs-key-type: Person
        - in: header
          name: If-Match
          description: ETag
          type: string
      responses:
        '204':
          description: Success
        default:
          $ref: '#/responses/error'
      x-ms-docs-operation-type: operation
    x-description: Provides operations to manage the collection of Person entities.
  /People/$count:
    get:
      tags:
        - People.Person
      summary: Get the number of the resource
      operationId: People.GetCount-dd8d
      produces:
        - text/plain
        - application/json
      parameters:
        - $ref: '#/parameters/search'
        - $ref: '#/parameters/filter'
      responses:
        '200':
          $ref: '#/responses/ODataCountResponse'
        default:
          $ref: '#/responses/error'
    x-description: Provides operations to count the resources in the collection.
definitions:
  DefaultNs.ODataErrors.ODataError:
    type: object
    required:
      - error
    properties:
      error:
        $ref: '#/definitions/DefaultNs.ODataErrors.MainError'
  DefaultNs.ODataErrors.MainError:
    type: object
    required:
      - code
      - message
    properties:
      code:
        type: string
      message:
        type: string
        x-ms-primary-error-message: true
      target:
        type: string
        x-nullable: true
      details:
        type: array
        items:
          $ref: '#/definitions/DefaultNs.ODataErrors.ErrorDetails'
      innerError:
        $ref: '#/definitions/DefaultNs.ODataErrors.InnerError'
  DefaultNs.ODataErrors.ErrorDetails:
    type: object
    required:
      - code
      - message
    properties:
      code:
        type: string
      message:
        type: string
      target:
        type: string
        x-nullable: true
  DefaultNs.ODataErrors.InnerError:
    type: object
    description: The structure of this object is service-specific
  ODataCountResponse:
    type: number
    format: int64
  ReferenceUpdate:
    type: object
    properties:
      '@odata.id':
        type: string
      '@odata.type':
        type: string
        x-nullable: true
  ReferenceCreate:
    type: object
    properties:
      '@odata.id':
        type: string
    additionalProperties:
      type: object
  ReferenceNumeric:
    type: string
    enum:
      - '-INF'
      - INF
      - NaN
    x-nullable: true
  DefaultNs.Color:
    type: string
    description: Enum type 'Color' description.
    title: Color
    enum:
      - Blue
      - White
  DefaultNs.Person:
    type: object
    title: Person
    properties:
      UserName:
        type: string
      HomeAddress:
        $ref: '#/definitions/DefaultNs.Address'
      WorkAddress:
        $ref: '#/definitions/DefaultNs.Address'
      Addresses:
        type: array
        items:
          $ref: '#/definitions/DefaultNs.Address'
    example:
      UserName: string (identifier)
      HomeAddress:
        '@odata.type': DefaultNs.Address
      WorkAddress:
        '@odata.type': DefaultNs.Address
      Addresses:
        - '@odata.type': DefaultNs.Address
  DefaultNs.City:
    type: object
    title: City
    properties:
      Name:
        type: string
    example:
      Name: string (identifier)
  DefaultNs.CountryOrRegion:
    type: object
    title: CountryOrRegion
    properties:
      Name:
        type: string
    example:
      Name: string (identifier)
  DefaultNs.Address:
    type: object
    title: Address
    properties:
      Id:
        type: number
        format: int32
        maximum: 2147483647
        minimum: -2147483648
      City:
        $ref: '#/definitions/DefaultNs.City'
    example:
      Id: 0
      City:
        '@odata.type': DefaultNs.City
  DefaultNs.WorkAddress:
    allOf:
      - $ref: '#/definitions/DefaultNs.Address'
      - type: object
        title: WorkAddress
        properties:
          CountryOrRegion:
            $ref: '#/definitions/DefaultNs.CountryOrRegion'
    example:
      Id: 0
      City:
        '@odata.type': DefaultNs.City
      CountryOrRegion:
        '@odata.type': DefaultNs.CountryOrRegion
  DefaultNs.PersonCollectionResponse:
    type: object
    title: Collection of Person
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/DefaultNs.Person'
  DefaultNs.CityCollectionResponse:
    type: object
    title: Collection of City
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/DefaultNs.City'
  DefaultNs.CountryOrRegionCollectionResponse:
    type: object
    title: Collection of CountryOrRegion
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/DefaultNs.CountryOrRegion'
  DefaultNs.AddressCollectionResponse:
    type: object
    title: Collection of DefaultNs.Address
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/DefaultNs.Address'
parameters:
  top:
    in: query
    name: $top
    description: Show only the first n items
    type: number
    format: int64
    minimum: 0
  skip:
    in: query
    name: $skip
    description: Skip the first n items
    type: number
    format: int64
    minimum: 0
  count:
    in: query
    name: $count
    description: Include count of items
    type: boolean
  filter:
    in: query
    name: $filter
    description: Filter items by property values
    type: string
  search:
    in: query
    name: $search
    description: Search items by search phrases
    type: string
  refPostBody:
    in: body
    name: body
    description: New navigation property ref value
    required: true
    schema:
      $ref: '#/definitions/ReferenceCreate'
  refPutBody:
    in: body
    name: body
    description: New navigation property ref values
    required: true
    schema:
      $ref: '#/definitions/ReferenceUpdate'
responses:
  error:
    description: error
    schema:
      $ref: '#/definitions/DefaultNs.ODataErrors.ODataError'
  ODataCountResponse:
    description: The count of the resource
    schema:
      $ref: '#/definitions/ODataCountResponse'
  DefaultNs.PersonCollectionResponse:
    description: Retrieved collection
    schema:
      $ref: '#/definitions/DefaultNs.PersonCollectionResponse'
  DefaultNs.CityCollectionResponse:
    description: Retrieved collection
    schema:
      $ref: '#/definitions/DefaultNs.CityCollectionResponse'
  DefaultNs.CountryOrRegionCollectionResponse:
    description: Retrieved collection
    schema:
      $ref: '#/definitions/DefaultNs.CountryOrRegionCollectionResponse'
  DefaultNs.AddressCollectionResponse:
    description: Retrieved collection
    schema:
      $ref: '#/definitions/DefaultNs.AddressCollectionResponse'
tags:
  - name: City.City
    x-ms-docs-toc-type: page
  - name: CountryOrRegion.CountryOrRegion
    x-ms-docs-toc-type: page
  - name: Me.Person
    x-ms-docs-toc-type: page
  - name: People.Person
    x-ms-docs-toc-type: page