diff --git a/docs/swagger.yaml b/docs/swagger.yaml index b0d765be361..488d6bddd46 100644 --- a/docs/swagger.yaml +++ b/docs/swagger.yaml @@ -2,7 +2,7 @@ swagger: '2.0' info: title: Home Assistant description: Home Assistant REST API - version: "1.0.0" + version: "1.0.1" # the domain of the service host: localhost:8123 @@ -12,17 +12,17 @@ schemes: - https securityDefinitions: - api_key: - type: apiKey - description: API password - name: api_password - in: query - - # api_key: + #api_key: # type: apiKey # description: API password - # name: x-ha-access - # in: header + # name: api_password + # in: query + + api_key: + type: apiKey + description: API password + name: x-ha-access + in: header # will be prefixed to all paths basePath: /api @@ -38,6 +38,8 @@ paths: description: Returns message if API is up and running. tags: - Core + security: + - api_key: [] responses: 200: description: API is up and running @@ -53,6 +55,8 @@ paths: description: Returns the current configuration as JSON. tags: - Core + security: + - api_key: [] responses: 200: description: Current configuration @@ -81,6 +85,8 @@ paths: summary: Returns all data needed to bootstrap Home Assistant. tags: - Core + security: + - api_key: [] responses: 200: description: Bootstrap information @@ -96,6 +102,8 @@ paths: description: Returns an array of event objects. Each event object contain event name and listener count. tags: - Events + security: + - api_key: [] responses: 200: description: Events @@ -113,6 +121,8 @@ paths: description: Returns an array of service objects. Each object contains the domain and which services it contains. tags: - Services + security: + - api_key: [] responses: 200: description: Services @@ -130,6 +140,8 @@ paths: description: Returns an array of state changes in the past. Each object contains further detail for the entities. tags: - State + security: + - api_key: [] responses: 200: description: State changes @@ -148,6 +160,8 @@ paths: Returns an array of state objects. Each state has the following attributes: entity_id, state, last_changed and attributes. tags: - State + security: + - api_key: [] responses: 200: description: States @@ -166,6 +180,8 @@ paths: Returns a state object for specified entity_id. tags: - State + security: + - api_key: [] parameters: - name: entity_id in: path @@ -223,6 +239,8 @@ paths: Retrieve all errors logged during the current session of Home Assistant as a plaintext response. tags: - Core + security: + - api_key: [] produces: - text/plain responses: @@ -239,6 +257,8 @@ paths: Returns the data (image) from the specified camera entity_id. tags: - Camera + security: + - api_key: [] produces: - image/jpeg parameters: @@ -262,6 +282,8 @@ paths: Fires an event with event_type tags: - Events + security: + - api_key: [] consumes: - application/json parameters: @@ -286,6 +308,8 @@ paths: Calls a service within a specific domain. Will return when the service has been executed or 10 seconds has past, whichever comes first. tags: - Services + security: + - api_key: [] consumes: - application/json parameters: @@ -317,6 +341,8 @@ paths: Render a Home Assistant template. tags: - Template + security: + - api_key: [] consumes: - application/json produces: @@ -338,6 +364,8 @@ paths: Setup event forwarding to another Home Assistant instance. tags: - Core + security: + - api_key: [] consumes: - application/json parameters: @@ -376,6 +404,8 @@ paths: tags: - Core - Events + security: + - api_key: [] produces: - text/event-stream parameters: @@ -420,8 +450,16 @@ definitions: location_name: type: string unit_system: - type: string - description: The system for measurement units + type: object + properties: + length: + type: string + mass: + type: string + temperature: + type: string + volume: + type: string time_zone: type: string version: