Skip to content

Commit

Permalink
Minor changes to App Directory docs
Browse files Browse the repository at this point in the history
  • Loading branch information
RichLinnell committed Mar 15, 2019
1 parent 3c41102 commit c6d8ff8
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 6 deletions.
8 changes: 4 additions & 4 deletions docs/appd-discovery.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ The resulting URI to retrieve application data for "app1" would be "[https://app

### Application identifiers, Shrinking the URI and AppdD defaults

Although the concept of fully qualified application IDs are useful in resolving the actual host of the application directory, there is no requirement for an application directory to use this fully qualified application ID as the resolver for a record. An application ID is unique to given application directory, but there is no requirement to use the fully qualified representation when querying an interface. Taking the prior example, the fully qualified application ID "app1@appd.foo.com" is represented as "app1" within the application directory. As a result a launcher can use a shortened URI construct "<https://appd.foo.com/api/appd/v1/app1>" to resolve the application data vs "https://appd.foo.com/api/appd/app1@appd.foo.com".
Although the concept of fully qualified application IDs are useful in resolving the actual host of the application directory, there is no requirement for an application directory to use this fully qualified application ID as the resolver for a record. An application ID is unique to given application directory, but there is no requirement to use the fully qualified representation when querying an interface. Taking the prior example, the fully qualified application ID "app1@appd.foo.com" is represented as "app1" within the application directory. As a result a launcher can use a shortened URI construct "<https://appd.foo.com/api/appd/v1/app1>" to resolve the application data vs "https://appd.foo.com/api/appd/v1/app1@appd.foo.com".

### DNS/SRV Records

Expand All @@ -121,9 +121,9 @@ More specifically, resolution of an AppD service instance (host location) can be
zone name { _service._proto.name. TTL class SRV priority weight port target.}
```

- *service*: the symbolic name of the desired service. For AppD service, this mus be identified as "**_appd**"
- *proto*: the transport protocol of the desired service; this is usually either [TCP](https://en.wikipedia.org/wiki/Transmission_Control_Protocol) or [UDP](https://en.wikipedia.org/wiki/User_Datagram_Protocol). For AppD service **_tcp** must be used.
- *name*: the domain name for which this record is valid, ending in a dot. For AppD service, the name should directly map to the application identifier domain.
- *service*: the symbolic name of the desired service. For AppD service, this must be identified as "**_appd**"
- *proto*: the transport protocol of the desired service; this is usually either [TCP](https://en.wikipedia.org/wiki/Transmission_Control_Protocol) or [UDP](https://en.wikipedia.org/wiki/User_Datagram_Protocol). For AppD service **_tcp** must be used.
- *name*: the domain name for which this record is valid, ending in a dot. For AppD service, the name should directly map to the application identifier domain.
- *TTL*: standard DNS [time to live](https://en.wikipedia.org/wiki/Time_to_live) field.
- *class*: standard DNS class field (this is always *IN*).
- *priority*: the priority of the target host, lower value means more preferred.
Expand Down
3 changes: 1 addition & 2 deletions docs/appd-use.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,8 +63,7 @@ knowledge of the AppD instance location (FQDN).
## Enhancing controls

The AppD API specification defines the optional use of an access token to
identify the requesting user/launcher and implement authorizations around
AppD actions can be performed. Actions are considered standard CRUD operations.
identify the requesting user/launcher and implement authorizations around which AppD actions can be performed. Actions are considered standard CRUD operations.
Again the specification does not define or make mandatory any authorizations
or roles that a provider or enterprise can define.

Expand Down

0 comments on commit c6d8ff8

Please sign in to comment.