Repository navigation
Say at start-up what the Enterprise data file adds in the IP Intelligence API example - #159
Draft
jwrosewell wants to merge 2 commits into
Draft
jwrosewell wants to merge 2 commits into
jwrosewell wants to merge 2 commits into
Conversation
…le adds The service answers in JSON, so what it writes when it starts is the only place the person running it reads what the Enterprise data file adds and where to find out more. On the Lite file it must give the offer with the contact link, then the Find out more section.
…more The IP Intelligence API example answers in JSON, so on the Lite file a caller saw the three registration properties and nothing about what the Enterprise data file adds. When the service starts it now writes the Enterprise offer with the tagged contact link, when the file in use is a free one, then the Find out more section. The class Javadoc no longer says the Enterprise file is looked for when no argument is given, as the example has used the Lite file since the free file defaults changed.
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
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.
The IP Intelligence API example answers in JSON, so on the free Lite data file a caller saw the three registration properties and was never told what the Enterprise data file adds, where to ask for it, or where to find out more.
What the specification says
ip-intelligence-specification/required-examples.md lines 87 to 91 say an example "asks for Properties only the Enterprise data file holds, such as
Latitude,LongitudeandAreas, says of each one the data file in use cannot give that it needs the Enterprise data file, and once gives a link to the contact page to ask for a copy." device-detection-specification/required-examples.md lines 101 and 102, which IP Intelligence examples follow (line 80), say "Examples MUST also show what only the Enterprise Data File can do".What changed
When the service starts, GettingStartedApi.java now writes the Enterprise offer with the tagged contact link, when the data file in use is a free one, then the Find out more section. What it writes at start-up is the only place the person running a JSON service reads it. The class Javadoc no longer says the Enterprise file is looked for when no argument is given, as the example has used the Lite file since the free file defaults changed.
Tests
Test first, 614f935f, change 1b4c73df.
GettingStartedApiNotesTestbuilds the example's engine on the Lite file and expects the offer with the contact link, then the Find out more section.Red 43673574133 ran the test commit on
rcde74c8c plus a throwaway workflow, Java 17, and the test did not compile, asGettingStartedApi.writeStartupNotesdoes not exist onrc. Green 43673582297 ran the head plus the same workflow, andGettingStartedApiNotesTestpassed 1 of 1 andGettingStartedApiTest4 of 4.Full build
Under way, without macOS under the 9 November decision. This section is replaced with the run, its result and the head it built when it ends.
What it releases
Nothing. The change is in
examples, which the release plan leaves out (ci/README.md).Base branch
rcat de74c8c.