[APIPUB-79] - Copy API Publisher Markdown documentation to docs.ed-fi.org #23
Conversation
This file contains 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
stephenfuqua
changed the title
|
|
||
| | Setting Value | Implementation | Description | | ||
| | -------------------------------- | ---------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ||
| | <nobr>`sqlServer`</nobr> | [Configuration Store for SQL Server](ConfigurationStore/Sql-Server.md) | Reads API connection details from and writes successfully published changed version numbers to a SQL Server configuration table. Enables management of individual connection settings with encryption for securely storing keys and secrets using the built-in support for symmetric key encryption in SQL Server. | |
There was a problem hiding this comment.
In general we want to stay away from using HTML. There is little likelihood of these words being broken across multiple lines, so let's remove the <nobr> HTML tag please.
There was a problem hiding this comment.
The lines break after removing that's why I left it
There was a problem hiding this comment.
The lines look fine in this table after removing <nobr>.
| | `/ed-fi/apiPublisher/connections/_{connectionName}_/includeOnly` | String | (_Optional_) For _source_ API connections, the resources to publish to the target without their dependencies. The value is defined using the same format as with `--include` (see above). <br/><br/> NOTE: Use caution when publishing without automatically including all dependencies. | | ||
| | `/ed-fi/apiPublisher/connections/_{connectionName}_/exclude` | String | (_Optional_) For _source_ API connections, the resources (and their dependents) to NOT publish to the target. The value is defined using the same format as with `--include` (see above). The Ed-Fi API Publisher will also evaluate and automatically exclude all dependent resources of the excluded resources (using the dependency metadata exposed by the target API). This will ensure (barring misconfigured authorization metadata or data policies) that data can be successfully published to the target API. | | ||
| | `/ed-fi/apiPublisher/connections/_{connectionName}_/excludeOnly` | String | (_Optional_) For _source_ API connections, the specific resources to skip publishing to the target (dependent resources will still be published). The value is defined using the same format as with `--include` (see above).<br/><br/> NOTE: Use caution when publishing without automatically including all dependencies. | | ||
| | <nobr>`/ed-fi/apiPublisher/connections/_{connectionName}_/lastChangeVersionsProcessed`</nobr> | String | _(Optional)_ For _source_ API connections, contains a JSON object, keyed by target API name, that indicates the last change version successfully published from the source to the target. This value is automatically created/updated by the Ed-Fi API Publisher after successfully completing the publishing process. | |
There was a problem hiding this comment.
This table ends up scrolling past the visible screen. This content might not be a good fit for a table in this sort of display. Might be better as a bulleted list.
There was a problem hiding this comment.
I reduced the size of the parameters now you can see the 3 columns..
stephenfuqua
approved these changes
Sep 26, 2024
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.
No description provided.