Application Connector CRD desc. update + fixes #1246
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
tomekpapiernik
requested review from
bszwarc,
kazydek and
klaudiagrz
as code owners
added 2 commits
October 12, 2018 10:24
derberg
approved these changes
Oct 12, 2018
lszymik
approved these changes
Oct 12, 2018
lszymik
added
kind/bug
klaudiagrz
reviewed
Oct 12, 2018
| | **spec.services.displayName** | **YES** | Specifies a human-readable name of the Remote Environment service. Parameter provided by the Metadata Service, do not edit. | | ||
| | **spec.services.description** | **NO** | Provides a short, human-readable description of the service offered by the RE. Parameter provided by the Metadata Service, do not edit. | | ||
| | **spec.services.longDescription** | **NO** | Provides a longer, human-readable description of the service offered by the RE. Parameter provided by the Metadata Service, do not edit. | | ||
| | **spec.services.providerDisplayName** | **YES** | Specifies a human-readable name of the Remote Environment service provided. Parameter provided by the Metadata Service, do not edit. | |
There was a problem hiding this comment.
Specifies a human-readable name of the provided/offered Remote Environment service provided.
| | **spec.services.tags** | **NO** | Specifies additional tags used for better documentation of the available APIs. Parameter provided by the Metadata Service, do not edit. | | ||
| | **spec.services.labels** | **NO** | Specifies additional labels for the service offered by the RE. Parameter provided by the Metadata Service, do not edit. | | ||
| | **spec.services.entries** | **YES** | Contains the information about the APIs and Events that the service offered by the RE provides. Parameter provided by the Metadata Service, do not edit. | | ||
| | **spec.services.entries.type** | **YES** | Specify the entry type: API or Event. Parameter provided by the Metadata Service, do not edit. | |
There was a problem hiding this comment.
Specifies whether the entry is of API or Event type. ? -> for sure you should be consistent and use 3rd form of the verb at the beginning
| | **spec.services.entries.accessLabel** | **NO** | Specifies the label used in Istio rules in the Application Connector. This field is required for the API entry type. | | ||
| | **spec.services.entries.targetUrl** | **NO** | Specifies the URL to a given API. This field is required for the API entry type. Parameter provided by the Metadata Service, do not edit. | | ||
| | **spec.services.entries.oauthUrl** | **NO** | Specifies the URL used to authorize with a given API. This field is required for the API entry type. Parameter provided by the Metadata Service, do not edit. | | ||
| | **spec.services.entries.credentialsSecretName** | **NO** | Specifies the name of the Secret which allows you to a call to a given API. This field is required if the **spec.services.entries.oauthUrl** is specified. Parameter provided by the Metadata Service, do not edit. | |
There was a problem hiding this comment.
Specifies the name of the Secret which allows you to a call to a given API. ?
|
@tomekpapiernik Next time please write PR name in imperative mood. All rules regarding commit messages apply there as well. The pull request name is needed for changelog generation and we have to be consistent to make it readable 🙂 |
crabtree
pushed a commit
that referenced
this pull request
Oct 16, 2018
* Application connector documentation fix (cherry picked from commit c82dccb)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Changes proposed in this pull request:
Application Connector CRD desc. update + fixes